Extension:WikidataPageBanner

Manuel des extensions MediaWiki

WikidataPageBanner État de la version : stable
Implémentation	Fonction d'analyseur
Description	Ajoute de larges images de bannière en haut des pages de wiki.
Auteur(s)	(under the mentorship of User:Jdlrobson and User:Syced). (Sumitdiscussion)
Dernière version	0.0.3
MediaWiki	>= 1.42
PHP	5.4+
Composer	mediawiki/wikidata-page-banner
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (GitHub) historique des validations (commits) contributeurs du dépôt (GitHub) relecture du code README
Paramètres $wgWPBDisabledNamespaces $wgWPBEnableHeadingOverride $wgWPBSkinDisabled $wgWPBBannerProperty $wgWPBEnablePageImagesBanners $wgWPBStandardSizes $wgWPBImage $wgWPBDisplaySubtitleAfterBannerSkins $wgWPBNamespaces $wgWPBEnableMainPage $wgWPBEnableDefaultBanner
Balises pagebanner
Accroches utilisées BeforePageDisplay OutputPageParserOutput ParserFirstCallInit ParserOutputPostCacheTransform SiteNoticeAfter
Téléchargements trimestriels	42 (Ranked 102nd)
Traduire l’extension WikidataPageBanner sur translatewiki.net si elle y est disponible
Problèmes	Tâches ouvertes · Signaler un bogue

L’extension WikidataPageBanner ajoute les images de bannière en haut des pages wiki. Elles peuvent figurer sur toutes les pages des espaces de noms spécifiés, ou simplement sur des pages individuelles. Les noms de fichier des images peuvent être mis dans Wikidata (avec P948) plutôt que de figurer sur le wiki local.

Les bannières sont largement utilisées avec les projets Wikivoyage. Cette extension a été principalement inspirée du modèle pagebanner de Wikivoyage.

Installation

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé WikidataPageBanner dans votre dossier extensions/.
  Les développeurs et les contributeurs au code doivent à la place installer l'extension à partir de Git en utilisant:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/WikidataPageBanner
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( 'WikidataPageBanner' );
  

•  Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Utilisation

Il existe quelques manières différentes pour positionner l'image d'une bannière sur une page :

1. Pour utiliser File:Image_name.jpg comme une image de bannière personnalisée, définissez-la sur la page : {{PAGEBANNER:Image_name.jpg}}
2. L’extension peut automatiquement ajouter la même image de bannière à toutes les pages des espaces de noms spécifiés, définis via la variable de configuration $wgWPBImage.
3. Si le wiki est connecté à Wikidata, il peut aussi y récupérer la bannière de chaque page. Dans ce cas le modèle Template:PAGEBANNER doit exister (et peut être vide). Le Wikivoyage anglophone possède un exemple de Template:Pagebanner complexe avec une logique de rendu et des dépendances supplémentaires de modèles.

Paramètres de la fonction {{PAGEBANNER}}

Les paramètres suivants sont pris en charge par la fonction d’analyse {{PAGEBANNER}} :

