Module:Category main article/doc

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

Use from wikitext

This module should usually be used via the Template:Tl template. However, it can also be used from #invoke with the syntax {{#invoke:Category main article|catMain|parameters}}. Please see the Template:Tl template documentation for available parameters.

Use from other Lua modules

Load the module:

local mCatMain = require('Module:Category main article')

You can then use the _catMain function like this:

mCatMain._catMain(options, ...)

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 Wikipedia. To set this option, use {selfref = true}. (See the Template:Tl 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

mCatMain._catMain(nil, 'Foo')

Produces:

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

Displays as: Template:Cat main

Example 2

mCatMain._catMain(nil, 'Foo', 'Bar', 'Baz')

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

mCatMain._catMain({article = false}, 'Foo')

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.

Text output

This module has five lines that must be translated when exported to wikis in other languages.

Variable	Code	Translatable text
pagetype	pagetype = yesno(options.article) ~= false and 'article' or 'page'	article	page
	pagetype = mw.title.new(page).namespace == 0 and "article" or "page"	article	page
	pagetype = "article"	article
stringToFormat	stringToFormat = 'The main %ss for this [[Help:Categories|category]] are %s.'	The main %ss for this [[Help:Categories|category]] are %s.
	stringToFormat = 'The main %s for this [[Help:Categories|category]] is %s.'	The main %s for this [[Help:Categories|category]] is %s.