Difference between revisions of "Lylat Wiki:Template Standards"

no edit summary
Line 19: Line 19:
Section headers <nowiki>===</nowiki>), then that section header is not only subject to these guidelines, but also to the guidelines that the receiving page(s) are under.  
Section headers <nowiki>===</nowiki>), then that section header is not only subject to these guidelines, but also to the guidelines that the receiving page(s) are under.  


For more, please see: [[Lylat Wiki:Section Standards]].
For more, please see: [[Lylat Wiki:Section Standards]].


=== Tables ===
=== Tables ===
Line 30: Line 30:
On the actual documentation page, we recommend you put the following:  
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.
* 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.   
* The two sections:  Purpose and Usage.   


=== Documentation Shell ===
=== Documentation Shell ===
{{templates-table-top}}
{{templates-table-top}}
|-
|-
| [[Template:documentation shell|documentation shell]]
| [[Template:documentation shell|documentation shell]]
Line 54: Line 53:
==Purpose==
==Purpose==
==Usage==
==Usage==
===Example===
<pre>
{{Template Name
| param 1 =
| param 2 =
| param 3 =
}}
&lt;/pre> <!-- note: use an actual less than sign than the html equailavent &amp;lt; -->
=== Parameters ===
=== Parameters ===
{{Parameters-table-top}}
{{Parameters-table-top}}
Line 65: Line 73:
{{parameters-table-bottom}}
{{parameters-table-bottom}}
|}  
|}  
==Example==
<pre>
{{Template Name
| param 1 =
| param 2 =
| param 3 =
}}
&lt;/pre> <!-- note: use an actual less than sign than the html equailavent &amp;lt; -->
<includeonly>
<!-- cats -->
</includeonly>
<noinclude>[[Category:Documentation|{{PAGENAME}}]]</noinclude></pre>
<noinclude>[[Category:Documentation|{{PAGENAME}}]]</noinclude></pre>