Changes
Jump to navigation
Jump to search
create documentation for new template, based on documentation at Template:Template category/doc
{{Documentation subpage}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{tl|Module category}} can be placed at the top of categories that contain module pages and related subcategories.
{{TOC limit|3}}
== Usage ==
===Full syntax===
<pre style="overflow:auto;">
{{Module category
| topic =
| description =
| help =
}}
</pre>
===Parameters===
The template may be used without any parameters, i.e. as {{tc|Module category}}.
{{Hidden begin |showhide=left |title=Example: no parameters |bodystyle=font-size:105%;}}
{{Module category}}
{{Hidden end}}
The following parameters may be used to make the template more informative.
====''topic''====
<hr/>
: Use ''topic'' to add a description ending "...relating to ''topic''".
{{Hidden begin |showhide=left |title=Example: ''topic'' |bodystyle=font-size:105%;}}
<pre>{{Module category |topic=''topic''}}</pre>
{{Module category |topic=''topic''}}
{{Hidden end}}
====''description''====
<hr/>
: Use ''description'' to add a description in place of – or in addition to – the ''topic'' description above.
{{Hidden begin |showhide=left |title=Example: ''description'' |bodystyle=font-size:105%;}}
<pre>{{Module category |description=This text is supplied by the ''description'' parameter.}}</pre>
{{Module category |description=This text is supplied by the ''description'' parameter.}}
{{Hidden end}}
{{Hidden begin |showhide=left |title=Example: ''topic'' and ''description'' |bodystyle=font-size:105%;}}
<pre style="overflow:auto;">
{{Module category
| topic = ''topic''
| description = ''description''
}}
</pre>
{{Module category
| topic = ''topic''
| description = ''description''
}}
{{Hidden end}}
====''help''====
<hr/>
: Use ''help'' to replace the instructions on adding a module to the category (second paragraph of the "Further module category notes" section). To omit the default instructions, set ''help'' to [[Template:If declined|''false'', ''no'', etc.]]
{{Hidden begin |showhide=left |title=Example: replace ''help'' text |bodystyle=font-size:105%;}}
<pre>{{Module category |help=This text supplied by the ''help'' parameter.}}</pre>
{{Module category |help=This text supplied by the ''help'' parameter.}}
{{Hidden end}}
{{Hidden begin |showhide=left |title=Example: omit ''help'' text |bodystyle=font-size:105%;}}
<pre>{{Module category |help=no}}</pre>
{{Module category |help=no}}
{{Hidden end}}
== See also ==
{{Other category-header templates}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Category namespace templates]]
}}</includeonly>
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{tl|Module category}} can be placed at the top of categories that contain module pages and related subcategories.
{{TOC limit|3}}
== Usage ==
===Full syntax===
<pre style="overflow:auto;">
{{Module category
| topic =
| description =
| help =
}}
</pre>
===Parameters===
The template may be used without any parameters, i.e. as {{tc|Module category}}.
{{Hidden begin |showhide=left |title=Example: no parameters |bodystyle=font-size:105%;}}
{{Module category}}
{{Hidden end}}
The following parameters may be used to make the template more informative.
====''topic''====
<hr/>
: Use ''topic'' to add a description ending "...relating to ''topic''".
{{Hidden begin |showhide=left |title=Example: ''topic'' |bodystyle=font-size:105%;}}
<pre>{{Module category |topic=''topic''}}</pre>
{{Module category |topic=''topic''}}
{{Hidden end}}
====''description''====
<hr/>
: Use ''description'' to add a description in place of – or in addition to – the ''topic'' description above.
{{Hidden begin |showhide=left |title=Example: ''description'' |bodystyle=font-size:105%;}}
<pre>{{Module category |description=This text is supplied by the ''description'' parameter.}}</pre>
{{Module category |description=This text is supplied by the ''description'' parameter.}}
{{Hidden end}}
{{Hidden begin |showhide=left |title=Example: ''topic'' and ''description'' |bodystyle=font-size:105%;}}
<pre style="overflow:auto;">
{{Module category
| topic = ''topic''
| description = ''description''
}}
</pre>
{{Module category
| topic = ''topic''
| description = ''description''
}}
{{Hidden end}}
====''help''====
<hr/>
: Use ''help'' to replace the instructions on adding a module to the category (second paragraph of the "Further module category notes" section). To omit the default instructions, set ''help'' to [[Template:If declined|''false'', ''no'', etc.]]
{{Hidden begin |showhide=left |title=Example: replace ''help'' text |bodystyle=font-size:105%;}}
<pre>{{Module category |help=This text supplied by the ''help'' parameter.}}</pre>
{{Module category |help=This text supplied by the ''help'' parameter.}}
{{Hidden end}}
{{Hidden begin |showhide=left |title=Example: omit ''help'' text |bodystyle=font-size:105%;}}
<pre>{{Module category |help=no}}</pre>
{{Module category |help=no}}
{{Hidden end}}
== See also ==
{{Other category-header templates}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Category namespace templates]]
}}</includeonly>
