Расширение:WikidataPageBanner

This page is a translated version of the page Extension:WikidataPageBanner and the translation is 100% complete.
Other languages:
English • ‎русский • ‎中文 • ‎日本語
Справка по расширениям MediaWiki
OOjs UI icon advanced.svg
WikidataPageBanner
Статус релиза: стабильный
Banner ex.png
Реализация Функция парсера
Описание Добавляет широкие баннеры вверху страниц в указанных пространствах имён
Автор(ы) (under the mentorship of User:Jdlrobson and User:Syced). (Sumittalk)
Последняя версия 0.0.3
MediaWiki 1.25+
PHP 5.4+
Лицензия GNU General Public License 2.0 or later
Загрузка
README
  • $wgWPBDisabledNamespaces
  • $wgWPBEnableHeadingOverride
  • $wgWPBSkinBlacklist
  • $wgWPBEnablePageImagesBanners
  • $wgWPBBannerProperty
  • $wgWPBImage
  • $wgWPBDisplaySubtitleAfterBannerSkins
  • $wgWPBNamespaces
  • $wgWPBStandardSizes
  • $wgWPBEnableDefaultBanner
pagebanner
Переведите расширение WikidataPageBanner если оно доступно на translatewiki.net
Проверьте использование и версию.
Проблемы Открытые задачи · Сообщить об ошибке

Расширение WikidataPageBanner добавляет широкие баннеры вверху страниц в указанных пространствах имён вики.

Широкие баннеры используются в проектах Wikivoyage. Это расширение главным образом вдохновлено Шаблоном:Pagebanner в Wikivoyage.

Установка

  • Скачайте и распакуйте файл(ы) в папку с названием WikidataPageBanner в вашей папке extensions/.
  • Добавьте следующие строки в конец файла LocalSettings.php:
    wfLoadExtension( 'WikidataPageBanner' );
    
  •   Готово – Перейдите на страницу Special:Version на своей вики, чтобы удостовериться в том, что расширение успешно установлено.

Использование

Расширение автоматически добавляет изображение баннера на страницы указанных пространств имен. Чтобы использовать собственное изображение баннера, используйте:

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

Если вики связана с викиданными, она также может получать оттуда баннеры.

Обязательный шаблон

Шаблон:PAGEBANNER должен существовать. Он может быть пустым. В Wikivoyage есть пример сложного Template:PAGEBANNER с логикой рендеринга и дополнительными зависимостями шаблона.

Параметры для функции {{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 - нижний левый угол. Смотрите этот график для получения дополнительной информации.

Обратите внимание, что в настоящее время реализован параметр источника, предназначенный для изображений, которые намного больше целевого баннера (например, панорамы или портретные фотографии). Он не будет перемещать баннеры там, где изменение положения приводит к пустому пробелу в пространстве баннера. Например, если баннер отображается с шириной 320px и высотой 180px, изображение, которое также имеет размеры 320px и 180px, не может быть перемещено вообще; изображение шириной 600 пикселей и высотой 180 пикселей можно перемещать по горизонтали, а изображение шириной 320 пикселей и высотой 1000 пикселей можно перемещать по вертикали.

Конфигурационные параметры

Обязательные параметры

$wgWPBImage используется для установки изображения баннера по умолчанию. Добавить название изображения без префикса пространства имён 'Файл:'.

Если вики не нужны баннеры по умолчанию, не редактируйте это поле.
$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.