Revision as of 22:06, 19 December 2025 by TormentInSquallLines (talk | contribs) (Created page with "<includeonly>{| class="wikitable" style="width:100%;" |- style="font-size:18px;" ! Template documentation follows |- | ''Note: the template above may sometimes be partially or fully invisible.'' |- | Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. (How does this work?) |} <div style="margin:0 1em;"> {{tocright}} {{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}Category:Template documentation</noinclude>")
| Template documentation follows |
|---|
| Note: the template above may sometimes be partially or fully invisible. |
| Visit Template:Documentation/doc to edit this documentation. (How does this work?) |
Hey look guys, documentation for the documentation template!
Basically, if you're writing a template, it's good practice to document whatever the hell you wrote. You use the Documentation template to do so. It creates a redlink of a subpage in the format "Template:Example/doc", which you can click on and document.
I recommend you document stuff in the pattern:
- Description - Name what the template is supposed to do or accomplish, along with any similar templates, and any limitations
- Syntax - Write the available parameters and what they do
- TemplateData - The TemplateData for the template. This is really important to use the template in the visual editor.
- Examples - Examples of the template in different contexts and any tips to using it
Make sure you add the Category:Template documentation category and <noinclude> it or else it will categorize the main template page.