Difference between revisions of "Modèle:Documentation/doc"

From Wazeopedia
m (Created redirect)
 
(Page créée avec « <noinclude>{{Documentation subpage}}</noinclude><!-- This Doc subpage format with noinclude tags is unique to this page --> This template automatically displays a do... »)
 
Line 1: Line 1:
#REDIRECT [[Cameras]]
+
<noinclude>{{Documentation subpage}}</noinclude><!--
 +
  This Doc subpage format with noinclude tags is unique to this page
 +
  -->
 +
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.
 +
 
 +
==Usage==
 +
===Normal===
 +
<pre>
 +
&lt;noinclude&gt;{{documentation}}&lt;/noinclude&gt;
 +
- or -
 +
&lt;noinclude&gt;{{doc}}&lt;/noinclude&gt;
 +
- or -
 +
&lt;noinclude&gt;{{documentation|template:any page/doc}}&lt;/noinclude&gt;
 +
</pre>
 +
 
 +
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.
 +
 
 +
Add categories and interwiki links to the documentation page inside <code>&lt;includeonly&gt;</code> tags.
 +
 
 +
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&amp;lt;", and the ">" with "&amp;gt;.
 +
 
 +
===Customizing display===
 +
Overrides exist to customize the output in special cases:
 +
* <code><nowiki>{{</nowiki>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.
 +
* <code><nowiki>{{</nowiki>documentation|'''content'''=}}</code>: for extremely simple documentation notes, enter the message desired with the {{para|content}} parameter. The text provided with this parameter appears in a box similar to the doc subpage, without any other notations in the boxes. For more complex documentation descriptions, use a full doc subpage.
 +
 
 +
==Functions==
 +
If the documentation page doesn't exist, the "edit" link includes a [http://www.mediawiki.org/wiki/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==
 +
This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a [http://en.wikipedia.org/wiki/Wikipedia:Template_limits technical limitation of templates] (see a [{{fullurl:en:Project:Village pump (technical)|diff=prev&oldid=69888944}} developer's explanation]).
 +
 
 +
 
 +
<includeonly>
 +
<!-- ADD CATEGORIES BELOW THIS LINE -->
 +
[[Category:Template:Documentation]]
 +
 
 +
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 +
</includeonly>

Latest revision as of 01:39, 13 November 2019

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

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

Normal

<noinclude>{{documentation}}</noinclude>
 - or -
<noinclude>{{doc}}</noinclude>
 - or -
<noinclude>{{documentation|template:any page/doc}}</noinclude>

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.

Add categories and interwiki links to the documentation page inside <includeonly> tags.

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

Customizing display

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.
  • {{documentation|content=}}: for extremely simple documentation notes, enter the message desired with the |content= parameter. The text provided with this parameter appears in a box similar to the doc subpage, without any other notations in the boxes. For more complex documentation descriptions, use a full doc subpage.

Functions

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

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. It also reduces server resources by circumventing a technical limitation of templates (see a developer's explanation).