« Modèle:Documentation/doc » : différence entre les versions
De Nefald
Autres actions
mAucun résumé des modifications |
Aucun résumé des modifications |
||
| Ligne 1 : | Ligne 1 : | ||
<noinclude> | <noinclude> | ||
{{DISPLAYTITLE:Documentation (documentation)}} | {{DISPLAYTITLE:Documentation (documentation)}} | ||
<!-- NE PAS | <!-- NE PAS utiliser {{Documentation}} ici pour éviter les boucles --> | ||
</noinclude> | </noinclude> | ||
<includeonly> | <includeonly> | ||
== Description == | == Description == | ||
Ce modèle | Ce modèle affiche la documentation des modèles via une sous-page <code>/doc</code>. | ||
Il | Il gère automatiquement : | ||
- L'inclusion de la documentation si <code>/doc</code> existe. | |||
- Un message d'avertissement sinon. | |||
- La catégorisation dans [[Catégorie:Documentation de modèle]]. | |||
=== Fonctionnement === | === Fonctionnement technique === | ||
1. | 1. Utilise <code>{{FULLPAGENAME}}/doc</code> pour localiser la documentation. | ||
2. | 2. Applique <code>{{DISPLAYTITLE:...}}</code> pour formater le titre. | ||
3. | 3. Catégorise **uniquement** les pages du namespace <code>Modèle</code> se terminant par <code>/doc</code>. | ||
== | == Syntaxe == | ||
<code>{{Documentation}}</code> | |||
== Exemple == | == Exemple complet == | ||
< | ::: Exemple avec <code>Modèle:Exemple</code> | ||
< | <pre> | ||
// Dans Modèle:Exemple : | |||
{{Documentation}} | {{Documentation}} | ||
</ | </pre> | ||
< | <pre> | ||
// Dans Modèle:Exemple/doc : | |||
<noinclude> | |||
{{DISPLAYTITLE:Exemple (documentation)}} | {{DISPLAYTITLE:Exemple (documentation)}} | ||
== Description == | == Description == | ||
. | Ce modèle fait X et Y. | ||
</ | == Paramètres == | ||
| Nom | Description | Obligatoire | | |||
|------|----------------------|-------------| | |||
| foo | Fait quelque chose | Non | | |||
[[Catégorie:Documentation de modèle]] | |||
</noinclude> | |||
</pre> | |||
== Règles | == Règles == | ||
- Les sous-pages de documentation **doivent** s'appeler <code>/doc</code> | - Les sous-pages de documentation **doivent** s'appeler <code>/doc</code>. | ||
- | - Toujours encapsuler la documentation dans <code><noinclude>...</noinclude></code>. | ||
- Utiliser <code>{{DISPLAYTITLE}}</code> pour personnaliser le titre. | |||
== Bonnes pratiques == | == Bonnes pratiques == | ||
- | - Pour les modèles complexes, ajoutez : | ||
- | - Une section <code== Exemples ==</code> avec des cas concrets. | ||
- | - Une section <code== Voir aussi ==</code> pour les modèles liés. | ||
- Une [[Catégorie:Modèles avancés]] si nécessaire. | |||
== Dépannage == | |||
- Si la documentation ne s'affiche pas : | |||
1. Vérifiez que <code>/doc</code> existe bien. | |||
2. Purgez le cache avec <code>?action=purge</code>. | |||
3. Vérifiez l'absence de boucles (ex: <code>/doc</code> qui inclut le modèle parent). | |||
[[Catégorie:Documentation de modèle|Documentation]] | [[Catégorie:Documentation de modèle|Documentation]] | ||
</includeonly> | </includeonly> | ||
Version du 16 octobre 2025 à 14:02