Difference between revisions of "Module:Cat main/doc"
blackwiki>Pppery (Perhaps this markup hack can finally be dead now?) |
m (8 revisions imported) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 9: | Line 9: | ||
Load the module: | Load the module: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local mCatMain = require('Module:Cat main') | local mCatMain = require('Module:Cat main') | ||
| − | </ | + | </syntaxhighlight> |
You can then use the _catMain function like this: | You can then use the _catMain function like this: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
mCatMain._catMain(options, ...) | mCatMain._catMain(options, ...) | ||
| − | </ | + | </syntaxhighlight> |
<var>options</var> is an optional table that can be used to configure the function's output. There are two available options, "article" and "selfref". | <var>options</var> is an optional table that can be used to configure the function's output. There are two available options, "article" and "selfref". | ||
| Line 26: | Line 26: | ||
; Example 1 | ; Example 1 | ||
| − | < | + | <syntaxhighlight lang="lua"> |
mCatMain._catMain(nil, 'Foo') | mCatMain._catMain(nil, 'Foo') | ||
| − | </ | + | </syntaxhighlight> |
Produces: | Produces: | ||
:<code><nowiki><div class="hatnote relarticle mainarticle">The main article for this [[Help:Categories|category]] is '''[[Foo]]'''.</div></nowiki></code> | :<code><nowiki><div class="hatnote relarticle mainarticle">The main article for this [[Help:Categories|category]] is '''[[Foo]]'''.</div></nowiki></code> | ||
| Line 35: | Line 35: | ||
; Example 2 | ; Example 2 | ||
| − | < | + | <syntaxhighlight lang="lua"> |
mCatMain._catMain(nil, 'Foo', 'Bar', 'Baz') | mCatMain._catMain(nil, 'Foo', 'Bar', 'Baz') | ||
| − | </ | + | </syntaxhighlight> |
Produces: | Produces: | ||
:<code><nowiki><div class="hatnote relarticle mainarticle">The main articles for this [[Help:Categories|category]] are '''[[Foo]]''', '''[[Bar]]''' and '''[[Baz]]'''.</div></nowiki></code> | :<code><nowiki><div class="hatnote relarticle mainarticle">The main articles for this [[Help:Categories|category]] are '''[[Foo]]''', '''[[Bar]]''' and '''[[Baz]]'''.</div></nowiki></code> | ||
| Line 44: | Line 44: | ||
; Example 3 | ; Example 3 | ||
| − | < | + | <syntaxhighlight lang="lua"> |
mCatMain._catMain({article = false}, 'Foo') | mCatMain._catMain({article = false}, 'Foo') | ||
| − | </ | + | </syntaxhighlight> |
Produces: | Produces: | ||
:<code><nowiki><div class="hatnote relarticle mainarticle">The main page for this [[Help:Categories|category]] is '''[[Foo]]'''.</div></nowiki></code> | :<code><nowiki><div class="hatnote relarticle mainarticle">The main page for this [[Help:Categories|category]] is '''[[Foo]]'''.</div></nowiki></code> | ||
Latest revision as of 13:30, 26 September 2020
This module produces hatnote saying "The main article for this category is x." It implements the {{cat main}} template.
Use from wikitext
This module should usually be used via the {{cat main}} template. However, it can also be used from #invoke with the syntax {{#invoke:Cat main|catMain|parameters}}. Please see the {{cat main}} template documentation for available parameters.
Use from other Lua modules
Load the module:
local mCatMain = require('Module:Cat main')
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 {{selfref}} 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:
- 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:
- 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:
Technical details
This module uses Module:Hatnote to format the hatnote text.