Module:Section link/doc

MyWikiBiz, Author Your Legacy — Friday November 15, 2024
< Module:Section link
Revision as of 05:55, 16 July 2021 by Zoran (talk | contribs) (Pywikibot 6.4.0)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

This is the documentation page for Module:Section link

Template:Module rating 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
Template:Code {{section link|Paris}} Template:Section link
Template:Code {{section link|Paris|Architecture}} Template:Section link
Template:Code {{section link|Paris|Architecture|Culture}} Template:Section link
Template:Code {{section link|Paris|Architecture|Culture|Sport}} Template:Section link
Template:Code {{section link|Paris|Architecture|Culture|Sport|nopage=yes}} Template:Section link

See also