Module:Section link/doc: Difference between revisions

Revision as of 20:02, 13 July 2020

This module creates links to sections, nicely formatted with the “§” symbol instead of the default “#”.

From wikitext, this module should be used via the template Template:Tl. Please see the template page for documentation.

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.

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

@@ Line 22: / Line 22: @@
 Parameters:
-* {{var|page}} - the page name to link to. Defaults to the full page name of {{var|title}}, or the current title if that is not specified.
+; {{para|page}} : The page name to link to. Defaults to the full page name of {{var|title}}, 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.
+; {{para|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:
+; {{para|options}} : A table of options. Accepts the following fields:
-** {{var|nopage}} - set this to true to avoid displaying the base page name in links.
+:; {{para|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.
+:; {{para|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.