Module:Section link/doc: Difference between revisions
Content deleted Content added
create docs |
add examples |
||
| Line 27: | Line 27: | ||
** <var>nopage</var> - set this to true to avoid displaying the base page name in links. |
** <var>nopage</var> - set this to true to avoid displaying the base page name in links. |
||
* <var>title</var> - a default [[mw:Extension:Scribunto/Lua reference manual#Title objects|mw.title object]] to use instead of the current title (optional). Intended for testing purposes. |
* <var>title</var> - a default [[mw:Extension:Scribunto/Lua reference manual#Title objects|mw.title object]] to use instead of the current title (optional). Intended for testing purposes. |
||
== Examples == |
|||
{| class="wikitable" |
|||
|- |
|||
! Lua code |
|||
! Wikitext code |
|||
! Result |
|||
|- |
|||
| {{code|mSectionLink('Paris', 'Architecture')|lua}} |
|||
| <code><nowiki>{{section link|Paris|Architecture}}</nowiki></code> |
|||
| {{section link|Paris|Architecture}} |
|||
|- |
|||
| {{code|mSectionLink('Paris', {'Architecture', 'Culture'})|lua}} |
|||
| <code><nowiki>{{section link|Paris|Architecture|Culture}}</nowiki></code> |
|||
| {{section link|Paris|Architecture|Culture}} |
|||
|- |
|||
| {{code|mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})|lua}} |
|||
| <code><nowiki>{{section link|Paris|Architecture|Culture|Sport}}</nowiki></code> |
|||
| {{section link|Paris|Architecture|Culture|Sport}} |
|||
|- |
|||
| {{code|1=mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})|2=lua}} |
|||
| <code><nowiki>{{section link|Paris|Architecture|Culture|Sport|nopage=yes}}</nowiki></code> |
|||
| {{section link|Paris|Architecture|Culture|Sport|nopage=yes}} |
|||
|} |
|||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
||
Revision as of 09:35, 9 December 2014
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. (required)
- options - a table of options (optional). Accepts the following options:
- 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 (optional). Intended for testing purposes.
Examples
| Lua code | Wikitext code | Result |
|---|---|---|
mSectionLink('Paris', 'Architecture')
|
{{section link|Paris|Architecture}}
|
Paris § Architecture |
mSectionLink('Paris', {'Architecture', 'Culture'})
|
{{section link|Paris|Architecture|Culture}}
|
Paris §§ Architecture and Culture |
mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'})
|
{{section link|Paris|Architecture|Culture|Sport}}
|
Paris §§ Architecture, Culture, and Sport |
mSectionLink('Paris', {'Architecture', 'Culture', 'Sport'}, {nopage = true})
|
{{section link|Paris|Architecture|Culture|Sport|nopage=yes}}
|
§§ Architecture, Culture, and Sport |