Difference between revisions of "Template:Doc"

From Mystcraft
Jump to: navigation, search
(<default import>)
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
<noinclude>{{doc/start}}
+
<div class="plainlinks" style=" clear: both; margin: 1em 0 0 0; border: 1px solid #aaa; background-color: #ecfcf4; padding: 5px; {{border radius|.4em}}">
−
To use, create a sub-page from the template called '''doc''', put {{tl|doc/start}} at the start of your documentation, and {{tl|doc/end}} at the end.
+
<h2><span style="float: right; font-size: small">
−
 
+
([[{{{1|{{FULLPAGENAME}}/doc}}}|<span title="View this documentation">view</span>]] - {{
−
Go back to your main template page and put &lt;noinclude&gt;{{tl|doc}}&lt;/noinclude&gt; on a newline after the end of the template. /doc pages will automatically be added to [[:Category:Documentation templates]].
+
#ifexist:{{{1|{{TALKSPACE}}:{{PAGENAME}}}}}/doc|[[{{{1|{{TALKSPACE}}:{{PAGENAME}}}}}/doc|<span title="Discuss this documentation">talk</span>]] -&nbsp;
−
 
+
}}[{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} <span title="Edit this documentation">edit</span>] -
−
== Optional parameters ==
+
[{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=history}} <span title="Documentation history">history</span>] -
−
=== clear ===
+
[{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=purge}} <span title="Purge this documentation (causes it to be updated; use only if it doesn't update after editing, NOT in a preview)">purge</span>])</span> Documentation</h2>
−
If your main template page has floating content and you would like to stop it going over the documentation, put {{tlx|doc/start|clear}} instead of {{tl|doc/start}} on your documentation page.<br>
+
__NOTOC__ __NOEDITSECTION__
−
This is also useful for templates not using &lt;includeonly&gt;, as it will put some space between the template and the documentation box.
+
{{ {{{1|{{FULLPAGENAME}}/doc}}} }}
−
 
 
−
=== nodoc=1 ===
 
−
If a template has no documentation and you don't know how to use it, put {{tlx|doc/start|nodoc{{=}}1}} (or if the template needs clear as well, {{tlx|doc/start|clear|nodoc{{=}}1}}) instead of {{tl|doc/start}} on your documentation page.<br>
 
−
The documentation's background will become red to make it more noticeable, and the page will be added to [[:Category:Templates with no documentation]].
 
−
 
 
−
=== baddoc=1 ===
 
−
Similar to nodoc, this is used to mark templates that '''do''' have documentation, but it isn't very good. This can mean it doesn't have enough examples, doesn't explain all the functions properly, or doesn't explain the point of the template properly.<br>
 
−
The documentation's background will become yellow to make it more noticeable, and the page will be added to [[:Category:Templates with bad documentation]].
 
−
 
 
−
If both nodoc and baddoc are specified, baddoc will be ignored.
 
 
</div>
 
</div>
−
 
+
{{#if:{{{nocat|}}}||[[Category:Templates]]}}
−
[[Category:Documentation templates| ]]
 
−
</noinclude><includeonly>{{/doc}}</includeonly>
 

Latest revision as of 16:50, 24 May 2018

(view - edit - history - purge) Documentation

This template is intended for basic use on documentation. For more control over appearance, use Template:Docbox.

This template displays documentation on templates. Pages using this template will automatically be added to Category:Templates, unless the nocat= parameter is specified with a non-blank value.

Usage

Normal template contents<noinclude>{{documentation}}</noinclude>

Documentation goes on "Template:(template name)/doc"

Retrieved from "http://wiki.mystcraft.xcompwiz.com/index.php?title=Template:Doc&oldid=231"