Module:Cat main/doc

This module produces hatnote saying "The main article for this category is x." It implements the cat main template.

Use from wikitext
This module should usually be used via the cat main template. However, it can also be used from #invoke with the syntax. Please see the cat main template documentation for available parameters.

Use from other Lua modules
Load the module:

You can then use the _catMain function like this:

options is an optional table that can be used to configure the function's output. There are two available options, "article" and "selfref".
 * article - if this is set to false, "no", "n", "false", or 0, the module outputs "The main page" rather than "The main article". Use the code {article = false}.
 * selfref - this is used when the output is a self-reference to WikiDevi. To set this option, use {selfref = true}. (See the selfref template for more details on self-references.)

The remaining arguments are page names to be turned into link(s) following the text "The main article for this category is". If no page names are specified, the current page name (minus the namespace name) is used for the first link.

Produces:
 * Example 1

Displays as:

Produces:
 * Example 2

Displays as:

Produces:
 * Example 3

Displays as:

Technical details
This module uses Module:Hatnote to format the hatnote text.