扩展:弹窗

MediaWiki擴充功能手冊

Popups 发布状态： 稳定版
实现	皮肤
描述	在用户悬停在条目链接及腳註標記时显示弹窗
作者	Prateek Saxena (user:Prtksxna), Yair Rand, Sam Smith, Joaquín Oltra Hernández, Bahodir Mansurov, Jon Robson, Piotr Miazga, Jeff Hobson WMDE Engineering
MediaWiki	1.30+
PHP	5.6+
许可协议	GNU通用公眾授權條款2.0或更新版本
下载	下载扩展 Git [?]: 下载Git主线 浏览存储库 (GitHub) 提交历史 repository contributors (GitHub) 代码复核
参数 $wgPopupsVirtualPageViews $wgPopupsOptInDefaultState $wgPopupsRestGatewayEndpoint $wgPopupsHideOptInOnPreferencesPage $wgPopupsPageDisabled $wgPopupsEventLogging $wgPopupsStatsvSamplingRate $wgPopupsReferencePreviewsBetaFeature $wgPopupsConflictingNavPopupsGadgetName $wgPopupsOptInStateForNewAccounts $wgPopupsGateway $wgPopupsReferencePreviews
使用的钩子 BeforePageDisplay GetBetaFeaturePreferences GetPreferences LocalUserCreated MakeGlobalVariablesScript PreferencesFormPreSave ResourceLoaderGetConfigVars UserGetDefaultOptions
翻譯Popups擴充功能如在translatewiki.net可用
检查使用和版本矩阵。
问题	尚未完成的工作 · 回報錯誤

当用户将鼠标悬停在一个页面和分别的引用时，弹窗（Popups）扩展会预览一篇文章的内容，对于引用，还会显示引用的完整内容。

这个扩展原始Design team的开始，因著名的Navigation popups（导航弹窗）而作。当前该功能对所有未登录的维基百科用户启用。参见页面预览以了解扩展运作的描述，以及在此维基媒体项目的更多信息。

引用预览功能最终被加入，并用于实现德语社区的愿望。Reference Previews 有更详细的介绍和更多信息。

依赖

这个扩展对擴充功能:TextExtracts 和扩展:页面图像 具有依赖。 此外还依赖测试功能 （如果您希望开启beta特性参考文献预览）；此外还依赖Extension:EventLogging 和Extension:WikimediaEvents （对于指导）。

安装

• 安装依赖组件。

• 下载文件，并将其放置在您extensions/文件夹中的Popups目录内。
• 将下列代码放置在您的LocalSettings.php的底部：

  wfLoadExtension( 'Popups' );
  

•  完成 – 在您的wiki上导航至Special:Version，以验证扩展已成功安装。

致使用MediaWiki 1.25或更早版本的用户：

上面的说明介绍的是安装此扩展的新方法，它使用wfLoadExtension()。 如果您需要在早期版本（MediaWiki 1.25和更早版本）中安装此扩展，而不是wfLoadExtension( 'Popups' );，您需要使用：

require_once "$IP/extensions/Popups/Popups.php";

对于非测试站点（常规wiki）的最终LocalSettings设置的示例

wfLoadExtensions([
    'TextExtracts',
    'PageImages',
    'Popups'
]);
$wgPopupsHideOptInOnPreferencesPage = true;
$wgPopupsOptInDefaultState = '1';
$wgPopupsReferencePreviewsBetaFeature = false;

Page previews API

Every project is different, and what displays in your previews is highly dependent on the content inside your wiki.

Extension:Popups has been optimised to work with Wikipedia-like content (e.g. wikitext). If your wiki is using a different kind of content handler (for example as is the case for Wikibase) it will need to provide its own API.

The API can be written in any language, but the response of the API must match the spec defined here:

https://www.mediawiki.org/wiki/Specs/Summary/1.2.0

Defining new APIs is out of scope for the Popups extension.

Once defined, you can configure page previews to point to your API using $wgPopupsRestGatewayEndpoint configuration option.

配置选项

