Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
Chrysophylax (talk | contribs) m (1 revision: Subpage listing) |
Chrysophylax (talk | contribs) m (1 revision: Portal data) |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
< | <!-- | ||
{{{ | Automatically add {{template sandbox notice}} when on a /sandbox page. | ||
</ | -->{{#ifeq: {{SUBPAGENAME}} | sandbox | ||
{{ | | <div style="clear: both;"></div>{{template sandbox notice|{{{livepage|}}}}} | ||
}}<!-- | |||
Automatically add {{pp-template}} to protected templates. | |||
-->{{template other | |||
| {{#ifeq: {{PROTECTIONLEVEL:move}} | sysop | |||
| {{pp-template|docusage=yes}} | |||
| {{#if: {{PROTECTIONLEVEL:edit}} | |||
| {{pp-template|docusage=yes}} | |||
| <!--Not protected, or only semi-move-protected--> | |||
}} | |||
}} | |||
}}<!-- | |||
Start of green doc box. | |||
-->{{documentation/start box2 | |||
| preload = {{{preload|}}} <!--Allow custom preloads--> | |||
| heading = {{{heading|¬}}} <!--Empty but defined means no header--> | |||
| heading-style = {{{heading-style|}}} | |||
| content = {{{content|}}} | |||
<!--Some namespaces must have the /doc, /sandbox and /testcases | |||
in talk space--> | |||
| docspace = {{documentation/docspace}} | |||
| 1 = {{{1|}}} <!--Other docname, if fed--> | |||
<!--The namespace is added in /start box2--> | |||
| template page = {{documentation/template page}} | |||
}}<!-- Start content --><!-- | |||
Start load the /doc content: | |||
Note: The line breaks between this comment and the next line are necessary | |||
so "=== Headings ===" at the start and end of docs are interpreted. | |||
--> | |||
{{#switch: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}} | |||
| 1000 | 1001 | 1010 | 1011 | 1100 | 1101 | 1110 | |||
| 1111 = {{{content|}}} | |||
| 0110 | 0111 = {{ {{{1}}} }} | |||
| 0001 | 0011 = {{ {{documentation/docspace}}:{{documentation/template page}}/doc }} | |||
| 0000 | 0100 | 0010 | 0101 = | |||
}} | |||
<!-- | |||
End load the /doc content: | |||
Note: The line breaks between this comment and the previous line are necessary | |||
so "=== Headings ===" at the start and end of docs are interpreted. | |||
-->{{documentation/end box2 | |||
| preload = {{{preload|}}} <!--Allow custom preloads--> | |||
| content = {{{content|}}} | |||
| link box = {{{link box|}}} <!--So "link box=off" works--> | |||
<!--Some namespaces must have the /doc, /sandbox and /testcases | |||
in talk space--> | |||
| docspace = {{documentation/docspace}} | |||
| 1 = {{{1|}}} <!--Other docname, if fed--> | |||
<!--The namespace is added in /end box2--> | |||
| template page = {{documentation/template page}} | |||
}}<!-- | |||
End of green doc box | |||
--><noinclude> | |||
<!-- Add categories and interwikis to the /doc subpage, not here! --> | |||
</noinclude> | |||
Revision as of 01:11, 1 September 2013
Template documentation- Description
- This template is used to insert descriptions on template pages.
- Syntax
- Type
<noinclude>{{documentation}}</noinclude>at the end of the template page.
General usage
On the Template page
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).
The line break is also useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
;Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.
Note that the above example also uses the Template:T and Template:T/piece templates.
| The above documentation is transcluded from Template:Documentation/doc. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |