擴展:維基數據頁面橫幅

此擴充功能由Web團隊所維護。

MediaWiki擴充功能手冊

WikidataPageBanner 發行狀態： 穩定版
實現	解析器函數
描述	在指定名字空間頁面頂部添加全頁橫幅
作者	(under the mentorship of User:Jdlrobson and User:Syced). (Sumit留言)
最新版本	0.0.3
MediaWiki	>= 1.42
PHP	5.4+
Composer	mediawiki/wikidata-page-banner
授權條款	GNU通用公眾授權條款2.0或更新版本
下載	下載擴充功能 Git [?]: 下載Git master 瀏覽存儲庫 (GitHub) 提交歷史 存儲庫貢獻者 (GitHub) 代碼覆核 README
參數 $wgWPBDisabledNamespaces $wgWPBEnableHeadingOverride $wgWPBSkinDisabled $wgWPBBannerProperty $wgWPBEnablePageImagesBanners $wgWPBStandardSizes $wgWPBImage $wgWPBDisplaySubtitleAfterBannerSkins $wgWPBNamespaces $wgWPBEnableMainPage $wgWPBEnableDefaultBanner
標籤 pagebanner
使用的函數鉤 BeforePageDisplay OutputPageParserOutput ParserFirstCallInit ParserOutputPostCacheTransform SiteNoticeAfter
季度下載量	28 (Ranked 106th)
前往translatewiki.net翻譯WikidataPageBanner擴充功能
問題	開啟的任務 · 回報錯誤

WikidataPageBanner擴展將會在指定名字空間裏的每一頁上添加全頁橫幅。 The image filenames can be stored on Wikidata (with page banner (P948)) instead of in the local wiki.

全頁橫幅廣泛用於維基導遊項目。 此擴展主要受維基導遊的Template:pagebanner啟發。

安裝

• 下載檔案，並將解壓後的WikidataPageBanner資料夾移動到extensions/目錄中。
  開發者和代碼貢獻人員應從Git安裝擴展，輸入：cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikidataPageBanner
• 將下列程式碼放置在您的LocalSettings.php 的底部：

  wfLoadExtension( 'WikidataPageBanner' );
  

•  完成 – 在您的wiki上導覽至Special:Version，以驗證已成功安裝擴充功能。

用法

There are a few different ways to set a banner image on a page:

1. 若要使用自定義橫幅圖像，請使用： {{PAGEBANNER:Image_name.jpg}}
2. 該擴展會在指定名字空間頁面上自動添加橫幅圖像。
3. 如果維基已連接到維基數據，則它也可以從那裏獲取橫幅。 In this case, the Template:PAGEBANNER must exist (but it can be empty). English Wikivoyage has an example of a complex Template:Pagebanner with rendering logic and additional template dependencies.

{{PAGEBANNER}}解析器功能支持以下參數：

• |pgname= — 在橫幅里添加自定義標題
• |icon-*= — To add custom icons, add the parameter |icon-<icon_name>=<Article about icon> (where <icon_name> is any icon name that you want). Then define a background-image on .oo-ui-icon-<icon_name>, in MediaWiki:Common.css to use as the icon. Do this for any number 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 section #Styling below.
• |extraClass= — Use |extraClass=<css-class names> (separated by spaces) to add additional classes to banners which can be used to customize it using styles in MediaWiki:Common.css
• |origin= — See section #origin below.
• |link= — Sets the target of the banner link and operates the same as the link parameter for images (e.g. |link=Event name will link to the 'Event name' page rather than the banner image page). Set to no value to remove the link, i.e. |link=.

'origin' 參數

Use this parameter to define a suggested focal area of the image. This is used to crop the banner appropriately on small screens. The value of the parameter should consist of an X and a Y coordinate separated by a comma. Each coordinate represents the distance from the center of the image as a value from -1 to 1. For example, |origin=1,1 is the top right corner and |origin=-1,1 is the bottom right corner. See the image at right for a graphical representation of the coordinates.

Note that |origin= is meant for images that are much larger than the target banner (e.g. panoramas or portrait photos). It will not reposition banners where the repositioning leads to empty whitespace within the banner space. 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 is used to set the default banner image to be used. Add image name without prefixing 'File:' namespace. If the wiki does not need default banners, do not edit this field.

$wgWPBImage = "foo.jpg";

$wgWPBBannerProperty Banner property on Wikidata which holds a commons media file. Essential if Wikidata is enabled.

$wgWPBBannerProperty = "P948";

$wgWPBEnableDefaultBanner enables the default banner image on pages without the use of {{PAGEBANNER}}.

$wgWPBEnableDefaultBanner = true;

$wgWPBNamespaces array of namespaces on which to display the banner. 默認值為主名字空間。 It can also be set to true(), in which case it'll enable banner on all Namespaces, except those excluded by $wgWPBDisabledNamespaces.

$wgWPBNamespaces = [ NS_MAIN ];

$wgWPBDisabledNamespaces excludes certain namespaces from showing banner. Note that this parameter only has effect if $wgWPBNamespaces is true. Otherwise, this parameter is disregarded and only namespaces in $wgWPBNamespaces are considered.

$wgWPBDisabledNamespaces = [ NS_FILE ];

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

$wgWPBStandardSizes = [ 320, 640, 1280, 2560 ];

$wgWPBEnablePageImagesBanners when set to true and 擴充功能:頁面圖片 is installed will use a page image when no Wikidata image or locally defined image is set.

$wgWPBEnablePageImagesBanners = true;

$wgWPBDisplaySubtitleAfterBannerSkins is an array of names of skins that should have the banner displayed in the site-notice area, instead of in the page subtitle (which is the default).

$wgWPBDisplaySubtitleAfterBannerSkins = [ 'minerva' ];

$wgWPBEnableHeadingOverride determines whether the page title is displayed overlayed on the banner image. Defaults to true.

$wgWPBEnableHeadingOverride = true;

$wgWPBEnableMainPage determines whether a banner is allowed to be shown on the Main Page. Defaults to false.

$wgWPBEnableMainPage = false;

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.

Make sure $wgWPBBannerProperty is set to correct Wikidata banner property. Then leave the image name empty, and set any other required parameters:

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

This will use the banner image as set on the page's Wikidata item.

The extension has ample scope for styling the banner via Common.css. Here are some examples of common CSS changes.

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

This sets the ToC to appear just below the banner in case it's long. Note that doing this would cause every banner page on a wiki to have the ToC at the bottom of the banner. However, using bottomtoc=yes as a paramter would only show the ToC at the bottom on the page it's used.

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

Would set the font size of the banner name to 1 em (smaller than the default 2.2 em).

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

Would reduce the vertical spacing between lines of the ToC.

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

Would set some blank space between the banner and ToC.

此擴充功能用於一個或多個維基媒體項目。 這可能意味着擴充功能足夠穩定、運作足夠良好，可以用在這樣的高流量的網站上。 請在維基媒體的CommonSettings.php和InitialiseSettings.php組態檔中查找此擴充功能的名稱以查看哪些網站安裝了該擴充功能。 特定wiki上的已安裝的擴充功能的完整列表位於Special:Version頁面。

此擴充功能在以下wiki農場/託管網站和/或軟件包中提供： Miraheze WikiForge 這不是一份權威名單。 即使某些wiki農場/託管網站和/或軟件包未在這裏列出，它們也可能提供此擴充功能。 請檢查你的wiki農場/託管網站或軟件包以確認提供情況。