Template:Documentation/doc: Difference between revisions

Latest revision as of 01:41, 21 January 2014

This is a documentation subpage for Template:Documentation (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template 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, e.g. templates, whether in the template namespace or not.

Usage

Normal /doc

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

Any /doc page

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

In-line content

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

In-line content with [view][edit] links

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

Best practice

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> </includeonly> tags.

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

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.

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

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

@@ Line 1: / Line 1: @@
 {{documentation subpage}}__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.
+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, e.g. templates, whether in the template namespace or not.
-==Usage==
+== Usage ==
-===Normal /doc===
+=== Normal /doc ===
-  &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}&#125;&#125;&lt;/noinclude&gt;
+  <nowiki><noinclude>{{Documentation}}</noinclude></nowiki>
-===Any /doc page===
+=== Any /doc page ===
-  &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|Template:any page/doc&#125;&#125;&lt;/noinclude&gt;
+  <nowiki><noinclude>{{Documentation|Template:any page/doc}}</noinclude></nowiki>
-===In-line content===
+=== In-line content ===
-  &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|content=This is documentation.&#125;&#125;&lt;/noinclude&gt;
+  <nowiki><noinclude>{{Documentation|content=This is documentation.}}</noinclude></nowiki>
-===In-line content with [view][edit] links===
+=== In-line content with [view][edit] links ===
-  &lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}
+  <nowiki><noinclude>{{Documentation
   |1 = Template:any page/doc
-  |content =&#123;&#123;Template:any page/doc|parameters}}
+  |content ={{Template:any page/doc|parameters}}
-  }}&lt;/noinclude>
+  }}</noinclude></nowiki>
-===Best practice===
+=== Best practice ===
 This code should be added at the bottom of the template code, with no extra space before "<code>&lt;noinclude></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.
@@ Line 30: / Line 30: @@
 If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&amp;lt;".
-===Customizing display===
+=== Customizing display ===
 Overrides exist to customize the output in special cases:
-* <code>{&#123;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==
+* <code><nowiki>{{documentation| '''heading''' = ...}}</nowiki></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 [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==
+== 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.
 <includeonly>
-[[Category:Template Construction Templates]]
+[[Category:Template Documentation]]
 </includeonly>