|
|
| (80 intermediate revisions by 36 users not shown) |
| Line 1: |
Line 1: |
| − | <noinclude>
| + | {{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}<noinclude> |
| − | {{ #ifeq: {{SUBPAGENAME}} | sandbox
| + | <!-- Categories go on the /doc subpage, and interwikis go on Wikidata. --> |
| − | | {{Template sandbox notice}}
| + | </noinclude> |
| − | | {{pp-semi-template|small=yes}}
| |
| − | }}
| |
| − | {{intricate}}
| |
| − | {{ | |
| − | #ifeq: {{FULLPAGENAME}} | Template:Documentation |
| |
| − | <!-- Moved to: Template:Documentation, template
| |
| − | {{Mergingfrom|Template doc|date=November 2007}}
| |
| − | [[User:ConradPino]] 21:45, 9 November 2007 (UTC)
| |
| − | -->
| |
| − | }}
| |
| − | </noinclude><div class="template-documentation">{{
| |
| − | #if: {{{heading|Documentation}}}
| |
| − | |<!-- has heading --><div style="padding-bottom: {{{heading-padding|3px}}}; border-bottom: 1px solid #aaa; margin-bottom: {{{heading-margin|1ex}}}"><span class="editsection plainlinks" id="doc_editlinks">{{
| |
| − | #ifexist: {{{1|{{Documentation/docname}}}}}
| |
| − | |<!-- /doc exists -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}}} view]] [[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit]]
| |
| − | |<!-- no /doc -->{{
| |
| − | #if: {{{content|}}}
| |
| − | |<!-- has content -->
| |
| − | |<!-- no content -->[[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit&preload={{{preload-doc|Template:Documentation/preload}}}}} edit]]
| |
| − | }}
| |
| − | }}</span> <span style="{{{heading-style|font-size: 150%}}}">{{{heading|Documentation}}}</span></div>
| |
| − | |<!-- empty heading -->
| |
| − | }}<div id="template_doc_page_transcluded" class="dablink plainlinks">{{
| |
| − | #ifeq: {{{transcluded|show}}} | show
| |
| − | |<!-- transcluded show -->{{
| |
| − | #ifexist: {{{1|{{Documentation/docname}}}}}
| |
| − | |<!-- /doc exists -->This [[Wikipedia:Template documentation|documentation]] is [[Wikipedia:Transclusion|transcluded]] from [[{{{1|{{Documentation/docname}}}}}]]. <small style="font-style: normal">(<!--[[{{{1|{{Documentation/docname}}}}}|view]] | -->[{{fullurl:{{{1|{{Documentation/docname}}}}}|action=edit}} edit] | [{{fullurl:{{{1|{{Documentation/docname}}}}}|action=history}} history])</small><br />
| |
| − | |<!-- no /doc -->
| |
| − | }}
| |
| − | |<!-- transcluded hide -->
| |
| − | }}{{
| |
| − | #switch: {{SUBPAGENAME}}
| |
| − | |sandbox=<!-- sandbox -->
| |
| − | |testcases=<!-- testcases -->
| |
| − | |#default={{
| |
| − | #switch: {{SUBJECTSPACE}}/{{{sandbox-testcases|show}}}
| |
| − | |{{ns:template}}/show|{{ns:user}}/show=<!-- show /sandbox /testcases -->This template has {{
| |
| − | #ifexist: {{ #rel2abs: /sandbox }}
| |
| − | |<!-- /sandbox -->a [[/sandbox|sandbox]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /sandbox }}|action=edit}} edit])</small> {{
| |
| − | #ifexist: {{ #rel2abs: /testcases }}
| |
| − | |<!-- /sandbox AND /testcases -->and [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>
| |
| − | |<!-- /sandbox AND no /testcases -->but '''no''' [{{fullurl:{{ #rel2abs: /testcases }}|action=edit&preload={{{preload-testcases|Template:Documentation/preload/testcases}}}}} testcases]
| |
| − | }}
| |
| − | |<!-- no /sandbox -->'''no''' [{{fullurl:{{ #rel2abs: /sandbox }}|action=edit&preload={{{preload-sandbox|Template:Documentation/preload/sandbox}}}}} sandbox] {{
| |
| − | #ifexist: {{ #rel2abs: /testcases }}
| |
| − | |<!-- no /sandbox AND /testcases -->but has [[/testcases|testcases]] <small style="font-style: normal">([{{fullurl:{{ #rel2abs: /testcases }}|action=edit}} edit])</small>
| |
| − | |<!-- no /sandbox AND no /testcases -->and '''no''' [{{fullurl:{{ #rel2abs: /testcases }}|action=edit&preload={{{preload-testcases|Template:Documentation/preload/testcases}}}}} testcases]
| |
| − | }}
| |
| − | }} for editors to experiment.
| |
| − | |<!-- hide /sandbox /testcases -->
| |
| − | }}
| |
| − | }}</div>
| |
| − | {{{content|{{ {{ #ifexist: {{{1|{{Documentation/docname}}}}} | {{{1|{{Documentation/docname}}}}} | ns:0 }} }}}}}
| |
| − | </div>
| |
Description[edit]
This template is used to insert descriptions on template pages.
Add <noinclude>{{Documentation}}</noinclude> at the end of the template page.
Add <noinclude>{{Documentation|documentation page}}</noinclude> to transclude an alternative page from the /doc subpage.
On the Template page[edit]
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 documentation page[edit]
The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see Syntax).
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>{{Documentation}}</code> somewhere.
==Samples==
<code><nowiki>{{Documentation|input}}</nowiki></code>
results in...
{{Documentation|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.
Template documentation