Module:Section link/doc

From Funkinchan
Jump to navigationJump to search

This is the documentation page for Module:Section link

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:

<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:

  • 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
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mSectionLink('Paris')</syntaxhighlight> {{section link|Paris}} Paris § Notes
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mSectionLink('Paris', 'Architecture')</syntaxhighlight> {{section link|Paris|Architecture}} Paris § Architecture
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mSectionLink('Paris', {'Architecture', 'Culture'})</syntaxhighlight> {{section link|Paris|Architecture|Culture}} Paris §§ Architecture​ and Culture
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})</syntaxhighlight> {{section link|Paris|Architecture|Culture|Sport}} Paris §§ Architecture, Culture, and Sport
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})</syntaxhighlight> {{section link|Paris|Architecture|Culture|Sport|nopage=yes}} §§ Architecture, Culture, and Sport

See also