• |pgname= — ajoute un titre personnalisé à la bannière.
• |icon-*= — pour ajouter des icônes personnalisées, utilisez le paramètre |icon-<nom_de_l'icône>=<Article concernant l'icône> (où <nom_de_l'icône> est le nom de l'icône à utiliser). Puis définissez une image de fond .oo-ui-icon-<nom_de_l'icone> dans MediaWiki:Common.css pouvant être utilisée en tant qu'icône. Faites cela pour toutes les icônes à ajouter sur la page.
• |tooltip= — utiliser |tooltip=image-caption pour afficher la description de l'image quand on la survole
• |toc= — utiliser |toc=yes pour afficher la table des matières à l'intérieur de la bannière
• |bottomtoc= — utiliser |bottomtoc=yes pour placer la table des matières sous la bannière. Ceci n'impactera que la page sur laquelle elle est utilisée. Pour afficher la table des matières en bas et sur tout le site, voir le paragraphe ci-dessous.
• |extraClass= — utilisez |extraClass=<css-class names> (avec le séparateur Espace) pour ajouter des classes supplémentaires à la bannière pouvant être utilisées pour la personnaliser avec les styles dans MediaWiki:Common.css
• |origin= — voir la section ci-dessous.
• |link= — définit la cible du lien de la bannière et fonctionne de la même manière que le paramètre link pour les images (par exemple |link=Nom_de_l'événement pointera vers la page Nom_de_l'événement plutôt que vers la page de l'image de la bannière). Omettez la valeur pour supprimer le lien, comme |link= .

Paramètre 'origin'

Système de coordonnées pour les bannières.

Utiliser ce paramètre pour définir une zone focale suggérée de l’image. Ceci est utilisé pour tronquer la bannière de manière appropriée sur les petits écrans. La valeur du paramètre est formée des coordonnées X et de Y séparées par une virgule. Chaque coordonnée représente la distance du centre de l'image en tant que valeur allant de -1 à 1. Par exemple, |origin=1,1 est le coin supérieur droit et |origin=-1,1 est le coin inférieur droit. Voir l'image de droite pour la représentation graphique des coordonnées.

Notez que |origin= sert pour les images qui débordent de la zone cible allouée à la bannière (par exemple en largeur avec des grands panoramas, ou des photos de portraits pour la hauteur). La bannière ne sera pas repositionnée si l'espace n'est pas complètement occupé, laissant des zones vides. Par exemple si une bannière doit occuper une largeur de 320 pixels et une hauteur de 180 pixels, une image de cette taille exactement ne sera pas du tout repositionnée; une image de 600 pixels en largeur sur 180 pixels en hauteur peut être repositionnée horizontalement et une image de 320 pixels en largeur sur 1000 pixels en hauteur peut être repositionnée verticalement.

Variables de configuration

$wgWPBImage indique qu'il faut utiliser l'image de la bannière par défaut. Ajouter le nom de l'image sans le préfixe de l'espace de noms 'File:'. Si le wiki n'a pas de bannière par défaut, ne modifiez pas ce champ.

$wgWPBImage = "foo.jpg";

$wgWPBBannerProperty propriété Wikidata de la bannière contenant un fichier média de Commons. C'est essentiel si Wikidata est activé.

$wgWPBBannerProperty = "P948";

$wgWPBEnableDefaultBanner active l'image de la bannière par défaut sur les pages sans utiliser {{PAGEBANNER}}.

$wgWPBEnableDefaultBanner = true;

$wgWPBNamespaces tableau d'espaces de noms pour lesquels la bannière doit être affichée. L'espace de noms par défaut est Main. Vous pouvez également le mettre à true() pour afficher la bannière sur tous les espaces de noms, sauf ceux qui sont exclus par $wgWPBDisabledNamespaces.

$wgWPBNamespaces = [ NS_MAIN ];

$wgWPBDisabledNamespaces permet d'exclure l'affichage de la bannière dans certains espaces de noms. Notez que ce paramètre n'a d'effet que si $wgWPBNamespaces vaut true. Sinon ce paramètre est ignoré et seuls les espaces de noms de $wgWPBNamespaces sont pris en compte.

$wgWPBDisabledNamespaces = [ NS_FILE ];

$wgWPBStandardSizes tableau de largeurs d'écrans prédéfinis standards, dans l'ordre croissant de leur taille.

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

$wgWPBEnablePageImagesBanners s'il vaut true et que Extension:PageImages est installé, on utilise une image de page si aucune image Wikidata ni locale n'est définie.

$wgWPBEnablePageImagesBanners = true;

$wgWPBDisplaySubtitleAfterBannerSkins tableau des noms d'habillages qui doivent afficher la bannière dans la zone de note du site, au lieu de la placer dans le sous-titre de la page (valeur par défaut).

$wgWPBDisplaySubtitleAfterBannerSkins = [ 'minerva' ];

$wgWPBEnableHeadingOverride indique si le titre de la page est affiché sur l'image de la bannière. Valeur par défaut : true.

$wgWPBEnableHeadingOverride = true;

$wgWPBEnableMainPage indique si une bannière peut s'afficher sur Main Page. Valeur par défaut : false.

$wgWPBEnableMainPage = false;

Exemples

Quelques exemples avec les commentaires :

{{PAGEBANNER:Grand_canyon.jpg}}

Ajoutera une bannière en utilisant l'image Grand_canyon.jpg comme source locale ou de Wikimedia Commons.

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

Ajoutera une bannière en utilisant l'image Grand_canyon.jpg comme source locale ou de Wikimedia Commons. Ajoutera en plus les icônes avec les noms des classes oo-ui-icon-star, oo-ui-icon-unesco. Ajoute la propriété background-image à ces classes dans MediaWiki:Common.css pour les icônes souhaitées.

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

Ajoutera une bannière en utilisant l'image Grand_canyon.jpg comme source locale ou de Wikimedia Commons. Ajoute en plus la table des matières à l'intérieur de la bannière. Définit le nom affiché sur la bannière comme Some page.

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

Ajoutera une bannière en utilisant l'image Grand_canyon.jpg comme source locale ou de Wikimedia Commons. Ajoute en plus les classes CSS class1 et class2 au div .wpb-topbanner.

Exemple d'utilisation de la bannière de Wikidata

Vérifiez que $wgWPBBannerProperty est initialisé à la propriété correcte de la bannière Wikidata. Puis laissez le nom de l'image à vide, et initialisez les autres paramètres nécessaires :

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

L'image de la bannière sera utilisée comme défini dans l'élément de la page Wikidata. Si cet élément ne possède pas d'image de bannière, ou que la page ne possède pas d'élément Wikidata, une image par défaut sera utilisée (si $wgWPBImage est initialisé).

Mise en forme

L'extension possède un large éventail de mises en forme de la bannière via Common.css. Voici quelques exemples de modifications CSS habituelles.

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

ceci positionne la table des matières juste sous la bannière dans le cas où elle est longue. Notez qu'en faisant cela toutes les pages de bannière du wiki auront la table des matières sous la bannière. Néanmoins, en utilisant bottomtoc=yes en tant que paramètre, vous pouvez afficher la table des matières uniquement au bas de la page sur laquelle elle est utilisée.

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

ceci définit la taille de la fonte du nom de la bannière à 1 em (plus petit que la valeur par défaut 2,2 em).

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

ceci réduit l'espacement vertical entre les lignes de la table des matières.

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

ceci ajoute une certaine distance entre la bannière et la table des matières.