Welcome to the SaGa Wiki! We have moved off Fandom very recently, so things are still being set up around here. Please note that some images did not successfully transfer, and will need to be manually reuploaded or replaced.
Note: Keep in mind that once you have an account, you must wait one day and make 5 edits to become autoconfirmed. This allows you to skip questions while editing, to create new articles, and to upload images.
Difference between revisions of "Template:Documentation"
gkDefault (talk) m |
gkKirkburn (talk) m (25 revisions) |
||
| 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 style="font-size:85%;">(for the above | <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 template shown above, sometimes hidden or invisible)</span></div><div style="padding:1em; padding-bottom:0em; margin:0em;">{{tocright}} | ||
{{{{PAGENAME}}/doc}} | {{{{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:Documentation|How does this work]]?)</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;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div><noinclude></div> | ||
{{documentation}} | {{documentation}}</noinclude> | ||
Latest revision as of 22:38, December 31, 2008
- Description
- This template is used to insert descriptions on template pages.
- Syntax
- Type
<noinclude>{{documentation}}</noinclude>at the end of the template page.
General usage[edit]
On the Template page[edit]
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).
The line break is also useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page[edit]
;Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</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.
Note that the above example also uses the Template:T and Template:T/piece templates.
