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 {{#invoke:Cat main|catMain|parameters}}. Please see the {{cat main}} template documentation for available parameters.

Use from other Lua modules

Load the module:

<syntaxhighlight lang="lua"> local mCatMain = require('Module:Cat main') </syntaxhighlight>

You can then use the _catMain function like this:

<syntaxhighlight lang="lua"> mCatMain._catMain(options, ...) </syntaxhighlight>

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 <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{article = false}</syntaxhighlight>.
• selfref - this is used when the output is a self-reference to Wikipedia. To set this option, use <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{selfref = true}</syntaxhighlight>. (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.

Example 1

<syntaxhighlight lang="lua"> mCatMain._catMain(nil, 'Foo') </syntaxhighlight> Produces:

<div class="hatnote relarticle mainarticle">The main article for this [[Help:Categories|category]] is '''[[Foo]]'''.</div>

Displays as: Template:Cat main

Example 2

<syntaxhighlight lang="lua"> mCatMain._catMain(nil, 'Foo', 'Bar', 'Baz') </syntaxhighlight> Produces:

<div class="hatnote relarticle mainarticle">The main articles for this [[Help:Categories|category]] are '''[[Foo]]''', '''[[Bar]]''' and '''[[Baz]]'''.</div>

Displays as: Template:Cat main

Example 3

<syntaxhighlight lang="lua"> mCatMain._catMain({article = false}, 'Foo') </syntaxhighlight> Produces:

<div class="hatnote relarticle mainarticle">The main page for this [[Help:Categories|category]] is '''[[Foo]]'''.</div>

Displays as: Template:Cat main

Technical details

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