Difference between revisions of "Module:Section link/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Psiĥedelisto
(show what happens w/o param)
blackwiki>WOSlinker
m (change source to syntaxhighlight)
Line 12: Line 12:
 
First, load the module:
 
First, load the module:
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
local mSectionLink = require('Module:Section link')
 
local mSectionLink = require('Module:Section link')
</source>
+
</syntaxhighlight>
  
 
You can then make section links via the _main function.
 
You can then make section links via the _main function.
  
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
mSectionLink._main(page, sections, options, title)
 
mSectionLink._main(page, sections, options, title)
</source>
+
</syntaxhighlight>
  
 
Parameters:
 
Parameters:

Revision as of 13:22, 7 July 2020

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}} Script error: No such module "Section link".
mSectionLink('Paris', 'Architecture') {{section link|Paris|Architecture}} Script error: No such module "Section link".
mSectionLink('Paris', {'Architecture', 'Culture'}) {{section link|Paris|Architecture|Culture}} Script error: No such module "Section link".
mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}) {{section link|Paris|Architecture|Culture|Sport}} Script error: No such module "Section link".
mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true}) {{section link|Paris|Architecture|Culture|Sport|nopage=yes}} Script error: No such module "Section link".