Module:Section link/doc: Difference between revisions

Revision as of 05:18, 26 February 2025

This is a documentation subpage for Module:Section link.
It may contain usage information, categories and other content that is not part of the original module page.

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 {{section link}}. 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')`	`{{section link\|Paris}}`	{{Section link}}: required section parameter(s) missing
`mSectionLink('Paris', 'Architecture')`	`{{section link\|Paris\|Architecture}}`	Paris Architecture
`mSectionLink('Paris', {'Architecture', 'Culture'})`	`{{section link\|Paris\|Architecture\|Culture}}`	Paris Architecture and Culture
`mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})`	`{{section link\|Paris\|Architecture\|Culture\|Sport}}`	Paris Architecture, Culture, and Sport
`mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})`	`{{section link\|Paris\|Architecture\|Culture\|Sport\|nopage=yes}}`	Architecture, Culture, and Sport

@@ Line 1: / Line 1: @@
-{{Module rating|release}}
+{{doc sub}}
-<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
+This module creates links to sections, nicely formatted with the "§" symbol instead of the default "#".
-{{Lua|Module:Yesno}}
+== 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>
-Implements {{tlx|Section link}}.
+You can then make section links via the _main function.
-{{clear}}
+<syntaxhighlight lang="lua">
-== Usage ==
+mSectionLink._main(page, sections, options, title)
-<code><nowiki>{{</nowiki>#invoke:Section link|main|{{var|page_name}}|{{var|section_name}}|{{var|...}}<nowiki>}}</nowiki></code>
+</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>{{Sandbox other||
-<!-- Categories below this line; interwikis at Wikidata -->
+<!-- Categories below this line, please; interwikis at Wikidata -->
-[[Category:Link modules{{#translation:}}]]
+[[Category:Modules]]
+[[Category:Link modules]]
 }}</includeonly><noinclude>
-[[Category:Module documentation pages{{#translation:}}]]
+[[Category:Module documentation pages]]
 </noinclude>