Extension:Popups

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 master をダウンロード リポジトリの参照 (GitHub) コミット履歴 コード レビュー
パラメーター $wgPopupsVirtualPageViews $wgPopupsOptInDefaultState $wgPopupsRestGatewayEndpoint $wgPopupsHideOptInOnPreferencesPage $wgPopupsPageBlacklist $wgPopupsEventLogging $wgPopupsStatsvSamplingRate $wgPopupsReferencePreviewsBetaFeature $wgPopupsConflictingNavPopupsGadgetName $wgPopupsOptInStateForNewAccounts $wgPopupsGateway $wgPopupsReferencePreviews
使用するフック BeforePageDisplay GetBetaFeaturePreferences GetPreferences LocalUserCreated MakeGlobalVariablesScript PreferencesFormPreSave ResourceLoaderGetConfigVars UserGetDefaultOptions
translatewiki.net で翻訳を利用できる場合は、Popups 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点	未解決のタスク · バグを報告

Popups拡張機能はページプレビューを表示します - ユーザーがその記事へのリンクにカーソルを合わせると、記事のコンテンツの要約が表示されます。

この拡張機能は、人気のあるナビゲーション・ポップアップガジェットに触発されたデザインチームのイニシアチブです。現在、ログアウトしたユーザーはこの機能をすべてのウィキペディアで利用できます。拡張機能の働き、ウィキメディアプロジェクトでのその使用に関する詳細情報は、ページプレビューで入手できます。

そこへドイツ語話者コミュニティの技術要望リストに採用された参考資料プレビュー機能の開発が追加されました。詳細の説明と情報は参考資料プレビュー をご参照ください。

依存関係

この拡張機能は、Extension:TextExtracts （テキスト抽出）とExtension:PageImages （サムネイル表示）に強く依存しています。ベータ版機能 （ベータ版提供中の参考資料プレビューを有効にする場合）とExtension:EventLogging （訳注：利用ログ＝インタフェース用）とExtension:WikimediaEvents （訳注＝同、ウィキメディア用）との選択的な依存関係もあります。

インストール

• 依存関係をインストールしてください。

• ダウンロードして、ファイルを extensions/ フォルダー内の Popups という名前のディレクトリ内に配置します。

• 以下のコードを LocalSettings.php の末尾に追加します:

  wfLoadExtension( 'Popups' );
  

•  完了 – ウィキの「Special:Version」に移動して、拡張機能が正しくインストールされたことを確認します。

MediaWiki 1.25 以前を稼働させている利用者へ:

上記の手順では、wfLoadExtension() を使用してこの拡張機能をインストールする新しい方法を記載しています。 この拡張機能をこれらの過去のバージョン (MediaWiki 1.25 以前) にインストールする必要がある場合は、wfLoadExtension( 'Popups' ); の代わりに以下を使用する必要があります:

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

非テスト環境 (正規版ウィキ) の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	既定のページプレビューの表示方法。ベータ機能の設定と整合するため、1つに限定
$wgPopupsConflictingNavPopupsGadgetName	Navigation_popups	sysadmins	ナビゲーション・ポップアップのガジェット名
$wgPopupsGateway	mwApiPlain	sysadmins	ポップアップデータを取得するゲートウェイの指定。次の選択肢から選ぶ: [mwApiPlain|restbasePlain|restbaseHTML]。最新版の全リストは src/gateway/page.js を参照
$wgPopupsReferencePreviewsBetaFeature	true	sysadmins	Whether Reference Previews should be available as a Beta feature, or be enabled for all users by default.
$wgPopupsRestGatewayEndpoint	/api/rest_v1/page/summary/	sysadmins	Specify a REST endpoint where summaries should be sourced from. Endpoint must meet the spec at Specs/Summary/1.2.0
$wgPopupsAnonsExperimentalGroupSize	0	sysadmins	A/B テストの被験者とすべき利用者群を特定。有効にすると、対象者の半数にページプレビューを表示します。残り半数（bucket）はプレビューが有効なグループ（bucket）と同数とし、プレビューは表示しません。設定が無効または対象者がゼロの場合は、コントロールしない実験モードとして、$wgPopupsBetaFeatureを有効にした人を除外し、被験者全員にページプレビューを表示します。
$wgPopupsEventLogging	false	sysadmins	イベントのログを取るか取らないか。PopupsAnonsExperimentalGroupSize との連携に注意して設定します。有効にした場合、左記の変数を使わないとユーザー全員のログを取る点に留意してください。あくまでも慎重にお願いします！
$wgPopupsSchemaSamplingRate	0	sysadmins	パフォーマンスデータを statsv に記録するサンプル値
$wgPopupsPageBlacklist	[ "Special:Userlogin", "Special:CreateAccount" ]	sysadmins	ページがブラックリストに掲載されると、HTML キャッシュの方針に抵触します。この環境設定の変数が及ぼす影響を調べるには、ブラックリストからページ名を除去してください。掲載されたページは Special:Userlogin など必ず正規表現の名称にします。

