Module:Main list/doc: Difference between revisions
Content deleted Content added
TFD closed as no consensus (XFDcloser) |
m change source to syntaxhighlight |
||
| Line 10: | Line 10: | ||
Load the module: |
Load the module: |
||
< |
<syntaxhighlight lang="lua"> |
||
local mMainList = require('Module:Main list') |
local mMainList = require('Module:Main list') |
||
</syntaxhighlight> |
|||
</source> |
|||
You can then use the _mainList function like this: |
You can then use the _mainList function like this: |
||
< |
<syntaxhighlight lang="lua"> |
||
mMainList._mainList (page1, page2) |
mMainList._mainList (page1, page2) |
||
</syntaxhighlight> |
|||
</source> |
|||
The <var>page1</var> variable is the page to be linked to, and is required. The page name can include a section link if desired. If the page includes a section link, it is automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. |
The <var>page1</var> variable is the page to be linked to, and is required. The page name can include a section link if desired. If the page includes a section link, it is automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. |
||
| Line 25: | Line 25: | ||
=== Example 1 === |
=== Example 1 === |
||
< |
<syntaxhighlight lang="lua"> |
||
mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates') |
mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates') |
||
</syntaxhighlight> |
|||
</source> |
|||
Produces: |
Produces: |
||
:<code><nowiki><div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]].</div></nowiki></code> |
:<code><nowiki><div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]].</div></nowiki></code> |
||
| Line 34: | Line 34: | ||
=== Example 2 === |
=== Example 2 === |
||
< |
<syntaxhighlight lang="lua"> |
||
mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates','Wikipedia:Template messages/Cleanup#Cleanup') |
mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates','Wikipedia:Template messages/Cleanup#Cleanup') |
||
</syntaxhighlight> |
|||
</source> |
|||
Produces: |
Produces: |
||
:<code><nowiki><div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]] and [[Wikipedia:Template messages/Cleanup#Cleanup|Wikipedia:Template messages/Cleanup § Cleanup]].</div></nowiki></code> |
:<code><nowiki><div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]] and [[Wikipedia:Template messages/Cleanup#Cleanup|Wikipedia:Template messages/Cleanup § Cleanup]].</div></nowiki></code> |
||
Latest revision as of 16:26, 7 July 2020
This module produces a "For a more comprehensive list, see [...]" link. It implements the {{main list}} template.
Use from wikitext
[edit]This module cannot be used directly from #invoke. Instead, it can only be used through the {{main list}} template. Please see the template page for documentation.
Use from other Lua modules
[edit]Load the module:
local mMainList = require('Module:Main list')
You can then use the _mainList function like this:
mMainList._mainList (page1, page2)
The page1 variable is the page to be linked to, and is required. The page name can include a section link if desired. If the page includes a section link, it is automatically formatted as page § section, rather than the MediaWiki default of page#section.
The page2 variable is optional; it is a second page link.
Example 1
[edit]mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates')
Produces:
<div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]].</div>
Displays as:
For a more comprehensive list, see Wikipedia:Hatnote § Hatnote templates.
Example 2
[edit]mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates','Wikipedia:Template messages/Cleanup#Cleanup')
Produces:
<div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]] and [[Wikipedia:Template messages/Cleanup#Cleanup|Wikipedia:Template messages/Cleanup § Cleanup]].</div>
Displays as:
For a more comprehensive list, see Wikipedia:Hatnote § Hatnote templates and Wikipedia:Template messages/Cleanup § Cleanup.
Technical details
[edit]This module uses Module:Hatnote to format the hatnote text and Module:Arguments to fetch the arguments from wikitext.