Module:ਮੁੱਖ ਲੇਖ/doc

From Wikiversity

This is the documentation page for Module:ਮੁੱਖ ਲੇਖ

This module produces a link to a main article or articles. It implements the {{main}} template. Normally, it produces a link like "Main article: A". If used in the category namespace, it produces a link like "The main article for this category is A". It is possible to specify multiple articles, and in this case plural wording is used automatically. If the first link is not an article, the module uses the wording "Main page" instead of "Main article".

Usage from wikitext[edit]

This module cannot be accessed directly from #invoke. Instead, it can only be used through the {{main}} template. Please see the template page for documentation.

Usage from other Lua modules[edit]

Load the module:

local mMain = require('Module:ਮੁੱਖ ਲੇਖ')

You can then use the _main function like this:

mMain._main(options, ...)

The parameters following options are a list of link/display tables, used to generate the links. The first value in each table is the link, and is required. The second value in each table is the display value, and is optional. Category or file links are automatically escaped using the colon trick. If a link includes a section name, and no display value is set, links are automatically formatted as page § section, rather than the MediaWiki default of page#section.

The options table can be used to configure the function's output. At current, the only option available is "selfref", which is used when the output is a self-reference to Wikipedia. to set this option, use Template:Code. (See the {{selfref}} template for more details on self-references.)

Example 1
mMain._main(nil, {'A'})


<div class="hatnote relarticle mainarticle">ਮੁੱਖ ਆਰਟੀਕਲ: [[A]]</div>

Displays as:

Main article: A
Example 2
mMain._main(nil, {'Wikipedia:Categorization'}, {'Help:Category'}, {'Category:Wikipedia categories'})


<div class="hatnote relarticle mainarticle">Main pages: [[Wikipedia:Categorization]], [[Help:Category]] and [[:Category:Wikipedia categories]]</div>

Displays as:

Example 3
mMain._main(nil, {'A', 'the letter "A"'}, {'B', 'the letter "B"'}, {'C', 'the letter "C"'})


<div class="hatnote relarticle mainarticle">ਮੁੱਖ ਆਰਟੀਕਲs: [[A|the letter "A"]], [[B|the letter "B"]] and [[C|the letter "C"]]</div>

Displays as:

Example 4
mMain._main({selfref = true}, {'Wikipedia:Verifiability#Burden'})


<div class="hatnote relarticle mainarticle selfref">ਮੁੱਖ ਆਰਟੀਕਲ: [[Wikipedia:Verifiability#Burden|Wikipedia:Verifiability § Burden]]</div>

Displays as:

Example 5 (if used in the category namespace)
mMain._main(nil, {'A'})


<div class="hatnote relarticle mainarticle">The ਮੁੱਖ ਆਰਟੀਕਲ for this [[Wikipedia:Categorization|category]] is [[A]]</div>

Displays as:

The ਮੁੱਖ ਆਰਟੀਕਲ for this category is A

Technical details[edit]

This module uses Module:Hatnote to format the hatnote text, Module:TableTools to process the list of links, and Module:Arguments to fetch the arguments from wikitext.