Modèle:Documentation

Alöndö na Wikipedia
Gue na: Simba, Gi
[edit] [[[:Modèle:Purge]]] Template-info.svg Template documentation

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 transcluded in other pages, i.e. templates, whether in the template namespace or not.

Usage[fa na mbi | modifier le wikitexte]

Normal /doc[fa na mbi | modifier le wikitexte]

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

Any /doc page[fa na mbi | modifier le wikitexte]

<noinclude>{{Documentation|Template:any page/doc}}</noinclude>

In-line content[fa na mbi | modifier le wikitexte]

<noinclude>{{Documentation|content=This is documentation.}}</noinclude>

In-line content with [view][edit] links[fa na mbi | modifier le wikitexte]

<noinclude>{{Documentation
|1 = Template:any page/doc
|content ={{Template:any page/doc|parameters}}
}}</noinclude>

Best practice[fa na mbi | modifier le wikitexte]

This code should be added at the bottom of the template code, with no extra space before "<noinclude>" (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 <includeonly> </includeonly> tags. For more complex cases, see Wikipedia:Template documentation#Categories and interwiki links.

If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&lt;".

Customizing display[fa na mbi | modifier le wikitexte]

Overrides exist to customize the output in special cases:

  • {{documentation| heading = ...}} − 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[fa na mbi | modifier le wikitexte]

If the documentation page doesn't exist, the "edit" link includes a preload parameter so that clicking it will pre-fill the edit form with the basic documentation page format.

Rationale[fa na mbi | modifier le wikitexte]

Use of this template allows templates to be protected where necessary, while allowing anyone to edit the documentation, categories, and interwiki links.

See also[fa na mbi | modifier le wikitexte]

Modèle:Documentation/doc/see also