Difference between revisions of "Template:Documentation/doc"

From Kumu Wiki - TRU
Jump to navigation Jump to search
m (Subject namespaces vs. talk namespaces: typo fix: "messagesm" → "messages,")
m (1 revision)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE AND INTERWIKIS IN WIKIDATA -->
+
<!-- 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. 
  
This is the {{tl|documentation}} template.
+
== Usage ==
  
For most of the instructions about how and when to use this template, see [[Wikipedia:Template documentation]].
+
=== Normal /doc ===
 +
&lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}&#125;&#125;&lt;/noinclude&gt;
  
This template displays a green doc box like you are seeing now, and automatically loads the content from a /doc subpage. It can also load the content from other places if instructed to.
+
=== Any /doc page ===
 +
&lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|Template:any page/doc&#125;&#125;&lt;/noinclude&gt;
  
This template is intended for documenting templates and other pages which are [[Wikipedia:Transclusion|transcluded]] onto other pages. It can be used in template space and most other [[Wikipedia:Namespace|namespaces]].
+
=== In-line content ===
 +
&lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}|content=This is documentation.&#125;&#125;&lt;/noinclude&gt;
  
Use of this template allows templates to be [[Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation and categories.
+
=== In-line content with [view][edit] links ===
=== Usage ===
 
  
Normally this template is used without any parameters, placed at the bottom of the template or page being documented, within <code>&lt;noinclude></code>:
+
&lt;noinclude&gt;&#123;&#123;{{{template-name|Documentation}}}
 
+
|1 = Template:any page/doc
<pre>
+
|content =&#123;&#123;Template:any page/doc|parameters}}
<!--Last line of your template code--><noinclude>
+
}}&lt;/noinclude>
 
 
{{documentation}}
 
<!-- Add categories to the /doc subpage and interwikis in Wikidata, not here! -->
 
</noinclude>
 
</pre>
 
 
 
Then this template automatically loads the content from the /doc subpage of the template it is used on.
 
 
 
This template can also load the content from any other page. Like this:
 
 
 
<pre>
 
<!--Last line of your template code--><noinclude>
 
 
 
{{documentation |Template:Other page/doc}}
 
</noinclude>
 
</pre>
 
 
 
Note that when loading the documentation from another page than the local /doc page it becomes tricky to handle the categories and interwiki links.
 
 
 
The content can also be fed directly as text. Like this:
 
 
 
<pre>
 
<!--Last line of your template code--><noinclude>
 
 
 
{{documentation |content=
 
Some documentation text.
 
}}
 
</noinclude>
 
</pre>
 
 
 
When the {{para|content}} parameter is used, the doc box normally does not show the [edit] [purge] links in the top right corner. Note that if the /doc page exists a link to it is still shown in the link box below the doc box.
 
 
 
Parameter {{para|1}} and the {{para|content}} parameter can also be combined, like this:
 
 
 
<pre>
 
<!--Last line of your template code--><noinclude>
 
 
 
{{documentation
 
|1=Template:Any page/doc
 
|content=
 
{{Template:Any page/doc |parameters}}
 
}}
 
</noinclude>
 
</pre>
 
 
 
Then the pagename fed as parameter 1 is used for the [edit] [purge] links and for the /doc link in the link box below the doc box. But the '''content''' parameter is used for the content shown in the doc box. The above code means that the content is transcluded as {{tnull|Template:Any page/doc{{!}}parameters}}. In this example a parameter is also fed to the /doc page being loaded.
 
  
 
=== Best practice ===
 
=== Best practice ===
  
