Modèle:Méta documentation de modèle

 Documentation

Ce modèle utilise le module Documentation 2, un script écrit dans le langage de programmation Lua. Toute expérimentation devrait être conduite d'abord via une sous-page bac à sable. Voir le Projet:Scribunto si vous voulez en savoir plus.

{{Méta documentation de modèle}} est un méta-modèle pour la création de modèles de documentation affichant une boîte verte (comme celle contenant le texte que vous lisez actuellement).

Fonctionnement

Ce modèle est basé sur le module Documentation 2. L'affichage est constitué d'un titre affiché en haut, de la documentation elle même, et d'une notice affichée en bas.

Le contenu de la documentation est généré depuis différentes sources :

• Le contenu de la documentation est obtenu depuis la sous-page /Documentation, sauf si le paramètre contenu est renseigné. C'est alors sa valeur qui est utilisée.
• Le paramètre 1 permet de cibler une page de documentation différente de la sous-page /Documentation, par exemple pour mutualiser une page entre plusieurs modèles. Dans ce cas, il reste possible d'ajouter un contenu en dessous de celle-ci à l'aide du paramètre complément.
• Il est possible de définir un contenu standard pour la documentation en utilisant les paramètres pré-contenu et post-contenu. Leur valeur sera alors affichée respectivement au dessus et en dessous du contenu, qu'il provienne de la sous-page de documentation ou du paramètre contenu.

Différents bandeaux sont affichés en fonction du contexte :

• Si le modèle est protégé, un bandeau décrivant la protection est affiché. Le paramètre message protection permet de modifier le titre de celui-ci. Une icône de titre est également placée en haut de la page.
• Lorsque le modèle est un bac à sable, il ajoute automatiquement le modèle {{Sous-page de bac à sable}} en haut de page.
• En l'absence de contenu pour la documentation, c'est-à-dire lorsqu'il n'y a ni sous-page de documentation ni valeur fournie paramètre contenu, un bandeau incitant à création de celle-ci est affiché, et le modèle est placé dans la catégorie « Modèle sans documentation ». Si les paramètres pré-contenu ou post-contenu sont renseignés et jouent déjà ce rôle, il est possible de fournir le paramètre contenu facultatif (avec n'importe quelle valeur) pour éviter l'affichage du bandeau.

Enfin, des liens sont également générés automatiquement :

• En l'absence de contenu pour la documentation, un lien [créer] est affiché, qui permet de débuter la création de la page en préchargeant le format de page de documentation de base.
• Des liens disponibles au bas de la notice permettent également de créer les sous-pages /Bac à sable et /Test.

Paramètres

Il faut différencier les méta-paramètres, destinés à être utilisés directement par les modèles qui utilisent ce méta-modèle, et les paramètres, qui sont destinés à l'usage final et que les modèles peuvent se contenter de transmettre.

Liste des paramètres

Ces paramètres peuvent être transmis par les modèles qui utilisent ce méta-modèle, pour utilisation dans l'inclusion finale.

• contenu : Contenu brut à afficher dans la documentation. Remplace le contenu affiché depuis la sous-page si elle existe.
• 1 : Indique la page de documentation à charger si elle est différente de la sous-page /Documentation. Permet de mutualiser une sous-page de documentation entre plusieurs modèles.
• complément : Ajoute un complément à la suite du contenu provenant de la page de documentation chargée par le paramètre 1.
• message protection : Personnalise le titre du bandeau de protection si le modèle est protégé.

Liste des méta-paramètes

Ces paramètres sont destinés uniquement aux modèles de documentation qui utilisent ce méta-modèle. Ils ne doivent pas être transmis pour utilisation finale.

• nom modèle : À renseigner avec le nom du modèle de documentation. Affiche un lien vers celui-ci. Obligatoire en l'absence du paramètre notice.
• titre : Personnalise le titre du modèle de documentation.
• notice : Personnalise la notice affichée sur le modèle de documentation.
• pré-contenu : Ajoute un contenu au-dessus du contenu de la documentation.
• post-contenu : Ajoute un contenu en dessous du contenu de la documentation.
• contenu facultatif : Indique que la présence d'un contenu de documentation n'est pas obligatoire pour éviter l'affichage du bandeau. À ne renseigner que si le paramètre pré-contenu ou le paramètre post-contenu remplissent déjà ce rôle.
• couleur : Personnalise la couleur d'arrière-plan du modèle de documentation.
• module : Indique que le modèle de documentation est destiné aux modules.

Les paramètres couleur et module ne devraient être utilisés que par le modèle {{Documentation module}}, pour permettre de distinguer la documentation des modules de celle des modèles.

Template data

Ce modèle est un méta-modèle pour la création de modèles de documentation.

Paramètres du modèle

Paramètre		Description	Type	Statut
1	1	Spécifie le nom d'une page de documentation à utiliser différente, qui peut être partagée par plusieurs modèles	Chaîne	facultatif
Contenu	contenu	Spécifie le contenu de la documentation, pour qu'il soit directement inclus dans le corps du modèle. Ne pas utiliser si vous voulez créer une sous page.	Chaîne	facultatif
Complément	complément	Dans le cas où le paramètre "1" est renseigné (documentation chargée depuis une autre page de documentation), ce paramètre permet d'ajouter un contenu supplémentaire.	Chaîne	facultatif
Message protection	message protection	Modifie le titre du bandeau ajouté lorsque la page est en protection complète.	Chaîne	facultatif
Nom modèle	nom modèle	Méta-paramètre : à renseigner avec le nom du modèle de documentation.	Chaîne	facultatif
Notice	notice	Méta-paramètre : personnalise la notice de la documentation.	Chaîne	facultatif
Titre	titre	Méta-paramètre : modifie le titre de la documentation.	Chaîne	facultatif
Pré-contenu	pré-contenu	Méta-paramètre : ajoute un contenu statique au dessus du contenu.	Chaîne	facultatif
Post-contenu	post-contenu	Méta-paramètre : ajoute un contenu statique en-dessous du contenu.	Chaîne	facultatif
Contenu facultatif	contenu facultatif	Renseigner à n'importe quelle valeur pour indiquer que la présence d'un contenu de documentation n'est pas obligatoire. À ne renseigner que si le paramètre <code>pré-contenu</code> ou le paramètre <code>post-contenu</code> remplissent déjà ce rôle.	Chaîne	facultatif
Couleur	couleur	Méta-paramètre : modifie la couleur par défaut de la documentation. Réservé aux modules.	Chaîne	facultatif
Module	module	Méta-paramètre : spécifie que le modèle de documentation s'applique aux modules. Réservé aux modules.	Chaîne	facultatif

Voir aussi

• {{Documentation}}
• Module:Documentation 2

La documentation de ce modèle est incluse depuis sa sous-page de documentation (modifier | historique).
Veuillez placer les catégories dans la sous-page /Documentation.