Extension:WikidataPageBanner

MediaWiki 拡張機能マニュアル

WikidataPageBanner リリースの状態: 安定
実装	パーサー関数
説明	指定された名前空間のページにバナーを表示させる
作者	(under the mentorship of User:Jdlrobson and User:Syced). (Sumitトーク)
最新バージョン	0.0.3
MediaWiki	1.25+
PHP	5.4+
ライセンス	GNU 一般公衆利用許諾書 2.0 以降
ダウンロード	拡張機能をダウンロード Git [?]: Git master をダウンロード リポジトリを参照 (GitHub) コミット履歴 リポジトリの貢献者 (GitHub) コード レビュー README
パラメーター $wgWPBDisabledNamespaces $wgWPBEnableHeadingOverride $wgWPBSkinDisabled $wgWPBEnablePageImagesBanners $wgWPBBannerProperty $wgWPBImage $wgWPBDisplaySubtitleAfterBannerSkins $wgWPBNamespaces $wgWPBStandardSizes $wgWPBEnableDefaultBanner
タグ pagebanner
使用するフック BeforePageDisplay OutputPageParserOutput ParserFirstCallInit SiteNoticeAfter
translatewiki.net で翻訳を利用できる場合は、WikidataPageBanner 拡張機能の翻訳にご協力ください
使用状況とバージョン マトリクスを確認してください。
問題点	未解決のタスク · バグを報告

WikidataPageBanner拡張機能は指定された名前空間にページバナーを追加します。

Wikivoyageでは広く使われています。 特にWikivoyageのTemplate:pagebannerで多く使用されています。

インストール

• ダウンロードして、ファイルを extensions/ フォルダー内の WikidataPageBanner という名前のディレクトリ内に配置します。
• 以下のコードを LocalSettings.php の末尾に追加します:

  wfLoadExtension( 'WikidataPageBanner' );
  

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

使用法

この拡張機能により、自動で指定されたページにバナーを追加することができます。 バナー画像の指定方法 :

{{PAGEBANNER:imagename.jpg}} with a set of parameters explained below.

Wikidataと接続しているwikiであればWikidataからバナーを取得することもできます。

必須のテンプレート

Template:Pagebannerが必要です。 空になることもあります。 WikivoyageのTemplate:Pagebannerの中にはとても複雑な構造を持つものがあります。

パラメータ

{{PAGEBANNER}}パーサー関数でサポートされているパラメータは以下のとおりです :

• pgname - バナーにカスタムタイトルを挿入します。
• To add custom icons, add the parameter icon-icon_name=<Article about icon> to {{PAGEBANNER}}. Then define a background-image on .oo-ui-icon-icon_name, in MediaWiki:Common.css to use as the icon. Do this for any no. of icons to add to the page.
• tooltip - Use tooltip=image-caption to show image description on hovering over image.
• toc - Use toc=yes to enable a Table Of Contents within banner.
• bottomtoc - Use bottomtoc=yes to push Table Of Contents below banner. This will affect only the page on which its used. To set site-wide toc at bottom, see Styling below.
• extraClass - Use extraClass=name_of_css_classes(separated by space) to add additional classes to banners which can be used to customize it using styles in MediaWiki:Common.css
• origin - (see below)

origin パラメーター

このパラメータによって、画像の焦点エリアを指定できます。 画面が小さい場合にバナー画像を重要な部分のみにトリミングする際に使います。 パラメータはxとyをカンマで区切ったものである必要があります。 各座標は画像の中心からの距離を-1から1までで表しています。 例えば、左上はorigin=1,1で左下はorigin=-1,1です。 詳細はこちらを参照してください。

現在の実装例を見ればわかるように、このパラメータは、通常のバナーよりもはるかに大きい画像（パノラマやポートレート写真など）のためのものであることに留意してください。 バナーを再配置しても、バナースペース内の空白スペースが空になってしまうような時は、バナーの再配置は行われません。 For example, if the banner is being rendered at 320px width and 180px height, an image that is also 320px and 180px cannot be repositioned at all; an image that is 600px width by 180px height can be repositioned horizontally and an image that is 320px width and 1000px height can be repositioned vertically.