选项	默认值	可用于…	文档
$wgPopupsHideOptInOnPreferencesPage	false	sysadmins	是否在参数设置页面隐藏“开启／关闭页面预览”的选项。请注意如果PopupsBetaFeature设置为true，这一选项将会保持隐藏。默认为false
$wgPopupsOptInDefaultState	0	sysadmins	页面预览可见性的默认值。必须是字符串，以便与beta功能设置兼容。
$wgPopupsConflictingNavPopupsGadgetName	Navigation_popups	sysadmins	导航Popups小工具名称
$wgPopupsGateway	mwApiPlain	sysadmins	使用哪个网关来获取popups数据。可用选项：[mwApiPlain|restbasePlain|restbaseHTML]。src/gateway/page.js中提供了完整且始终最新的列表。
$wgPopupsReferencePreviewsBetaFeature	true	sysadmins	参考文献预览应该作为beta功能提供，还是默认情况下为所有用户启用。
$wgPopupsRestGatewayEndpoint	/api/rest_v1/page/summary/	sysadmins	指定摘要来源的REST端点。 Endpoint must meet the spec at Specs/Summary/1.2.0 .
$wgPopupsAnonsExperimentalGroupSize	0	sysadmins	Defines the fraction of users that should be subject to an A/B test. When enabled half of users in this group will see page previews. The rest will be divided into one of two buckets where previews will not show and the control group size will match the enabled bucket. If undefined, or 0, no users will be subject to experimentation and previews will be enabled for everyone unless $wgPopupsBetaFeature is enabled.
$wgPopupsEventLogging	false	sysadmins	Whether we should log events. This should be used carefully alongside PopupsAnonsExperimentalGroupSize. Note if this is enabled without using that variable events will be logged for all users. Be careful!
$wgPopupsSchemaSamplingRate	0	sysadmins	Sampling rate for logging performance data to statsv.
$wgPopupsPageBlacklist	[ "Special:Userlogin", "Special:CreateAccount" ]	sysadmins	Blacklisted pages are subject to the HTML cache policy of the wiki. A purge on a blacklisted page maybe needed to see the effect of this configuration variable. Every blacklisted page should be defined by a canonical name, eg: Special:Userlogin.

页面预览内容

页面预览弹出窗口会显示一张图像（如果有的话）和一小段文字摘要。

图片

图片来源于扩展:页面图像 ，该图片返回与文章相关的单个最合适的缩略图。 它忽略维护模板，小作品，旗帜图标等。

文本

页面预览可以通过配置$wgPopupsRestGatewayEndpoint使用API，该API需要符合页面内容服务摘要端点规范。对于第三方，我们鼓励使用页面内容服务来在您本地的wiki使用Popups。

您也可以使用擴充功能:TextExtracts 扩展。 This extension has various caveats and we do not actively support use of this API.

参考文献预览内容

参考文献预览窗口的内容直接来源于页面自身的参考文献段落。此处并不会使用任何外部服务。如果内容超过弹出窗口大小，则会显示滚动条，以便可以查看所有内容。

参考资料类型

The reference types displayed are set by using specific CSS-classes on the <cite>-tag that can be used to encapsulate the content of a reference e.g. <cite class="journal">. Currently there are four different types supported: web, journal, book, news. Apart from that there is always a generic fallback if neither the cite tag was found nor an appropriate class was used.

Renderers

This extensions currently has only one renderer, that is for ordinary pages.

New renderers for different kind of pages, or things like references can be easily added.

One needs to create a new object with the following methods:

• init
• createPopup
• getOffset
• getClasses
• processPopup

You can see details of these methods in ext.popups.renderer.article.js or this patch that adds a renderer for references.

已知问题

• Users of the Translate extension should note that Page Previews requests previews in the content language of the page. If the preview contains a complete translatable block, then it will be translated. If, however, the preview contains an incomplete translateable block – because a sentence is cut off, say – then it isn't translated and will be displayed in the content language of the page. If you are observing this behavior, then you should consider marking up individual sentences in your lead section.

• T167852 is for a technical audience but has more information on the underlying problem.

• Longer math formulas cutting off in preview - long math or chemical formulas (formulas wider than the preview width) display as truncated in previews. We were not able to add a gradient in order to indicate that the formula is continued on the article itself.

常见问题

Why can't I copy and paste text from a preview?

At time of writing, the cons of doing so outweigh the pros. Essentially it boils down to decreasing the touch area to read the article in full. Once Page Previews is deployed on English and German Wikipedia, feel free to reopen this task and reignite the discussion, but right now we have no plans.

How can I change the image that I see on preview?

See Extension:PageImages#Image choice.

如何从页面预览中移除内容？

Any element marked with the noexcerpt class will be stripped from the summary.

摘要来自哪里？

These are provided by the Summary REST API.

Why are parenthetical stripped?

There's a good discussion going on in T91344 in Phabricator. If you have any views on this or see any problems relating to this, please let us know there.

Why don't I see Popups outside of content namespaces?

Popups appear on links to pages in content namespaces only. This is a limitation of Popups; TextExtracts are available from other namespaces. You may work around this by appending more namespaces into $wgContentNamespaces .

链接

• Page Previews help page and central feedback page on MediaWiki.org

• Reference Previews help page and central feedback page on MediaWiki.org

• Reference Previews main project page on Meta