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

Navigation interactive dans l’historique

Dernière version du 16 octobre 2025 à 14:15

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>
-<!-- Modèle de documentation standardisé pour les modèles MediaWiki -->
+{{DISPLAYTITLE:Documentation}}
-<!-- Force l'affichage du titre sous la forme "Modèle:Nom/doc" -->
+<!--
-<!-- Inspiré des bonnes pratiques des wikis techniques (Wikimedia, Fandom, etc.) -->
+  Modèle de documentation avec CSS externe via <templatestyles>
+  Utilisation : {{Documentation}}
+  Nécessite l'extension TemplateStyles (https://www.mediawiki.org/wiki/Extension:TemplateStyles)
+-->
+<templatestyles src="Modèle:Documentation/styles.css" />
+{{Documentation}}
 </noinclude>
 <includeonly>
+<div class="nef-doc-wrapper">
 {{#ifexist: {{FULLPAGENAME}}/doc
-   | {{ {{FULLPAGENAME}}/doc | 1=<noinclude>{{DISPLAYTITLE:{{PAGENAME}} (documentation)}}</noinclude> }}
+| <!-- Contenu avec documentation -->
-  | <div class="mw-documentation-missing" style="
+<div class="nef-doc-box nef-doc-has-content">
-      border: 1px solid #c8ccd1;
+   {{ {{FULLPAGENAME}}/doc }}
-      background-color: #f8f9fa;
+</div>
-      padding: 15px;
+| <!-- Message d'absence de documentation -->
-      margin: 10px 0;
+<div class="nef-doc-box nef-doc-missing">
-      border-radius: 4px;
+  <div class="nef-doc-icon" aria-hidden="true">📖</div>
-    ">
+  <div class="nef-doc-text">
-      <h2 style="margin-top: 0; border-bottom: 1px solid #c8ccd1; padding-bottom: 0.2em;">
+    <strong>Ce modèle n'a pas de documentation.</strong><br>
-        <span class="mw-headline" id="Documentation_manquante">Documentation manquante</span>
+    Vous pouvez [
-      </h2>
+    {{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=Modèle:Preload/Documentation}}
-      <div class="mw-documentation-notice" style="margin-left: 20px;">
+    créer la page <code>/doc</code>
-        '''Ce modèle n’a pas de documentation.'''
+    ] pour en ajouter une.
-        <br>
+  </div>
-        Vous pouvez [[{{FULLPAGENAME}}/doc|créer la sous-page <code>/doc</code>]] pour décrire son fonctionnement.
+</div>
-        <br><br>
+}}
-        <small>
+</div>
-          <strong>Conventions :</strong>
+</includeonly>
-          <ul style="margin-top: 0.3em;">
-            <li>Utilisez <code>&lt;noinclude&gt;...&lt;/noinclude&gt;</code> pour encapsuler la documentation.</li>
-            <li>Le titre doit être défini via <code>{{DISPLAYTITLE:Nom (documentation)}}</code>.</li>
-            <li>Exemple : [[Modèle:Exemple/doc|voir un exemple complet]].</li>
-          </ul>
-        </small>
-      </div>
-    </div>
-}}</includeonly>