設定パラメータ

必須のパラメーター

$wgWPBImageによりバナー画像を指定します。 名前空間名'File:'をつけずに画像名のみを追加してください。

Wikiにデフォルトのバナーが必要なければ使用しないでください。

$wgWPBImage = "foo.jpg";

$wgWPBBannerProperty (Essential if Wikidata is enabled) - Banner property on wikidata which holds commons media file

$wgWPBBannerProperty = "P948";

To see default banners on pages even without the use of {{PAGEBANNER}}, set $wgWPBEnableDefaultBanner to true

$wgWPBEnableDefaultBanner = true;

省略可能なパラメーター

バナーを表示させる名前空間の$wgWPBNamespaces配列。 デフォルトでは標準名前空間になっています。 trueを指定した場合、$wgWPBDisabledNamespacesで除外されたもの以外のすべての名前空間で有効になります。

$wgWPBNamespaces = array( NS_MAIN );

$wgWPBDisabledNamespacesによって指定した名前空間でバナー画像が表示されないように設定できます。

ただしこのパラメータは、$wgWPBNamespacesがtrueの場合のみ有効です。

そうでない場合、このパラメータは無視され、$wgWPBNamespaces内の名前空間だけが考慮されます。

$wgWPBDisabledNamespaces = array( NS_FILE );

$wgWPBStandardSizes is an array of standard predefined screen widths in increasing order of size.

$wgWPBStandardSizes = array( 320, 640, 1280, 2560 );

$wgWPBEnablePageImagesBannerswhen set to true and Extension:PageImages is installed will use a page image when no Wikidata image or locally defined image is set.

$wgWPBEnablePageImagesBanners = true;

Examples

A few use examples with explanation:

{{PAGEBANNER:Grand_canyon.jpg}}

Will add a banner using image Grand_canyon.jpg as source locally or from wikimedia commons.

{{PAGEBANNER:Grand_canyon.jpg|icon-star=<Name of star article>|icon-unesco=<Name of Unesco Article>}}

Will add a banner using image Grand_canyon.jpg as source locally or from wikimedia commons. Additionally will add icons with class names oo-ui-icon-star, oo-ui-icon-unesco. Set background-image property on theses classes in MediaWiki:Common.css to your desired icon.

{{PAGEBANNER:Grand_canyon.jpg|toc=yes|pgname=Some page}}

Will add a banner using image Grand_canyon.jpg as source locally or from Wikimedia Commons. Additionally adds a Table of Contents inside banner. Sets the name displayed on banner as Some page.

{{PAGEBANNER:Grand_canyon.jpg|extraClass=class1 class2}}

This will add a banner using the Grand_canyon.jpg image as source either locally or from Wikimedia Commons. It additionally adds CSS classes class1 and class2 to the .wpb-topbanner div.

Example usage for banner from wikidata

Make sure $wgWPBBannerProperty is set to correct wikidata banner property. Just use

{{PAGEBANNER:|other options...}}

Will add a banner trying to fetch banner image from wikidata property specified above if exists. If it does not exist, tries to add a default banner only if $wgWPBImage is set.

Styling

The extension has ample scope of styling the banner from MediaWiki:Common.css For example, putting the codes given below in MediaWiki:Common.css would result as explained below:

.wpb-topbanner-toc{
    position: relative;
}

This would set the toc to appear just below the banner in case its long. Note that doing this would cause every page on wiki to have toc at bottom. However using bottomtoc=yes as a paramter would only show toc at the bottom on the page its used.

.wpb-topbanner .name{
    font-size: 1em;
}

Would set the font size of Banner Name as 1em.

.wpb-banner-toc{
    line-height: 1.0em;
}

Would reduce the vertcial spacing between lines of Table of contents

.wpb-topbanner-toc{
    margin-top:5px
}

Would set some blank space between banner and toc.