帮助:横幅

用法

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

1. To use File:Image_name.jpg as a custom banner image, set it on the page:{{PAGEBANNER:Image_name.jpg}}
2. The extension can automatically add the same banner image to all pages of specified namespaces, set via the $wgWPBImage

If the wiki is connected to Wikidata, it can also fetch each page's banner from there.

Required Template

</translate> <translate> Template:PAGEBANNER must exist.</translate> <translate> It can be empty.</translate> <translate> Wikivoyage has an example of a complex Template:PAGEBANNER with rendering logic and additional template dependencies.</translate>

<translate>

Parameters to the <tvar name=1>{{PAGEBANNER}}</tvar> function

The following parameters are supported to the <tvar name=1>{{PAGEBANNER}}</tvar> parser function: </translate>

• pgname — <translate> Adds a custom title to the banner.</translate>
• 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 #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 #origin parameter 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=.

模板:Anchor <translate>

<tvar name=1>'origin'</tvar> parameter

</translate>

Banner coordinate system.

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

<translate> Note, as currently implemented, the origin parameter is meant for images that are much larger than the target banner (e.g. panoramas or portrait photos).</translate> <translate> It will not reposition banners where the repositioning leads to empty whitespace within the banner space.</translate> <translate> 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.</translate>

模板:Anchor <translate>

Configuration variables

</translate> <translate> <tvar name=1>$wgWPBImage</tvar> is used to set the default banner image to be used.</translate> <translate> Add image name without prefixing 'File:' namespace.</translate> <translate> If the wiki does not need default banners, do not edit this field.</translate>

<syntaxhighlight lang="php"> $wgWPBImage = "foo.jpg"; </syntaxhighlight>

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

<syntaxhighlight lang="php"> $wgWPBBannerProperty = "P948"; </syntaxhighlight>

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

<syntaxhighlight lang="php"> $wgWPBEnableDefaultBanner = true; </syntaxhighlight>

<translate> <tvar name=1>$wgWPBNamespaces</tvar> array of namespaces on which to display the banner.</translate> <translate> Default is Main namespace.</translate> <translate> It can also be set to <tvar name=2>模板:Php</tvar>, in which case it'll enable banner on all Namespaces, except those excluded by <tvar name=1>$wgWPBDisabledNamespaces</tvar>.</translate>

<syntaxhighlight lang="php"> $wgWPBNamespaces = [ NS_MAIN ]; </syntaxhighlight>

<translate> <tvar name=1>$wgWPBDisabledNamespaces</tvar> excludes certain namespaces from showing banner.</translate> <translate> Note that this parameter only has effect if <tvar name=1>模板:Phpi</tvar> is <tvar name=2>模板:Phpi</tvar>.</translate> <translate> Otherwise, this parameter is disregarded and only namespaces in <tvar name=1>$wgWPBNamespaces</tvar> are considered.</translate>

<syntaxhighlight lang="php"> $wgWPBDisabledNamespaces = [ NS_FILE ]; </syntaxhighlight>

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

<syntaxhighlight lang="php"> $wgWPBStandardSizes = [ 320, 640, 1280, 2560 ]; </syntaxhighlight>

$wgWPBEnablePageImagesBanners when set to true and 模板:Ll is installed will use a page image when no Wikidata image or locally defined image is set.

<syntaxhighlight lang="php"> $wgWPBEnablePageImagesBanners = true; </syntaxhighlight>

$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).

<syntaxhighlight lang="php"> $wgWPBDisplaySubtitleAfterBannerSkins = [ 'minerva' ]; </syntaxhighlight>

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

<syntaxhighlight lang="php"> $wgWPBEnableHeadingOverride = true; </syntaxhighlight>

$wgWPBEnableMainPage determines whether a banner is allowed to be shown on the 模板:Manual. Defaults to false.

<syntaxhighlight lang="php"> $wgWPBEnableMainPage = false; </syntaxhighlight>

Examples

A few use examples with explanation:

<syntaxhighlight lang="php"> 模板:PAGEBANNER:Grand canyon.jpg </syntaxhighlight>

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

<syntaxhighlight lang="php"> 模板:PAGEBANNER:Grand canyon.jpg </syntaxhighlight>

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.

<syntaxhighlight lang="php"> 模板:PAGEBANNER:Grand canyon.jpg </syntaxhighlight>

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.

<syntaxhighlight lang="php"> 模板:PAGEBANNER:Grand canyon.jpg </syntaxhighlight>

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. Then leave the image name empty, and set any other required parameters:

<syntaxhighlight lang="text"> 模板:PAGEBANNER: </syntaxhighlight>

This will use the banner image as set on the page's Wikidata item. If there is no banner image set for that item, or the page doesn't have a Wikidata item, a default image may be used (if $wgWPBImage is set).

Styling

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

<syntaxhighlight lang="css"> .wpb-topbanner-toc {

   position: relative;

} </syntaxhighlight>

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.

<syntaxhighlight lang="css"> .wpb-topbanner .wpb-name {

   font-size: 1em;

} </syntaxhighlight>

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

<syntaxhighlight lang="css"> .wpb-banner-toc {

   line-height: 1em;

} </syntaxhighlight>

Would reduce the vertical spacing between lines of the ToC.

<syntaxhighlight lang="css"> .wpb-topbanner-toc {

   margin-top: 5px;

} </syntaxhighlight>

Would set some blank space between the banner and ToC.

[[Category:Advertising extensions{{#translation:}}]] [[Category:Notification extensions{{#translation:}}]] [[Category:Wikibase extensions{{#translation:}}]]