View source for Module:Section link/doc

{{used in system|in [[MediaWiki:Abusefilter-warning-notwallofshame]]}}
{{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:

<syntaxhighlight lang="lua">
local mSectionLink = require('Module:Section link')
</syntaxhighlight>

You can then make section links via the _main function.

<syntaxhighlight lang="lua">
mSectionLink._main(page, sections, options, title)
</syntaxhighlight>

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')|lua}}
| <code><nowiki>{{section link|Paris}}</nowiki></code>
| {{section link|Paris}}
|-
| {{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}}
|}
== See also ==
*The character used is {{unichar|00A7|name=|html=|nlink=Section sign}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->
}}</includeonly>