9,793
edits
Difference between revisions of "Lylat Wiki:Template Standards"
Lylat Wiki:Template Standards (view source)
Revision as of 23:43, 15 April 2010
, 23:43, 15 April 2010→Documentation
| Line 21: | Line 21: | ||
== Documentation == | == Documentation == | ||
=== | Each template should have some kind of documentation telling you how to use it. | ||
In order to generate a documentation page, place <nowiki><noinclude>{{doc}}</noinclude></nowiki> at the very bottom of the template, and a <code>/doc</code> red link will show up when you save. Click this link to go to the documentation subpage. | |||
On the actual documentation page, we recommend you put the following: | |||
* a Documentation Shell, which is intended to provide easier access to the template page, the name of the template, and related templates. | |||
* The three sections: Purpose, usage and example. | |||
=== Documentation Shell === | |||
{| class="wikitable" | |||
|+ | |||
|- | |||
! Title | |||
! sample | |||
! usage <sup>See [[#doc_1]]</sup> | |||
|- | |||
| [[Template:documentation shell|documentation shell]] | |||
| | |||
<pre> | <pre> | ||
{{documentation shell | {{documentation shell | ||
| name = | | name = | ||
| info = | | info = | ||
| see also = | | see also = | ||
}} | }} | ||
</pre> | </pre> | ||
| Use this template for all characters. | |||
|- | |||
{{parameters-table-bottom}} | |||
|} | |||
=== Sections === | === Sections === | ||
<pre> | <pre> | ||
| Line 39: | Line 60: | ||
! Name | ! Name | ||
! Description | ! Description | ||
! Values-Related Stuff <!-- for if anything happens becuase a specific value related is not entered | ! Values-Related Stuff<sup>See [[#doc_1]]</sup> <!-- for if anything happens becuase a specific value related is not entered | ||
|- | |- | ||
| <!-- one row per paramter --> | | <!-- one row per paramter --> | ||
| Line 46: | Line 67: | ||
|- | |- | ||
{{parameters-table-bottom}} | {{parameters-table-bottom}} | ||
Required Parameters are in bold, followed by explanation of usage. | |||
|} | |} | ||
| Line 53: | Line 76: | ||
</includeonly> | </includeonly> | ||
<noinclude>[[Category:Documentation]]</noinclude></pre> | <noinclude>[[Category:Documentation]]</noinclude></pre> | ||
== Maintenance == | == Maintenance == | ||
== Actions == | == Actions == | ||