Difference between revisions of "Module:Section link/doc"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius m (→Usage: ce) |
m (7 revisions imported) |
||
| (4 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| + | {{Module rating|protected}} | ||
This module creates links to sections, nicely formatted with the "§" symbol instead of the default "#". | This module creates links to sections, nicely formatted with the "§" symbol instead of the default "#". | ||
| Line 11: | Line 12: | ||
First, load the module: | First, load the module: | ||
| − | < | + | <syntaxhighlight lang="lua"> |
local mSectionLink = require('Module:Section link') | local mSectionLink = require('Module:Section link') | ||
| − | </ | + | </syntaxhighlight> |
You can then make section links via the _main function. | You can then make section links via the _main function. | ||
| − | < | + | <syntaxhighlight lang="lua"> |
mSectionLink._main(page, sections, options, title) | mSectionLink._main(page, sections, options, title) | ||
| − | </ | + | </syntaxhighlight> |
Parameters: | Parameters: | ||
* <var>page</var> - 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. | * <var>page</var> - 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. | ||
| − | * <var>sections</var> - an array of section names to link to, or a string to link to just one section name. | + | * <var>sections</var> - an array of section names to link to, or a string to link to just one section name. |
| − | * <var>options</var> - a table of options | + | * <var>options</var> - a table of options. Accepts the following fields: |
** <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 | + | * <var>title</var> - 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. | ||
== Examples == | == Examples == | ||
| Line 35: | Line 37: | ||
! Wikitext code | ! Wikitext code | ||
! Result | ! Result | ||
| + | |- | ||
| + | | {{code|mSectionLink('Paris')|lua}} | ||
| + | | <code><nowiki>{{section link|Paris}}</nowiki></code> | ||
| + | | {{section link|Paris}} | ||
|- | |- | ||
| {{code|mSectionLink('Paris', 'Architecture')|lua}} | | {{code|mSectionLink('Paris', 'Architecture')|lua}} | ||
Latest revision as of 07:14, 28 September 2020
| This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This module creates links to sections, nicely formatted with the "§" symbol instead of the default "#".
Contents
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". |