Created page with "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..." |
No edit summary |
||
| Line 8: | Line 8: | ||
* TemplateData - The TemplateData for the template. This is really important to use the template in the visual editor. | * 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 | * Examples - Examples of the template in different contexts and any tips to using it | ||
Make sure you add the [[:Category:Template documentation]] category and <nowiki><noinclude></nowiki> it or else it will categorize the main template page. | |||
<noinclude>[[Category:Template documentation]]</noinclude> | |||
Latest revision as of 22:16, 19 December 2025
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.