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

From Summertime Saga Wiki
Jump to: navigation, search
m (→‎From Lua)
m
 
(5 intermediate revisions by the same user not shown)
Line 5: Line 5:
 
=== From wikitext ===
 
=== From wikitext ===
  
−
From wikitext, this module should be used via the template {{tl|section link}}. Please see the template page for documentation.
+
From wikitext, this module should be used via the template {{tlg|section link}}. Please see the template page for documentation.
  
 
=== From Lua ===
 
=== From Lua ===
Line 15: Line 15:
 
</source>
 
</source>
  
−
You can then make section links via the <code>_main function</code>.
+
You can then make section links via the {{code|_main function}}.
  
 
<source lang="lua">
 
<source lang="lua">
Line 22: Line 22:
  
 
Parameters:
 
Parameters:
−
* {{var|page}} - 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.
+
; {{para|page}} : The page name to link to. Defaults to the full page name of {{var|title}}, or the current title if that is not specified.
−
* {{var|sections}} - an array of section names to link to, or a string to link to just one section name.
+
; {{para|sections}} : An array of section names to link to, or a string to link to just one section name.
−
* {{var|options}} - a table of options. Accepts the following fields:
+
; {{para|options}} : A table of options. Accepts the following fields:
−
** {{var|nopage}} - set this to true to avoid displaying the base page name in links.
+
:; {{para|nopage}} : Set this to true to avoid displaying the base page name in links.
−
* {{var|title}} - a default [[mw:Extension:Scribunto/Lua reference manual#Title objects|mw.title object]] to use instead of the current title. Intended for testing purposes.
+
:; {{para|title}} : 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.
 
All parameters are optional.
  
Line 38: Line 38:
 
|-
 
|-
 
| {{code|mSectionLink('Paris', 'Architecture')|lua}}
 
| {{code|mSectionLink('Paris', 'Architecture')|lua}}
−
| <code><nowiki>{{section link|Wikipedia:Paris|Architecture}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Paris|Architecture}}
 
| {{section link|Wikipedia:Paris|Architecture}}
 
| {{section link|Wikipedia:Paris|Architecture}}
 
|-
 
|-
 
| {{code|mSectionLink('Paris', {'Architecture', 'Culture'})|lua}}
 
| {{code|mSectionLink('Paris', {'Architecture', 'Culture'})|lua}}
−
| <code><nowiki>{{section link|Wikipedia:Paris|Architecture|Culture}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Paris|Architecture|Culture}}
 
| {{section link|Wikipedia: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|Wikipedia:Paris|Architecture|Culture|Sport}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Paris|Architecture|Culture|Sport}}
 
| {{section link|Wikipedia: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|Wikipedia:Paris|Architecture|Culture|Sport|nopage=yes}}</nowiki></code>
+
| {{tlg|code=yes|nolink=yes|section link|Wikipedia:Paris|Architecture|Culture|Sport|nopage=yes}}
 
| {{section link|Wikipedia:Paris|Architecture|Culture|Sport|nopage=yes}}
 
| {{section link|Wikipedia:Paris|Architecture|Culture|Sport|nopage=yes}}
 
|}
 
|}
  
−
[[Category:Modules]]
+
[[Category:Modules]][[Category:Modules documentation]]
−
[[Category:Modules documentation]]
 

Latest revision as of 17:07, 21 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', '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}} §§ Architecture, Culture, and Sport
Retrieved from "https://wiki.summertimesaga.com/index.php?title=Module:Section_link/doc&oldid=24582"