Modèle:Habillage

Documentation du modèle

Ce modèle doit être ajouté sur la page principale de chacun des habillages du wiki afin d'afficher une boîte d'informations et catégoriser l'habillage courant.

Utilisation

Copier-coller : {{Skin|templatemode = |name = |localised name = |status = |hook1 = |hook2 = |newhook1 = |newhook2 = |username = |author = |description = |image = |imagesize = |version = |update = |version preview = |update preview = |compatibility policy = |mediawiki = |php = |composer = |license = |download = |readme = |changelog = |example = |parameters = |compatibility = |bugzilla = |phabricator = |vagrant-role = }} Pour obtenir de l'aide sur la valeur des paramètres, voir ci-dessous.

Manuel des habillages MediaWiki - catégorie {{{localised name}}} État de la version : inconnu Description {{{description}}} Auteur(s) SomeAuthor Version actuelle : {{{version}}} ({{{update}}}) Version actuelle de développement {{{version preview}}} ({{{update preview}}}) Politique de compatibilité MediaWiki {{{mediawiki}}} PHP {{{php}}} Composer {{{composer}}} Licence {{{license}}} Téléchargement {{{download}}} {{{readme}}} {{{changelog}}} Exemple {{{example}}} Paramètres {{{parameters}}} Accroches utilisées hook1 hook2 Accroches fournies newhook1 newhook2 {{{compatibility}}} Traduisez l'habillage Skin sur translatewiki.net Rôle Vagrant {{{vagrant-role}}} Problèmes : [[phab:tag/{{{phabricator}}}|Tâches ouvertes]] · Signaler un bogue

Paramètres de contenu

Cette section décrit les paramètres qui contrôlent le contenu de la boîte d'information. Pour l'aide concernant templatemode et les autres paramètres de contrôle, voir Paramètres de contrôle.

Paramètres de contenu

Paramètre	Description
name	nom de l'habillage
localised name	texte source pour traduire le nom de l'habillage Mettre la même valeur que name. Il sera utilisé plus tard pour traduire le nom.
status	état de la version actuelle Une valeur parmi : unstable - cassé actuellement - ne pas utiliser cet habillage avec la dernière version de MediaWiki experimental - premières étapes du développement, peut changer complètement beta - stable mais pas complètement testé stable - stable - l'habillage fonctionne dans la dernière version de MediaWiki sans erreurs fatales. unmaintained - non maintenu - utilisez uniquement si le dépôt lié est archivé ou si le mainteneur n'a pas répondu à une demande concernant l'état de maintenance. Si vous utilisez cet état, veuillez créer un lien vers un correctif, ou un rapport de problème ou bogue qui servira de référence, en utilisant un commentaire HTML. Si l'habillage est cassé, utiliser unstable à la place. unknown - valeur par défaut Si le statut est différent de ce qui précède, il sera ignoré et la valeur par défaut inconnue (Unknown) sera affichée à la place dans le modèle. schéma des couleurs en fonction de l'état des versions
hook1 hook2 hook3 hook4 ... hook90	nom de chaque accroche utilisée par l'extension En plaçant des valeurs dans ce champ, vous exposerez davantage votre extension et aiderez les autres développeurs. Chaque accroche documentée ajoutera automatiquement l'extension à une catégorie qui liste l'ensemble des extensions qui utilisent cette accroche. Cette catégorie et auto-liée à chaque page d'accroche de sorte que les programmeurs puissent facilement trouver des exemples d'extensions qui utilisent une accroche particulière. Pour les accroches intégrées : utiliser le nom de l'accroche seul. Voir Manual:Hooks pour les valeurs (omettre le '/' initial). Pour les accroches personnalisées définies par les extensions : utiliser extensionName/hookName. Liste partielle d'accroches personnalisées : voir Extension hook registry. Pour les accroches multiples, assignez la première accroche à hook1, la seconde à hook2 et ainsi de suite.
newhook1 newhook2 newhook3 newhook4 ... newhook90	nom de chaque accroche fournie par l'extension Vous pouvez également ajouter les accroches dans Extension hook registry.
username	Nom d'utilisateur de l'auteur sur MediaWiki.org (si vous en avez un). Peut être omis mais s'il est présent, il sera utilisé pour créer un lien vers la page utilisateur et la page de discussion de l'auteur. A fournir sans l'espace de noms ni les [[]]s.
author	Nom de l'auteur de l'habillage, s'il est différent du nom d'utilisateur sur MediaWiki.org. Texte libre. S'il est absent, alors le champ 'username' sera utilisé (s'il existe).
description	courte description
image	capture d'écran ou logo de l'habillage. Doit être fourni sans l'espace de noms et sans [[]]s.
imagesize	facultatif, taille de l'image (par défaut 220 pixels)
version	dernière version
update	date de la dernière mise à jour
compatibility policy	politique de compatibilité (les valeurs acceptées sont master, rel et ltsrel). (backlog )
mediawiki	version de MediaWiki requise
php	version de PHP nécessaire
license	licence(s) régissant l'utilisation de cet habillage, par exemple la licence GPL
download	lien de téléchargement: Use {{Modèle:WikimediaDownloadSkin }} or {{Modèle:GithubDownload }}.
readme	lien externe du fichier readme
changelog	lien externe vers le fichier du journal des modifications
parameters	paramètres disponibles pour LocalSettings.php
example	exemple, site web ou capture d'écran de l'habillage en cours d'utilisation
compatibility	matrice de compatibilité
bugzilla	nom du composant de l'habillage MediaWiki Bugzilla

