Template:Documentation: Difference between revisions
(add a parameter which should allow {{Documentation}} to use any other page as documentation) |
|||
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 class="plainlinks">([[{{FULLPAGENAME}}/doc|View]] · [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} Edit] · [{{fullurl:{{FULLPAGENAME}}/doc|action=history}} History] · [{{fullurl:{{FULLPAGENAME}}|action=purge}} Purge])</span></div><div style="padding:1em; padding-bottom:0em; margin:0em;">{{ |
<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 class="plainlinks">([[{{FULLPAGENAME}}/doc|View]] · [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} Edit] · [{{fullurl:{{FULLPAGENAME}}/doc|action=history}} History] · [{{fullurl:{{FULLPAGENAME}}|action=purge}} Purge])</span></div><div style="padding:1em; padding-bottom:0em; margin:0em;">{{#if:{{{1|}}} |
||
| {{tocright}}{{{{{1|}}}}} | |
|||
#ifexist: {{FULLPAGENAME}}/doc |
{{#ifexist: {{FULLPAGENAME}}/doc |
||
| {{tocright}}{{{{PAGENAME}}/doc}} |
| {{tocright}}{{{{PAGENAME}}/doc}} |
||
| :<strong class="error">This template currently doesn't have any documentation!</strong> Help out by [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} writing some]. [[Category:Templates without documentation]] |
| :<strong class="error">This template currently doesn't have any documentation!</strong> Help out by [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} writing some]. [[Category:Templates without documentation]] |
||
}} |
}} |
||
}} |
|||
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;"><span class="plainlinks">Visit [[{{FULLPAGENAME}}/doc]] to [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit] this text! ([[Template:Documentation|How does this work]]?) ([{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this text - [[Help:Purge|why?]])</span></div></div><noinclude></div> |
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;"><span class="plainlinks">Visit [[{{FULLPAGENAME}}/doc]] to [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit] this text! ([[Template:Documentation|How does this work]]?) ([{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this text - [[Help:Purge|why?]])</span></div></div><noinclude></div> |
Latest revision as of 17:01, 7 May 2019
Description[edit source]
This template is used to insert descriptions on template pages.
Syntax[edit source]
Add <noinclude>{{documentation}}</noinclude>
at the end of the template page.
Usage[edit source]
On the Template page[edit source]
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> {{documentation}} Any categories for the template itself</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[edit source]
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}} <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.
Credits[edit source]
This template's code was taken from Template:Documentation on K6ka's Wiki on Wikia.