Module:Section link/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 10:10, 9 December 2014

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 {{section link}}. 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\|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 23: / Line 23: @@
 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. (required)
+* <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 (optional). Accepts the following fields:
+* <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 (optional). Intended for testing purposes.
+* <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 ==