Module:Section link/doc
 | This is a documentation subpage for Module:Section link. It may contain usage information, categories and other content that is not part of the original module page. |
 | This Lua module is used in MediaWiki:Abusefilter-warning-notwallofshame, and on approximately 165,000 pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
 | This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
 | This module depends on the following other modules: |
This module creates links to sections, nicely formatted with the "§" symbol instead of the default "#".
Usage
[edit]From wikitext
[edit]From wikitext, this module should be used via the template {{section link}}. Please see the template page for documentation.
From Lua
[edit]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
[edit]| Lua code | Wikitext code | Result |
|---|---|---|
mSectionLink('Paris')
|
{{section link|Paris}}
|
{{Section link}}: required section parameter(s) missing |
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 |
See also
[edit]- The character used is U+00A7 § SECTION SIGN (§)