ページプレビューのコンテンツ

ページプレビューのポップアップに (存在する場合) 画像1点とテキストを要約した短文を表示します。

画像

Extension:PageImages経由で表示される画像は、その記事に最もふさわしい画像のサムネイルです。保守テンプレートやスタブ記事、国旗のアイコンなどは対象外です。

テキスト

ページプレビューのポップアップは適合する API からなら設定でき、その適合の条件とは$wgPopupsRestGatewayEndpointを使用するPage content service（PCS）要約エンドポイントで使用できることです。サードパーティの皆さんは、ポップアップをご利用のウィキで使うためにぜひPCSの導入をお奨めします。

またテキスト抽出の拡張機能Extension:TextExtractsも利用できます。ただし注意事項がいろいろあることから、ウィキメディアではこの API はサポート外です。

参考資料プレビューのコンテンツ

The content in the reference preview popups is taken directly from the reference section on the page itself. No external services are involved here. If the content exceeds the popup size scrollbars are shown so everything can be looked at.

参考資料の種別

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.

レンダリングエンジン

この拡張機能には現在、レンダリングエンジンが1件当てられ、対象は通常ページです。

他の種類のページあるいは出典を対象とする個別のレンダリングエンジンの追加は、難しくありません。

新しいオプジェクトを以下の手順で作成する必要があります。

• init
• createPopup
• getOffset
• getClasses
• processPopup

手順の詳細はext.popups.renderer.article.jsもしくは出典にレンダリングエンジンを追加するパッチで確認してください。

既知の問題点

• Translate 拡張機能の利用者の場合、ページプレビューが表示にページのコンテンツ表示言語を呼び出す点にご留意ください。プレビューが完全に処理可能なブロックを含む場合、処理します。ただしブロックが翻訳対象として不完全な場合 – 例えば未完結な文 – 処理されず、ページのコンテンツの言語で表示されます。この挙動を監視するなら、リード文内の文を1つずつマークアップする必要があります。

• T167852 は技術系の閲読者対象ですが、根本的な問題に関する情報は含みません。

• 文字数が長すぎるためにプレビューでは短縮されて表示された数式 - 長い数式もしくは化学式（文字数の上限はプレビューの既定値）はプレビューで短縮して表示されます。勾配を付け、数式が記事中ではもっと長いと示すことはできませんでした。

よくある質問

プレビューから直接テキストをコピペできないのはなぜですか？

この原稿執筆の段階では、不利な点が利点よりも大きいからです。突き詰めると、記事全文を閲読するのに触れる部位を減らすかどうかが、焦点になります。英語版とドイツ語版のウィキペディアでこの拡張機能を実装した段階で、もういちど、このタスクを開いてみてください。あいにく、それまで修正などは計画がありません。

プレビューで表示される画像を変更したいのですが、その方法は?

Extension:PageImages#画像の選択を参照してください。

ページプレビューからコンテンツを削除する方法は?

noexcerpt クラスが付いた要素はすべて要約から削除されます。

これらの要素は何に由来するの？

Summary REST API（JSON エンドポイントの要約）に由来します。

カッコ内の記述が削除された理由は?

議論がファブリケータのチケット T91344で白熱しています。この課題、もしくは関連の問題に関するご意見は、ぜひ先のチケットに投稿してください。

コンテンツ名前空間を離れるとポップアップが表示されない理由は？

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 .

リンク

• ページプレビュー　MediaWiki.orgにある
• help pageとメインのフィードバック受付
• 参考資料プレビュー　MediaWiki.orgにあるhelp pageとフィードバックの受付
• 参考資料プレビュー 　Metaのプロジェクトのメインページ