Modèle:Documentation
{{Documentation}} est un modèle de mise en forme de documentation pour les modèles qui affiche le texte de la documentation dans une boîte verte (comme celle contenant le texte que vous lisez actuellement). Il est à placer après le code du modèle dans une section protégée par des balises noinclude.
Si une sous-page /Documentation existe, ce modèle affiche automatiquement son contenu. L'utilisation d'une sous-page de documentation permet notamment à tout le monde d'éditer le texte de celle-ci ainsi que les catégories d'un modèle protégé. Si la sous-page de documentation n'existe pas, 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 de la même manière de créer les sous-pages /Bac à sable et /Test.
Lorsque la page est un bac à sable de modèle (sous-page /Bac à sable), ce modèle ajoute automatiquement le bandeau {{Sous-page de bac à sable}} en haut de page. Lorsque la page est semi-protégée ou protégée, le bandeau approprié est automatiquement inséré, sauf s'il est déjà présent dans la sous-page de documentation.
Syntaxe Modifier
Syntaxe simple Modifier
En général, ce modèle est utilisé sans aucun paramètre, placé en bas du modèle ou de la page documentée, dans des balises « <noinclude> » :
<noinclude>{{Documentation}}</noinclude>
De cette façon, le contenu de la sous-page /Documentation du modèle se chargera automatiquement.
Utilisation d'une page de documentation différente Modifier
{{Documentation}} peut également charger le contenu à partir de n'importe quelle autre page :
<noinclude>{{Documentation|Modèle:Exemple/Documentation}}</noinclude>
De cette façon, le contenu de la sous-page /Documentation du modèle {{Exemple}} se chargera automatiquement. Notez bien que l'espace de nom (« Modèle: » ici) doit être indiqué. Cette syntaxe permet d'utiliser une documentation partagée par plusieurs modèles.
Utilisation sans page de documentation Modifier
Le contenu peut également être rédigé dans le corps du modèle :
<noinclude>{{Documentation|contenu=
== Utilisation ==
Lorem ipsum...
}}</noinclude>
Cependant, cette méthode comporte des limitations. Par exemple, la syntaxe MediaWiki des tableaux ne peut être utilisée avec le paramètre contenu.
Dans le cas général, on évitera d’utiliser le paramètre contenu dès que la documentation dépasse quelques lignes, pour lui préférer l’utilisation d'une sous-page de documentation.
Dans tous les cas, lorsque le modèle est protégé, le contenu doit être transféré en sous-page, afin de permettre son édition par tout le monde. Il suffit de suivre les instructions de la notice, disponible en bas de page de chaque documentation.
Paramètres Modifier
Ce modèle affiche la documentation d'un modèle.
| Paramètre | Description | Type | État | |
|---|---|---|---|---|
| 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 |
| message protection | message protection | Modifie le titre du bandeau ajouté lorsque la page est en protection complète. | 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 |
Exemples Modifier
Voir la sous-page de test.
Voir aussi Modifier
- {{Documentation d'une sous-page de modèle}}
- {{Méta documentation de modèle}}
- la catégorie « Modèle de documentation » : contient des modèles de documentation spécialisés pour certains types de modèles
- {{Sous-page de documentation}}
- {{Sous-page de bac à sable}}
- {{Sous-page de test}}
La documentation de ce modèle est générée par le modèle {{Documentation}}.
Elle est incluse depuis sa sous-page de documentation. Veuillez placer les catégories sur cette page-là.
Les éditeurs peuvent travailler dans le bac à sable (créer) et la page de test (créer).
Voir les statistiques d'utilisation du modèle sur l'outil wstat.