Difference between revisions of "Template:Doc"

From TerraFirmaCraft Wiki
Jump to: navigation, search
m (1 revision)
 
Line 1: Line 1:
{{doc/start}}
+
<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;">
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.
+
{{{{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:Doc|How does this work]]?)</div></div><noinclude></div>
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]].
+
{{/doc}}[[Category:Template documentation| ]]</noinclude>
 
+
== Optional parameters ==
+
=== clear ===
+
If your main template page has floating content and you would like to stop it going over the documentation, put {{tl|doc/start|clear}} instead of {{tl|doc/start}} on your documentation page.<br />
+
This is also useful for templates not using &lt;includeonly&gt;, as it will put some space between the template and the documentation box.
+
 
+
=== nodoc=1 ===
+
If a template has no documentation and you don't know how to use it, put {{tl|doc/start|nodoc{{=}}1}} (or if the template needs clear as well, {{tl|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>
+
 
+
[[Category:Documentation templates|*]]<noinclude>
+
</noinclude>
+

Revision as of 21:08, 16 May 2014

Template documentation (for the above template, sometimes hidden or invisible)
Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>{{Doc}}</noinclude> at the end of the template page.

General usage

On the Template page

<includeonly>Template code and Any categories to be inserted into articles by the template</includeonly><noinclude>
{{doc}}</noinclude>


The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

;Description
:This template is used to do something.
;Syntax
:Type <code></code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}

<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 further usage information sections.



Visit Template:Doc/doc to edit this text! (How does this work?)
Template documentation (for the above template, sometimes hidden or invisible)
Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>{{Doc}}</noinclude> at the end of the template page.

General usage

On the Template page

<includeonly>Template code and Any categories to be inserted into articles by the template</includeonly><noinclude>
{{doc}}</noinclude>


The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

;Description
:This template is used to do something.
;Syntax
:Type <code></code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}

<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 further usage information sections.



Visit Template:Doc/doc to edit this text! (How does this work?)