[go: nahoru, domu]

Jump to content

Munurin millum rættingarnar hjá "Module:Main/doc"

Frá Wikipedia, hin frælsa alfrøðin
Content deleted Content added
Stovnaði síðu við "This module produces a link to a main article or articles. It implements the {{tl|main}} template. Normally, it produces a link like "Main article: A". If used in the He..."
 
Xqbot (kjak | íkøst)
s Bot: Erstatt forældet <source> -tag og parameteren "enclose" [https://lists.wikimedia.org/pipermail/wikitech-ambassadors/2020-April/002284.html]
 
Linja 9: Linja 9:
Load the module:
Load the module:


<source lang="lua">
<syntaxhighlight lang="lua">
local mMain = require('Module:Main')
local mMain = require('Module:Main')
</syntaxhighlight>
</source>


You can then use the _main function like this:
You can then use the _main function like this:


<source lang="lua">
<syntaxhighlight lang="lua">
mMain._main(options, ...)
mMain._main(options, ...)
</syntaxhighlight>
</source>


The parameters following <var>options</var> 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 [[Help:Colon trick|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 parameters following <var>options</var> 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 [[Help:Colon trick|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''.
Linja 24: Linja 24:


; Example 1
; Example 1
<source lang="lua">
<syntaxhighlight lang="lua">
mMain._main(nil, {'A'})
mMain._main(nil, {'A'})
</syntaxhighlight>
</source>
Produces:
Produces:
:<code><nowiki><div class="hatnote relarticle mainarticle">Main article: [[A]]</div></nowiki></code>
:<code><nowiki><div class="hatnote relarticle mainarticle">Main article: [[A]]</div></nowiki></code>
Linja 33: Linja 33:


; Example 2
; Example 2
<source lang="lua">
<syntaxhighlight lang="lua">
mMain._main(nil, {'Wikipedia:Categorization'}, {'Help:Category'}, {'Category:Wikipedia categories'})
mMain._main(nil, {'Wikipedia:Categorization'}, {'Help:Category'}, {'Category:Wikipedia categories'})
</syntaxhighlight>
</source>
Produces:
Produces:
:<code><nowiki><div class="hatnote relarticle mainarticle">Main pages: [[Wikipedia:Categorization]], [[Help:Category]] and [[:Category:Wikipedia categories]]</div></nowiki></code>
:<code><nowiki><div class="hatnote relarticle mainarticle">Main pages: [[Wikipedia:Categorization]], [[Help:Category]] and [[:Category:Wikipedia categories]]</div></nowiki></code>
Linja 42: Linja 42:


; Example 3
; Example 3
<source lang="lua">
<syntaxhighlight lang="lua">
mMain._main(nil, {'A', 'the letter "A"'}, {'B', 'the letter "B"'}, {'C', 'the letter "C"'})
mMain._main(nil, {'A', 'the letter "A"'}, {'B', 'the letter "B"'}, {'C', 'the letter "C"'})
</syntaxhighlight>
</source>
Produces:
Produces:
:<code><nowiki><div class="hatnote relarticle mainarticle">Main articles: [[A|the letter "A"]], [[B|the letter "B"]] and [[C|the letter "C"]]</div></nowiki></code>
:<code><nowiki><div class="hatnote relarticle mainarticle">Main articles: [[A|the letter "A"]], [[B|the letter "B"]] and [[C|the letter "C"]]</div></nowiki></code>
Linja 51: Linja 51:


; Example 4
; Example 4
<source lang="lua">
<syntaxhighlight lang="lua">
mMain._main({selfref = true}, {'Wikipedia:Verifiability#Burden'})
mMain._main({selfref = true}, {'Wikipedia:Verifiability#Burden'})
</syntaxhighlight>
</source>
Produces:
Produces:
:<code><nowiki><div class="hatnote relarticle mainarticle selfref">Main article: [[Wikipedia:Verifiability#Burden|Wikipedia:Verifiability § Burden]]</div></nowiki></code>
:<code><nowiki><div class="hatnote relarticle mainarticle selfref">Main article: [[Wikipedia:Verifiability#Burden|Wikipedia:Verifiability § Burden]]</div></nowiki></code>
Linja 60: Linja 60:


; Example 5 (if used in the category namespace)
; Example 5 (if used in the category namespace)
<source lang="lua">
<syntaxhighlight lang="lua">
mMain._main(nil, {'A'})
mMain._main(nil, {'A'})
</syntaxhighlight>
</source>
Produces:
Produces:
:<code><nowiki><div class="hatnote relarticle mainarticle">The main article for this [[Wikipedia:Categorization|category]] is [[A]]</div></nowiki></code>
:<code><nowiki><div class="hatnote relarticle mainarticle">The main article for this [[Wikipedia:Categorization|category]] is [[A]]</div></nowiki></code>

Seinasta endurskoðan sum var 22. apr 2020 kl. 16:37

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

[rætta wikitekst]

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

[rætta wikitekst]

Load the module:

local mMain = require('Module:Main')

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

{selfref = true}

. (See the {{selfref}} template for more details on self-references.)

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

Produces:

<div class="hatnote relarticle mainarticle">Main article: [[A]]</div>

Displays as:

Høvuðsgrein: A


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

Produces:

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

Displays as:

Høvuðsgrein: Wikipedia:Categorization


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

Produces:

<div class="hatnote relarticle mainarticle">Main articles: [[A|the letter "A"]], [[B|the letter "B"]] and [[C|the letter "C"]]</div>

Displays as:

Høvuðsgrein: A


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

Produces:

<div class="hatnote relarticle mainarticle selfref">Main article: [[Wikipedia:Verifiability#Burden|Wikipedia:Verifiability § Burden]]</div>

Displays as:

Høvuðsgrein: Wikipedia:Verifiability#Burden


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

Produces:

<div class="hatnote relarticle mainarticle">The main article for this [[Wikipedia:Categorization|category]] is [[A]]</div>

Displays as:

The main article for this category is A

Technical details

[rætta wikitekst]

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.