Changes
no edit summary
{{Module rating|protected}}
This module creates links to sections, nicely formatted with the "§" symbol instead of the default "#".
== Usage ==
=== From wikitext ===
From wikitext, this module should be used via the template {{tl|section link}}. Please see the template page for documentation.
=== From Lua ===
First, load the module:
<source lang="lua">
local mSectionLink = require('Module:Section link')
</source>
You can then make section links via the _main function.
<source lang="lua">
mSectionLink._main(page, sections, options, title)
</source>
Parameters:
* <var>page</var> - 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</var> - an array of section names to link to, or a string to link to just one section name.
* <var>options</var> - a table of options. Accepts the following fields:
** <var>nopage</var> - set this to true to avoid displaying the base page name in links.
* <var>title</var> - 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.
== Examples ==
{| class="wikitable"
|-
! Lua code
! Wikitext code
! Result
|-
| {{code|mSectionLink('Paris', 'Architecture')|lua}}
| <code><nowiki>{{section link|Paris|Architecture}}</nowiki></code>
| {{section link|Paris|Architecture}}
|-
| {{code|mSectionLink('Paris', {'Architecture', 'Culture'})|lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture}}</nowiki></code>
| {{section link|Paris|Architecture|Culture}}
|-
| {{code|mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})|lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture|Sport}}</nowiki></code>
| {{section link|Paris|Architecture|Culture|Sport}}
|-
| {{code|1=mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})|2=lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture|Sport|nopage=yes}}</nowiki></code>
| {{section link|Paris|Architecture|Culture|Sport|nopage=yes}}
|}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
}}</includeonly>
This module creates links to sections, nicely formatted with the "§" symbol instead of the default "#".
== Usage ==
=== From wikitext ===
From wikitext, this module should be used via the template {{tl|section link}}. Please see the template page for documentation.
=== From Lua ===
First, load the module:
<source lang="lua">
local mSectionLink = require('Module:Section link')
</source>
You can then make section links via the _main function.
<source lang="lua">
mSectionLink._main(page, sections, options, title)
</source>
Parameters:
* <var>page</var> - 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</var> - an array of section names to link to, or a string to link to just one section name.
* <var>options</var> - a table of options. Accepts the following fields:
** <var>nopage</var> - set this to true to avoid displaying the base page name in links.
* <var>title</var> - 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.
== Examples ==
{| class="wikitable"
|-
! Lua code
! Wikitext code
! Result
|-
| {{code|mSectionLink('Paris', 'Architecture')|lua}}
| <code><nowiki>{{section link|Paris|Architecture}}</nowiki></code>
| {{section link|Paris|Architecture}}
|-
| {{code|mSectionLink('Paris', {'Architecture', 'Culture'})|lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture}}</nowiki></code>
| {{section link|Paris|Architecture|Culture}}
|-
| {{code|mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})|lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture|Sport}}</nowiki></code>
| {{section link|Paris|Architecture|Culture|Sport}}
|-
| {{code|1=mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})|2=lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture|Sport|nopage=yes}}</nowiki></code>
| {{section link|Paris|Architecture|Culture|Sport|nopage=yes}}
|}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
}}</includeonly>