« Modèle:Documentation/doc » : différence entre les versions

Navigation interactive dans l’historique

Dernière version du 24 octobre 2025 à 16:23

Description

Ce modèle permet d’afficher automatiquement la documentation d’un modèle depuis sa sous-page /doc.

Utilisation

1. Dans le modèle principal (ex: Modèle:Exemple), ajoutez :

{{Documentation}}

2. Créez une sous-page Modèle:Exemple/doc avec la documentation.

Exemple de structure pour une page /doc

<noinclude>
{{DISPLAYTITLE:Exemple (documentation)}}
</noinclude>
== Description ==
Ce modèle fait X et Y.

== Paramètres ==
; param1
: Description du paramètre 1.

; param2
: Description du paramètre 2.

== Exemples ==
<pre>
{{Exemple
| param1 = valeur1
| param2 = valeur2}}
</pre>

[[Catégorie:Documentation de modèle]]

Catégorisation automatique

Les pages /doc dans l’espace de noms Modèle sont automatiquement ajoutées à .

@@ Ligne 1 : / Ligne 1 : @@
 <noinclude>
 {{DISPLAYTITLE:Documentation (documentation)}}
-<!-- NE PAS INCLURE {{Documentation}} ici pour éviter la récursivité ! -->
+<!-- NE PAS INCLURE {{Documentation}} ici ! -->
-<div class="mw-documentation-header" style="..."
-  '''Ce modèle est utilisé sur {{PAGESINCATEGORY:Documentation de modèle|R}} pages.'''
-  [{{fullurl:Special:WhatLinksHere/Modèle:Documentation|limit=500}} Voir les utilisations]
-</div>
 </noinclude>
-<includeonly>
 == Description ==
-Ce modèle standardise l'affichage de la documentation pour les modèles du wiki.
+Ce modèle permet d’afficher automatiquement la documentation d’un modèle depuis sa sous-page <code>/doc</code>.
-Il recherche automatiquement une sous-page <code>/doc</code> et l'affiche en bas du modèle parent.
-=== Fonctionnement ===
+== Utilisation ==
-. Si <code>{{FULLPAGENAME}}/doc</code> existe → l'inclut avec un titre adapté.
+. Dans le modèle principal (ex: <code>Modèle:Exemple</code>), ajoutez :
-. Sinon → affiche un message incitant à créer la documentation.
+   <pre>{{Documentation}}</pre>
-. Applique la [[Catégorie:Documentation de modèle]] **uniquement** aux pages <code>Modèle:*/doc</code>.
+. Créez une sous-page <code>Modèle:Exemple/doc</code> avec la documentation.
-== Syntaxes acceptées ==
+== Exemple de structure pour une page /doc ==
-| Dans le modèle parent       | Résultat                                  |
+<pre>
-|-----------------------------|-------------------------------------------|
+&lt;noinclude&gt;
-| <code>{{Documentation}}</code> | Affiche <code>Modèle:Nom/doc</code> si elle existe. |
+{{DISPLAYTITLE:Exemple (documentation)}}
+&lt;/noinclude&gt;
+== Description ==
+Ce modèle fait X et Y.
+== Paramètres ==
+; param1
+: Description du paramètre 1.
-== Exemple ==
+; param2
-<syntaxhighlight lang="wiki">
+: Description du paramètre 2.
-<!-- Dans Modèle:Exemple -->
-{{Documentation}}
-</syntaxhighlight>
-<syntaxhighlight lang="wiki">
+== Exemples ==
-<!-- Dans Modèle:Exemple/doc -->
+&lt;pre&gt;
-<noinclude>
+{{Exemple
-{{DISPLAYTITLE:Exemple (documentation)}}
+| param1 = valeur1
-{{Documentation}} <!-- Inclut le bloc de catégorisation -->
+| param2 = valeur2}}
-== Description ==
+&lt;/pre&gt;
-...
-</noinclude>
-</syntaxhighlight>
-== Règles de nommage ==
+[[Catégorie:Documentation de modèle]]
-- Les sous-pages de documentation **doivent** s'appeler <code>/doc</code> (ex: <code>Modèle:Nom/doc</code>).
+</pre>
-- Le titre doit être défini via <code>{{DISPLAYTITLE:Nom (documentation)}}</code>.
-== Bonnes pratiques ==
+== Catégorisation automatique ==
-- Encapsulez toujours la documentation dans <code>&lt;noinclude&gt;...&lt;/noinclude&gt;</code>.
+Les pages <code>/doc</code> dans l’espace de noms <code>Modèle</code> sont automatiquement ajoutées à [[Catégorie:Documentation de modèle]].
-- Utilisez les sections <code== Paramètres ==</code>, <code== Exemples ==</code>, etc.
-- Pour les modèles complexes, ajoutez une [[Catégorie:Modèles avancés]].
-[[Catégorie:Documentation de modèle|Documentation]]
+<noinclude>[[Catégorie:Documentation de modèle]]</noinclude>
-</includeonly>