Difference between revisions of "Module:Section link/doc"
From Summertime Saga Wiki
m |
m (→From Lua) |
||
| Line 15: | Line 15: | ||
</source> | </source> | ||
| − | You can then make section links via the _main function. | + | You can then make section links via the <code>_main function</code>. |
<source lang="lua"> | <source lang="lua"> | ||
| Line 22: | Line 22: | ||
Parameters: | Parameters: | ||
| − | * | + | * {{var|page}} - the page name to link to. Defaults to the full page name of <var>title</var>, or the current title if that is not specified. |
| − | * | + | * {{var|sections}} - an array of section names to link to, or a string to link to just one section name. |
| − | * | + | * {{var|options}} - a table of options. Accepts the following fields: |
| − | ** | + | ** {{var|nopage}} - set this to true to avoid displaying the base page name in links. |
| − | * | + | * {{var|title}} - a default [[mw:Extension:Scribunto/Lua reference manual#Title objects|mw.title object]] to use instead of the current title. Intended for testing purposes. |
All parameters are optional. | All parameters are optional. | ||
Revision as of 12:47, 11 July 2020
This module creates links to sections, nicely formatted with the “§” symbol instead of the default “#”.
Contents
Usage
From wikitext
From wikitext, this module should be used via the template Template:Tl. Please see the template page for documentation.
From Lua
First, load the module:
local mSectionLink = require('Module:Section link')
You can then make section links via the _main function.
mSectionLink._main(page, sections, options, title)
Parameters:
- page - the page name to link to. Defaults to the full page name of title, or the current title if that is not specified.
- sections - an array of section names to link to, or a string to link to just one section name.
- options - a table of options. Accepts the following fields:
- nopage - set this to true to avoid displaying the base page name in links.
- title - a default mw.title object to use instead of the current title. Intended for testing purposes.
All parameters are optional.
Examples
| Lua code | Wikitext code | Result |
|---|---|---|
mSectionLink('Paris', 'Architecture')
|
{{section link|Wikipedia:Paris|Architecture}}
|
Wikipedia:Paris § Architecture |
mSectionLink('Paris', {'Architecture', 'Culture'})
|
{{section link|Wikipedia:Paris|Architecture|Culture}}
|
Wikipedia:Paris §§ Architecture and Culture |
mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})
|
{{section link|Wikipedia:Paris|Architecture|Culture|Sport}}
|
Wikipedia:Paris §§ Architecture, Culture, and Sport |
mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})
|
{{section link|Wikipedia:Paris|Architecture|Culture|Sport|nopage=yes}}
|
§§ Architecture, Culture, and Sport |