Difference between revisions of "Module:Main/doc"

From All About Ayrshire
Jump to: navigation, search
m (1 revision)
m (1 revision imported)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 +
{{high-risk|228000+}}
 +
{{Module rating|protected}}
 +
 
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 [[Help:Category|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".
 
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 [[Help:Category|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 ==
 
== Usage from wikitext ==
 
 
This module cannot be accessed directly from #invoke. Instead, it can only be used through the {{tl|main}} template. Please see the template page for documentation.
 
This module cannot be accessed directly from #invoke. Instead, it can only be used through the {{tl|main}} template. Please see the template page for documentation.
  
 
== Usage from other Lua modules ==
 
== Usage from other Lua modules ==
 
 
Load the module:
 
Load the module:
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local mMain = require('Module:Main')
 
local mMain = require('Module:Main')
</source>
+
</syntaxhighlight>
  
 
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(args, options)
</source>
+
</syntaxhighlight>
  
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 <var>args</var> parameter following <var>options</var> are a list of page link strings; if they use custom display values, each string should be preprocessed into a single piped string (e.g. <code><nowiki>page|display value</nowiki></code>). 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 <var>options</var> 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 {{code|1={selfref = true}|2=lua}}. (See the {{tl|selfref}} template for more details on self-references.)
+
The optional <var>options</var> table can be used to configure the function's output. At present, the only option available is "selfref", which is used when the output is a self-reference to Wikipedia. to set this option, use {{code|1={selfref = true}|2=lua}}. (See the {{tl|selfref}} template for more details on self-references.)
 +
 
 +
=== Example 1 ===
 +
<syntaxhighlight lang="lua">
 +
mMain._main({'A'})
 +
</syntaxhighlight>
  
; Example 1
 
<source lang="lua">
 
mMain._main(nil, {'A'})
 
</source>
 
 
Produces:
 
Produces:
:<code><nowiki><div class="hatnote relarticle mainarticle">Main article: [[A]]</div></nowiki></code>
+
 
 +
<code><nowiki><div role="note" class="hatnote navigation-not-searchable">Main article: [[A]]</div></nowiki></code>
 +
 
 
Displays as:
 
Displays as:
 +
 
{{main|A}}
 
{{main|A}}
  
; Example 2
+
=== Example 2 ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
mMain._main(nil, {'Wikipedia:Categorization'}, {'Help:Category'}, {'Category:Wikipedia categories'})
+
mMain._main({'Wikipedia:Categorization', 'Help:Category', 'Category:Wikipedia categories'})
</source>
+
</syntaxhighlight>
 +
 
 
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 role="note" class="hatnote navigation-not-searchable">Main pages: [[Wikipedia:Categorization]], [[Help:Category]] and [[:Category:Wikipedia categories]]</div></nowiki></code>
 +
 
 
Displays as:
 
Displays as:
 +
 
{{main|Wikipedia:Categorization|Help:Category|Category:Wikipedia categories}}
 
{{main|Wikipedia:Categorization|Help:Category|Category:Wikipedia categories}}
  
; 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({'A|the letter "A"', 'B|the letter "B"', 'C|the letter "C"'})
</source>
+
</syntaxhighlight>
 +
 
 
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 role="note" class="hatnote navigation-not-searchable">Main articles: [[A|the letter "A"]], [[B|the letter "B"]] and [[C|the letter "C"]]</div></nowiki></code>
 +
 
 
Displays as:
 
Displays as:
 +
 
{{main|A|B|C|l1=the letter "A"|l2=the letter "B"|l3=the letter "C"}}
 
{{main|A|B|C|l1=the letter "A"|l2=the letter "B"|l3=the letter "C"}}
  
; Example 4
+
=== Example 4 ===
<source lang="lua">
+
<syntaxhighlight lang="lua">
mMain._main({selfref = true}, {'Wikipedia:Verifiability#Burden'})
+
mMain._main({'Wikipedia:Verifiability#Burden'}, {selfref = true})
</source>
+
</syntaxhighlight>
 +
 
 
Produces:
 
Produces:
:<code><nowiki><div class="hatnote relarticle mainarticle selfref">Main article: [[Wikipedia:Verifiability#Burden|Wikipedia:Verifiability § Burden]]</div></nowiki></code>
+
 
 +
<code><nowiki><div role="note" class="hatnote navigation-not-searchable selfref">Main article: [[Wikipedia:Verifiability#Burden|Wikipedia:Verifiability § Burden]]</div></nowiki></code>
 +
 
 
Displays as:
 
Displays as:
 +
 
{{main|Wikipedia:Verifiability#Burden|selfref=true}}
 
{{main|Wikipedia:Verifiability#Burden|selfref=true}}
  
; 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({'A'})
</source>
+
</syntaxhighlight>
 +
 
 
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 role="note" class="hatnote navigation-not-searchable">The main article for this [[Wikipedia:Categorization|category]] is [[A]]</div></nowiki></code>
 +
 
 
Displays as:
 
Displays as:
<div class="hatnote relarticle mainarticle">The main article for this [[Wikipedia:Categorization|category]] is [[A]]</div>
+
 
 +
<div role="note" class="hatnote navigation-not-searchable">The main article for this [[Wikipedia:Categorization|category]] is [[A]]</div>
  
 
== Technical details ==
 
== Technical details ==
 
+
This module uses [[Module:Hatnote]] to format the hatnote text, [[Module:Hatnote list]] to process the list of links, and [[Module:Arguments]] to fetch the arguments from wikitext.
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.
 
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<!-- Categories go here and interwikis go in Wikidata. -->
 
<!-- Categories go here and interwikis go in Wikidata. -->
 
+
[[Category:Hatnote modules]]
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 19:34, 27 December 2020

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:

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

You can then use the _main function like this:

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

The args parameter following options are a list of page link strings; if they use custom display values, each string should be preprocessed into a single piped string (e.g. page|display value). 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 optional options table can be used to configure the function's output. At present, the only option available is "selfref", which 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.)

Example 1[edit]

<syntaxhighlight lang="lua"> mMain._main({'A'}) </syntaxhighlight>

Produces:

<div role="note" class="hatnote navigation-not-searchable">Main article: [[A]]</div>

Displays as:

Example 2[edit]

<syntaxhighlight lang="lua"> mMain._main({'Wikipedia:Categorization', 'Help:Category', 'Category:Wikipedia categories'}) </syntaxhighlight>

Produces:

<div role="note" class="hatnote navigation-not-searchable">Main pages: [[Wikipedia:Categorization]], [[Help:Category]] and [[:Category:Wikipedia categories]]</div>

Displays as:

Example 3[edit]

<syntaxhighlight lang="lua"> mMain._main({'A|the letter "A"', 'B|the letter "B"', 'C|the letter "C"'}) </syntaxhighlight>

Produces:

<div role="note" class="hatnote navigation-not-searchable">Main articles: [[A|the letter "A"]], [[B|the letter "B"]] and [[C|the letter "C"]]</div>

Displays as:

Example 4[edit]

<syntaxhighlight lang="lua"> mMain._main({'Wikipedia:Verifiability#Burden'}, {selfref = true}) </syntaxhighlight>

Produces:

<div role="note" class="hatnote navigation-not-searchable selfref">Main article: [[Wikipedia:Verifiability#Burden|Wikipedia:Verifiability § Burden]]</div>

Displays as:

Example 5 (if used in the category namespace)[edit]

<syntaxhighlight lang="lua"> mMain._main({'A'}) </syntaxhighlight>

Produces:

<div role="note" class="hatnote navigation-not-searchable">The main article for this [[Wikipedia:Categorization|category]] is [[A]]</div>

Displays as:

Technical details[edit]

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