Paramètres de contrôle

Paramètres de contrôle

Paramètre

Description

templatemode

contrôle l'auto-catégorisation de la page d'hébergement. Normalement laissé vide. Les valeurs alternatives sont : nocats - supprime la catégorisation. Utiliser cette valeur si vous ajoutez ce modèle aux sous-pages d'un habillage ou à la documentation how-to des habillages. Par exemple, l'image d'utilisation ci-dessus définit templatemode=nocats parce que ce n'est pas une page d'habillage réelle et nous ne voulons pas ajouter cette page à une catégorie particulière à cause de cela. Si ce paramètre est laissé vide, ce modèle va ajouter la page hôte à Catégorie:Tous les habillages et à l'une ou à plusieurs catégories supplémentaires, en fonction des valeurs assignées aux paramètres de contenu. sous-page; ne fait pas partie de l'espace de noms Skin:; ou si supprimé par templatemode=nocats

Catégories ajoutées

Ce modèle ajoutera automatiquement les pages sur lesquelles il est utilisé, à la catégorie Category:All skins.

En plus il va catégoriser la page en fonction de la valeur du paramètre status qui représente son état :

• unstable: Category:Unstable skins
• experimental: Category:Experimental skins
• stable: Category:Stable skins
• beta: Category:Beta status skins
• unmaintained: Category:Unmaintained skins
• otherwise: Category:Skins with unknown status

Utiliser la boîte d'information

Pages d'extensions existantes

Si vous désirez ajouter la boîte d'information sur une page existante, copiez et collez le code qui se trouve au début de cette page.

Créer un nouvel article d'habillage

Pour créer une nouvelle page d'habillage, saisissez son nom ci-dessous et cliquez sur le bouton. Une nouvelle page sera créée avec le modèle de la boîte d'information déjà en place.

Veuillez remplacer "TheSkin" par le nom de votre habillage :

MediaWiki est un projet à source libre pour lequel les utilisateurs sont encouragés à écrire des habillages MediaWiki sous une initiative Open Source (OSI) approuvée par une license compatible GPLv2 (y compris MIT, BSD, PD). Pour les habillages qui ont une licence compatible, vous pouvez demander un accès pour les valider dans le dépôt des sources MediaWiki.

Un développeur qui partage son code dans le dépôt de code MediaWiki doit s'attendre à :

des commentaires / des critiques / des relectures de code

le relecture et les commentaires faits par les autres développeurs sur des points comme l'utilisation des composants logiciels, la sécurité, l'efficacité et l'utilisation.

des ajustements faits par les développeurs

Les autres développeurs peuvent modifier le code que vous avez proposé afin de l'améliorer ou d'y faire du nettoyage pour qu'il satisfasse aux nouvelles méthodes et classes de composants logiciels, aux conventions de codage et aux traductions.

de futures versions faites par les autres développeurs

De nouvelles branches de votre code créées automatiquement par les autres développeurs en tant que nouvelles versions de MediaWiki, seront publiées.

crédit

Le crédit pour votre travail est préservé dans les versions à venir

De même, vous devez créditer les développeurs de tout habillage dont vous empruntez le code.

Tout développeur qui n'approuve pas ces actions ne doit pas placer son code dans le dépôt de code. Vous êtes toujours encouragé à créer sur le wiki une page de présentation de votre habillage pour informer les lecteurs et leur indiquer où ils pourront le télécharger.

Etendre ce modèle

Si vous souhaitez améliorer ce modèle, vous êtes le bienvenu ! C'est un modèle compliqué, alors voici quelques conseils :

En plus, Template:Skin/Sample stocke le source de démarrage qui est préchargée dans les pages nouvellement créées et contient une documentation de base sur la façon de remplir les paramètres du modèle. Il faut le garder synchronisé avec la documentation.

Bouton créer un habillage

Pour améliorer le comportement du bouton de création d'habillage :

• Template:Skin/Sample — L'habillage de base qui est est préchargé dans les pages nouvellement créées.
• Modèle:Skin/CreateSkinInputBox — Une boîte de saisie qui peut être insérée où vous voulez pour que les utilisateurs créent facilement des habillages. Pour la documentation concernant la balise ‎<inputbox>, voir Extension:InputBox .
• Skin:TheSkin: — Définit une position, au cas où un utilisateur appuie accidentellement sur le bouton Créer sans changer le nom de l'habillage.

Paramètres de la boîte d'information

En général :

• Pour rendre ce modèle facile à utiliser chaque libellé de la boîte d'information pointe vers la documentation du paramètre du mdèle qu'il affiche. Si vous ajoutez un paramètre, assurez-vous de l'ajouter également dans la documentation des paramètres de contenu et de lier son libellé à cette documentation.

Cas d'utilisation

Vérifier que les pages suivantes sont encore cohérentes après avoir modifié ce modèle.

• Habillage:Vector
• Modèle:Habillage

Les éditeurs peuvent expérimenter dans le bac à sable (créer | mirroir) et dans la page de test (créer) de ce modèle.
Sous-pages de ce modèle.