« 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 inspiré de Wikipedia fr -->
+{{DISPLAYTITLE:Documentation}}
-<!-- Affiche le titre sous la forme "Modèle:Nom (Documentation)" -->
+<!--
+  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>
-{{#ifexist: {{FULLPAGENAME}}/Documentation
+<div class="nef-doc-wrapper">
-  | {{ {{FULLPAGENAME}}/Documentation|1=<noinclude>{{DISPLAYTITLE:{{FULLPAGENAME}} (Documentation)}}</noinclude>}}
+{{#ifexist: {{FULLPAGENAME}}/doc
-  | {{#ifexist: {{FULLPAGENAME}}/doc
+| <!-- Contenu avec documentation -->
-      | <div class="mw-documentation-compat">
+<div class="nef-doc-box nef-doc-has-content">
-          '''Note :''' Cette documentation est stockée dans <code>[[:{{FULLPAGENAME}}/doc]]</code>.
+  {{ {{FULLPAGENAME}}/doc }}
-          <br>
+</div>
-          Pour suivre les conventions de Wikipedia fr, déplacez-la vers <code>[[:{{FULLPAGENAME}}/Documentation]]</code>.
+| <!-- Message d'absence de documentation -->
-          <hr>
+<div class="nef-doc-box nef-doc-missing">
-          {{ {{FULLPAGENAME}}/doc}}
+  <div class="nef-doc-icon" aria-hidden="true">📖</div>
-        </div>
+  <div class="nef-doc-text">
-      | <div class="mw-documentation-missing">
+    <strong>Ce modèle n'a pas de documentation.</strong><br>
-          <h2>Documentation manquante</h2>
+    Vous pouvez [
-          <div class="mw-documentation-notice">
+    {{fullurl:{{FULLPAGENAME}}/doc|action=edit&preload=Modèle:Preload/Documentation}}
-            '''Ce modèle n’a pas encore de documentation.'''
+    créer la page <code>/doc</code>
-            <br>
+    ] pour en ajouter une.
-            Vous pouvez [[{{FULLPAGENAME}}/Documentation|créer la page de documentation]] pour expliquer son utilisation.
+  </div>
-            <br><br>
+</div>
-            <small>
+}}
-              (Les pages de documentation doivent être nommées <code>/Documentation</code>, comme sur [[:w:fr:Aide:Documentation de modèle|Wikipedia fr]]).
+</div>
-            </small>
+</includeonly>
-          </div>
-        </div>
-    }}
-}}</includeonly>