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

From Summertime Saga Wiki
Jump to: navigation, search
m
m (Examples)
Line 38: Line 38:
 
|-
 
|-
 
| {{code|mSectionLink('Paris', 'Architecture')|lua}}
 
| {{code|mSectionLink('Paris', 'Architecture')|lua}}
| <code><nowiki>{{section link|Paris|Architecture}}</nowiki></code>
+
| <code><nowiki>{{section link|Wikipedia:Paris|Architecture}}</nowiki></code>
| {{section link|Paris|Architecture}}
+
| {{section link|Wikipedia:Paris|Architecture}}
 
|-
 
|-
 
| {{code|mSectionLink('Paris', {'Architecture', 'Culture'})|lua}}
 
| {{code|mSectionLink('Paris', {'Architecture', 'Culture'})|lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture}}</nowiki></code>
+
| <code><nowiki>{{section link|Wikipedia:Paris|Architecture|Culture}}</nowiki></code>
| {{section link|Paris|Architecture|Culture}}
+
| {{section link|Wikipedia:Paris|Architecture|Culture}}
 
|-
 
|-
 
| {{code|mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})|lua}}
 
| {{code|mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})|lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture|Sport}}</nowiki></code>
+
| <code><nowiki>{{section link|Wikipedia:Paris|Architecture|Culture|Sport}}</nowiki></code>
| {{section link|Paris|Architecture|Culture|Sport}}
+
| {{section link|Wikipedia:Paris|Architecture|Culture|Sport}}
 
|-
 
|-
 
| {{code|1=mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})|2=lua}}
 
| {{code|1=mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})|2=lua}}
| <code><nowiki>{{section link|Paris|Architecture|Culture|Sport|nopage=yes}}</nowiki></code>
+
| <code><nowiki>{{section link|Wikipedia:Paris|Architecture|Culture|Sport|nopage=yes}}</nowiki></code>
| {{section link|Paris|Architecture|Culture|Sport|nopage=yes}}
+
| {{section link|Wikipedia:Paris|Architecture|Culture|Sport|nopage=yes}}
 
|}
 
|}

Revision as of 18:42, 16 June 2019

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 Template:Tl. 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', '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