Template:Documentation/Doc: Difference between revisions
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
In general, the documentation should not be part of the template itself, thus you might want to do follow this general pattern: | In general, the documentation should not be part of the template itself, thus you might want to do follow this general pattern: | ||
< | {{code|lang=mediawiki|line=no|highlight=3| | ||
< | <<nowiki>includeonly</nowiki>> | ||
<!-- Template-specific code --> | <!<nowiki>-- Template-specific code --</nowiki>> | ||
</includeonly><noinclude>{{Documentation}}</noinclude | </includeonly><<nowiki>noinclude</nowiki>><nowiki>{{Documentation}}</nowiki></<nowiki>noinclude</nowiki>> | ||
</ | }} | ||
=== Writing the documentation === | === Writing the documentation === | ||
| Line 17: | Line 17: | ||
Keep in mind that all documentation headings should be one level lower than what you'd normally write, because the heading ''Template Documentation'' is a level 2 header already. For example, a documentation outline might be: | Keep in mind that all documentation headings should be one level lower than what you'd normally write, because the heading ''Template Documentation'' is a level 2 header already. For example, a documentation outline might be: | ||
{{code|line=no|lang=mediawiki| | |||
Some introduction text... | Some introduction text... | ||
| Line 31: | Line 31: | ||
Any technical information about the template's implementation under the hood... | Any technical information about the template's implementation under the hood... | ||
</ | }} | ||
<includeonly> | |||
=== Template data === | |||
<templatedata> | |||
{ | |||
"description": "Provide documentation for a template, under the /Doc subpage", | |||
"params": {} | |||
} | |||
</templatedata> | |||
Latest revision as of 14:20, 11 June 2025
This template is used for providing documentation for templates. It will "grab" the documentation from the /Doc subpage under the template it's used for. For example, using it on Template:Documentation would grab the documentation from Template:Documentation/Doc.
Usage
In general, the documentation should not be part of the template itself, thus you might want to do follow this general pattern:
<includeonly>
<!-- Template-specific code -->
</includeonly><noinclude>{{Documentation}}</noinclude>
Writing the documentation
It is generally a good idea to write the documentation before applying this template to the page you are working on. In this way, you're avoiding displaying the missing red link for anyone while your work is in progress.
Keep in mind that all documentation headings should be one level lower than what you'd normally write, because the heading Template Documentation is a level 2 header already. For example, a documentation outline might be:
Some introduction text...
=== Usage ===
Information about how to use your template...
=== Parameters ===
Available options and parameters...
=== Technical details ===
Any technical information about the template's implementation under the hood...