Template:Module category/doc

{{Module category}} can be placed at the top of categories that contain module pages and related subcategories.

Usage

Full syntax

{{Module category
| topic = 
| description = 
| help = 
}}

Parameters

The template may be used without any parameters, i.e. as {{Module category}}.

Example: no parameters

The pages listed in this category are Lua modules. This page is part of Wikipedia's administration and not part of the encyclopedia. Further module category notes This category contains pages in the module namespace. It should not be used to categorize articles or pages in other namespaces. To add a module to this category: In the documentation page (usually named "Module:Name/doc"), add  [[Template:Module category/doc]] to the <includeonly> section at the bottom of that page.

The following parameters may be used to make the template more informative.

topic

---

Use topic to add a description ending "...relating to topic".

Example: topic

{{Module category |topic=''topic''}}

Modules relating to topic.

The pages listed in this category are Lua modules. This page is part of Wikipedia's administration and not part of the encyclopedia. Further module category notes This category contains pages in the module namespace. It should not be used to categorize articles or pages in other namespaces. To add a module to this category: In the documentation page (usually named "Module:Name/doc"), add  [[Template:Module category/doc]] to the <includeonly> section at the bottom of that page.

description

---

Use description to add a description in place of – or in addition to – the topic description above.

Example: description

{{Module category |description=This text is supplied by the ''description'' parameter.}}

This text is supplied by the description parameter.

The pages listed in this category are Lua modules. This page is part of Wikipedia's administration and not part of the encyclopedia. Further module category notes This category contains pages in the module namespace. It should not be used to categorize articles or pages in other namespaces. To add a module to this category: In the documentation page (usually named "Module:Name/doc"), add  [[Template:Module category/doc]] to the <includeonly> section at the bottom of that page.

Example: topic and description

{{Module category
| topic = ''topic''
| description = ''description''
}}

Modules relating to topic. description

The pages listed in this category are Lua modules. This page is part of Wikipedia's administration and not part of the encyclopedia. Further module category notes This category contains pages in the module namespace. It should not be used to categorize articles or pages in other namespaces. To add a module to this category: In the documentation page (usually named "Module:Name/doc"), add  [[Template:Module category/doc]] to the <includeonly> section at the bottom of that page.

help

---

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 false, no, etc.

Example: replace help text

{{Module category |help=This text supplied by the ''help'' parameter.}}

The pages listed in this category are Lua modules. This page is part of Wikipedia's administration and not part of the encyclopedia. Further module category notes This category contains pages in the module namespace. It should not be used to categorize articles or pages in other namespaces. This text supplied by the help parameter.

Example: omit help text

{{Module category |help=no}}

The pages listed in this category are Lua modules. This page is part of Wikipedia's administration and not part of the encyclopedia. Further module category notes This category contains pages in the module namespace. It should not be used to categorize articles or pages in other namespaces.