Template:Documentation: Difference between revisions
m (7 revisions from en:Template:Documentation: Requested by Rifleman_82 on IRC. Overwriting some templates but should be okay.) |
(Revert my import, oops) |
||
Line 1: | Line 1: | ||
<div class="template-documentation" style="margin-top:1em; clear: both; border: 2px dotted #666666; padding: 0.6em; background-color: #f5f5f5;">{{#if:{{{heading|defaultnotblank}}}|<div style="padding-bottom:3px; border-bottom:1px solid #aaa; margin-bottom:1ex;"> |
|||
<!-- |
|||
<span class="editsection plainlinks" id="doc_editlinks">[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]]</span> |
|||
Automatically add {{template sandbox notice}} when on a /sandbox page. |
|||
<span style="font-size:150%">{{{heading|Documentation}}}</span></div>}} |
|||
-->{{#ifeq: {{SUBPAGENAME}} | sandbox |
|||
<div id="template_doc_page_transcluded" class="dablink plainlinks">This [[w:Wikipedia:Template documentation|documentation]] is [[w:Wikipedia:Transclusion|transcluded]] from [[{{{1|{{FULLPAGENAME}}/doc}}}]]. <small>''([[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]] | [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit] | [{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=history}} history])''</small></div> |
|||
⚫ | |||
{{{{{1|{{SUBJECTPAGENAME}}/doc}}}}} |
|||
}}<!-- |
|||
⚫ | |||
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 04:05, 15 June 2011
[edit]
DocumentationDescription
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude>
at the end of the template page.
Usage
On the Template page
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> {{documentation}}</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}}
is inserted (within the noinclude tags).
A line break right before {{documentation}}
can also be useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
Normally, you will want to write something like the following on the documentation page:
==Description== This template is used to do something. ==Syntax== Type <code>{{t|templatename}}</code> somewhere. ==Samples== <code><nowiki>{{templatename|input}}</nowiki></code> results in... {{templatename|input}} <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 other sections.
Note that the above example also uses the Template:T and Template:T/piece templates.