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

Version du 12 juin 2012 à 00:45

This is a documentation subpage for Modèle:Documentation (see that page for the modèle itself).
It contains usage information, categories and other content that is not part of the original modèle page.

Utilisation[modifier le wikicode]

À inclure, toujours dans une section noinclude :

soit en fin de modèle (pour afficher sa sous-page de documentation ;
soit en tête de sa sous-page de documentation (pour faire référence au modèle de base et signaler que c’est une sous-page de documentation).

Syntaxe[modifier le wikicode]

<noinclude>{{Documentation}}</noinclude>

Paramètres[modifier le wikicode]

Ce modèle s’emploie normalement sans aucun paramètre.
Si un paramètre est indiqué (lors de l’utilisation au sein d’un modèle, mais pas dans sa sous-page de documentation), il sert à mentionner le nom d’une page de documentation alternative, qui peut être partagée par plusieurs modèles que la même page de documentation documente ensemble.

Exemple[modifier le wikicode]

À compléter.

Voir aussi[modifier le wikicode]

wikt:Modèle:Documentation : modèle équivalent sur le Wiktionnaire francophone.

@@ Ligne 1 : / Ligne 1 : @@
-{{documentation subpage}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> __NOTOC__ This template automatically displays a documentation box like you are seeing now, of which the content is transcluded from another page. It is intended for pages which are [[wikipedia:Transclusion|transcluded]] in other pages, i.e. templates, whether in the template namespace or not.
+<noinclude>{{Documentation modèle en sous-page}}</noinclude>
+== Utilisation ==
+À inclure, '''toujours''' dans une section <tt>noinclude</tt> :
+* soit en fin de modèle (pour afficher sa sous-page de documentation ;
+* soit en tête de sa sous-page de documentation (pour faire référence au modèle de base et signaler que c’est une sous-page de documentation).
-== Usage  ==
+== Syntaxe ==
+* <tt><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></tt>
-=== Normal /doc  ===
+== Paramètres ==
+* Ce modèle s’emploie normalement sans aucun paramètre.
+* Si un paramètre est indiqué (lors de l’utilisation au sein d’un modèle, mais pas dans sa sous-page de documentation), il sert à mentionner le nom d’une page de documentation alternative, qui peut être partagée par plusieurs modèles que la même page de documentation documente ensemble.
- &lt;noinclude&gt;{{{{{template-name|Documentation}}}}}&lt;/noinclude&gt;
+== Exemple ==
+À compléter.
-=== Any /doc page  ===
+== Voir aussi ==
+* [[wikt:Modèle:Documentation]] : modèle équivalent sur le Wiktionnaire francophone.
- &lt;noinclude&gt;{{{{{template-name|Documentation}}}|Template:any page/doc}}&lt;/noinclude&gt;
+<includeonly>
+{{DEFAULTSORT:Documentation}}
+[[Catégorie:Bandeau de documentation modèle]]
-=== In-line content  ===
- &lt;noinclude&gt;{{{{{template-name|Documentation}}}|content=This is documentation.}}&lt;/noinclude&gt;
-=== In-line content with [view][edit] links  ===
- &lt;noinclude&gt;{{{{{template-name|Documentation}}}
- |1 = Template:any page/doc
- |content ={{Template:any page/doc|parameters}}
- }}&lt;/noinclude&gt;
-=== Best practice  ===
-This code should be added at the bottom of the template code, with no extra space before "<code>&lt;noinclude&gt;</code>" (which would cause extra space on pages where the template is used). The parameter can be used as shown above to transclude an arbitrary documentation page.
-Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <code>&lt;includeonly&gt; &lt;/includeonly&gt;</code> tags. For more complex cases, see [[wikipedia:Template documentation|RTENOTITLE]].
-If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "&lt;" with "&amp;lt;".
-=== Customizing display  ===
-Overrides exist to customize the output in special cases:
-*<code>{{documentation| '''heading''' = ...}}</code> − change the text of the "documentation" heading. If this is set to blank, the entire heading line (including the first [edit] link) will also disappear.
-== Functions  ==
-If the documentation page doesn't exist, the "edit" link includes a [[Mw:Manual:Creating pages with preloaded text|preload]] parameter so that clicking it will pre-fill the edit form with the basic documentation page format.
-== Rationale  ==
-Use of this template allows templates to be [[wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.
-== See also  ==
-{{ Documentation/doc/see also }}
-<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
-[[Category:Template documentation| ]]
 </includeonly>