Template:Documentation: Difference between revisions
From The Kodiak Republic Wiki
Content deleted Content added
No edit summary |
m 402 revisions imported from dev:Template:Documentation |
||
| (95 intermediate revisions by 35 users not shown) | |||
| Line 1: | Line 1: | ||
<noinclude><div style="display:none;"></noinclude><div style="border:1px solid black; margin:1em; margin-top:3em;"><div style="background:#ddd; color:#111; padding:1em; margin:0em;">'''Template documentation''' <span style="font-size:85%;">(for the above template, sometimes hidden or invisible)</span></div><div style="padding:1em; padding-bottom:0em; margin:0em;">{{{{PAGENAME}}/doc}} |
|||
<!-- |
|||
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div><noinclude></div> |
|||
Automatically add {{template sandbox notice}} when on a /sandbox page. |
|||
{{documentation}}[[Category:Template documentation| ]]</noinclude> |
|||
-->{{#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. |
|||
--> |
|||
Binary magic is: {{#if:{{{content|}}}|1|0}}{{#if:{{{1|}}}|1|0}}{{#ifexist:{{{1|}}}|1|0}}{{#ifexist:{{documentation/docspace}}:{{documentation/template page}}/doc|1|0}}{{Break}} |
|||
{{#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> |
|||
Latest revision as of 01:21, 27 December 2022
Template documentation (for the above template, sometimes hidden or invisible)
==Description==
This template is used to insert descriptions on template pages.
Syntax
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.
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 documentation page
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>{{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]]</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 template.
Visit Template:Documentation/doc to edit this text! (How does this work?)