The code should be added at the bottom of the template code, with no space before {{tag|noinclude|o}} (which would cause extra space on pages where the template is used).
+
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.
 
 
Categories and interwiki links that apply to the template itself should be added to the bottom of the /doc subpage, inside {{tag|includeonly}} tags. For more complex cases, see [[Wikipedia:Template documentation#Categories and interwiki links]].
 
 
 
If the documentation page contains {{tag|includeonly|o}} or {{tag|noinclude|o}} tags as part of the visible documentation text, replace the "<code>&lt;</code>" with "<code>&amp;lt;</code>".
 
 
 
=== The heading ===
 
 
 
When in the Template namespace, this template shows this heading:
 
:[[File:Template-info.png|32px]] '''Template documentation'''
 
 
 
In most other namespaces, such as "Wikipedia:", it shows this heading:
 
:'''Documentation'''
 
 
 
But when on File (image) pages it shows this heading:
 
:'''Summary'''
 
 
 
The '''heading''' parameter can be used to set the heading to something else. Like this:
 
 
 
:<code><nowiki>{{documentation |heading=Infobox documentation}}</nowiki></code>
 
 
 
If the '''heading''' parameter is empty but defined, no heading is shown and no [edit] [purge] links are shown. Like this:
 
 
 
:<code><nowiki>{{documentation |heading=}}</nowiki></code>
 
 
 
The '''heading-style''' parameter can be fed optional [[Cascading Style Sheets|CSS]] values. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
 
:<code>heading-style = color: red; font-size: 150%;</code>
 
 
 
=== The link box ===
 
 
 
Below the big doc box is a small link box that shows some meta-data about the documentation. The link box shows different things depending on what parameters are fed to this template, and in which namespace it is used. In some cases the link box is not shown at all.
 
 
 
To hide the link box, add the parameter {{para|link box|off}}.
 
 
 
You can also insert customised text in the link box, by defining the {{para|link box}} parameter. For example:
 
{{para|link box|This documentation is automatically generated by [<nowiki />[Template:Country showdata]]}}
 
 
 
=== Automatic functions ===
 
 
 
If the documentation page does not exist, the [create] link includes a [[mw:Manual:Creating pages with preloaded text|preload]] page so that clicking it will pre-fill the edit form with the basic documentation page format. Preload text is also used for the /sandbox and /testcases <small>(create)</small> links.
 
 
 
When this template is on a protected template page it now automatically adds {{tl|pp-template}} which shows the grey or red padlock in the top right corner. So no need to manually add {{tlf|pp-template}} to templates that use {{tl|documentation}}.
 
 
 
When this template is on a /sandbox subpage it automatically adds the {{tl|template sandbox notice}}. If that sandbox is not a subpage of the live template, then the {{para|livepage}} parameter can be used to correctly link back to that template.
 
 
 
=== Subject namespaces vs. talk namespaces ===
 
 
 
Terminology: ''Subject namespaces'' are the opposite of ''talk namespaces''. For instance "Template:" is the subject space of "Template talk:".
 
 
 
This template is usually placed in a subject namespace, within {{tag|noinclude|o}} tags. But in some cases this template needs to be on the talk page:
 
 
 
* For preload pages (usually in Template or Wikipedia namespaces), since they cannot use {{tag|noinclude|o}}. See for instance, [[Template talk:AfC preload]] and [[Template talk:RfD subpage starter]]. Such talk pages can be marked with {{tl|talkdoc}}.
 
  
* In the Mediawiki namespace, since {{tag|noinclude|o}} often does not work in system messages, and since the Mediawiki namespace needs to be kept clean for performance reasons.
+
Categories and interwiki links that apply to the template itself should be added to the documentation page, inside <code>&lt;includeonly> &lt;/includeonly></code> tags.  For more complex cases, see [[Wikipedia:Template documentation‎#Categories and interwiki links]].
  
When placed on talk pages, this template usually is placed near the top of the page and without {{tag|noinclude}} tags.
+
If the documentation page contains includeonly or noinclude tags as part of the documentation, replace the "<" with "&amp;lt;".
  
The /doc, /sandbox and /testcases pages should normally be in the subject namespace, except in the namespaces that do not have the MediaWiki [[meta:Link#Subpage feature|subpage feature]] enabled: Main, File, Mediawiki and Category. (But currently we only show the /sandbox and /testcases links from User, User talk, Template and Template talk namespaces.) There are also a whole bunch of other technical reasons why the /doc page must be stored under the talk page for those (but only those) namespaces.
+
=== Customizing display ===
  
This template automatically points its <small>[create]</small> links for the /doc, /sandbox and /testcases to the right namespace.
+
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.
  
=== Technical details ===
+
== Functions ==
  
This template calls {{tl|documentation/start box2}} and {{tl|documentation/end box2}} which in turn call {{tl|documentation/start box}} and {{tl|documentation/end box}}. The /start box (and /end box) hold most of the code, while this template and /start box2 (and /end box2) do parameter preprocessing.
+
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.
  
The preload page for the /doc <small>[create]</small> link is [[Template:Documentation/preload]]. The preload pages for the /sandbox and /testcases <small>[create]</small> links are [[Template:Documentation/preload-sandbox]] and [[Template:Documentation/preload-testcases]].
+
== Rationale ==
  
For more technical details see the [[Template talk:Documentation|talk page]].
+
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 ===
+
== See also ==
 +
{{ Documentation/doc/see also }}
  
<!-- {{documentation/see also}} -->
+
<includeonly><!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
* {{tl|documentation}} – Placed on templates and other pages to document them.
+
[[Category:Template documentation| ]]
* {{tl|documentation subpage}} – Used at the top of /doc subpages to explain what they are and to link back to the page they document.
+
[[Category:Wikipedia formatting and function templates|Template documentation]]
* {{tl|barnstar documentation}} – Variant specifically for [[WP:BARNSTAR|barnstar]] templates
 
* [[Wikipedia:Template documentation]] – The how-to guide about template documentation.
 
* [[Wikipedia:Template test cases]] – How to use /sandbox and /testcases subpages and more about template testing.
 
  
<includeonly>
+
[[ar:قالب:توثيق]]
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+
[[bg:Шаблон:Документация]]
[[Category:Template documentation]]
+
[[ca:Plantilla:Ús de la plantilla]]
[[Category:Wikipedia formatting and function templates]]
+
[[cs:Šablona:Dokumentace]]
 +
[[da:Skabelon:Dokumentation]]
 +
[[de:Vorlage:Dokumentation]]
 +
[[dsb:Pśedłoga:Dokumentacija]]
 +
[[et:Mall:Usage of template]]
 +
[[es:Plantilla:Documentación de plantilla]]
 +
[[eo:Ŝablono:Dok]]
 +
[[fa:الگو:توضیحات]]
 +
[[fr:Modèle:Documentation modèle]]
 +
[[gl:Template:Uso de plantilla]]
 +
[[hsb:Předłoha:Doc]]
 +
[[hu:Sablon:Sablondokumentáció]]
 +
[[ia:Patrono:Docpatrono]]
 +
[[id:Templat:Dokumentasi]]
 +
[[it:Template:Man]]
 +
[[ja:Template:Documentation]]
 +
[[ko:틀:틀 설명문서]]
 +
[[no:mal:Dokumentasjon]]
 +
[[nl:Sjabloon:Sjabdoc]]
 +
[[pl:Szablon:Dokumentacja]]
 +
[[pt:Predefinição:Instruções da predefinição]]
 +
[[ro:Format:Documentaţie]]
 +
[[ru:Шаблон:Doc]]
 +
[[sl:Predloga:Dokumentacija]]
 +
[[sr:Шаблон:Документација]]
 +
[[sq:Stampa:Dokumentacion]]
 +
[[sv:Mall:Dokumentation]]
 +
[[tl:Template:Documantation]]
 +
[[tpi:Template:Template doc]]
 +
[[uk:Шаблон:Документація]]
 +
[[zh:Template:Documentation]]
 
</includeonly>
 
</includeonly>

Revision as of 14:45, 24 October 2013

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

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

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.

See also

General information about documentation for templates

{{ Documentation }} family

Meta Wiki {{ Documentation }} ancestor