Difference between revisions of "Hatnote/doc"

From blackwiki
Jump to navigation Jump to search
test>Mr. Stradivarius
m (→‎Rellink: remove extra example)
test>Mr. Stradivarius
(add format link function)
Line 66: Line 66:
 
Displayed as:
 
Displayed as:
 
{{rellink|This is a related article link.|extraclasses=boilerplate seealso}}
 
{{rellink|This is a related article link.|extraclasses=boilerplate seealso}}
 +
 +
=== Format link ===
 +
 +
<source lang="lua">
 +
mHatnote._formatLink(link, display)
 +
</source>
 +
 +
Formats <var>link</var> as a wikilink for display in hatnote templates, with optional display value <var>display</var>. Categories and files are automatically escaped with the [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
 +
 +
;Examples:
 +
: {{code|mHatnote._formatLink('Lion')|lua}} &rarr; <nowiki>[[Lion]]</nowiki> &rarr; {{format hatnote link|Lion}}
 +
: {{code|mHatnote._formatLink('Lion#Etymology')|lua}} &rarr; <nowiki>[[Lion#Etymology|Lion § Etymology]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology}}
 +
: {{code|mHatnote._formatLink('Category:Lions')|lua}} &rarr; <nowiki>[[:Category:Lions]]</nowiki> &rarr; {{format hatnote link|Category:Lions}}
 +
: {{code|mHatnote._formatLink('Lion#Etymology', 'Etymology of lion')|lua}} &rarr; <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology|Etymology of lion}}
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||

Revision as of 12:11, 24 April 2014

This is a meta-module that provides various functions for making hatnotes. It implements the {{hatnote}} template, for use in disambiguation hatnotes at the top of pages, and the {{rellink}} template, for use in making links to related articles directly under section headings. It also implements the {{format hatnote link}} template, which is used to format a wikilink for use in hatnotes.

Use from wikitext

The functions in this module cannot be used directly from #invoke, and must be used through templates instead. Please see Template:Hatnote, Template:Rellink and Template:Format hatnote link for documentation.

Use from other Lua modules

To load this module from another Lua module, use the following code.

local mHatnote = require('Module:Hatnote')

You can then use the functions as documented below.

Hatnote

mHatnote._hatnote(s)

Formats the string s as a hatnote. This encloses s in the tags <div class="dablink">...</div>. The CSS of the dablink class is defined in MediaWiki:Common.css.

Example
mHatnote._hatnote('This is a hatnote.')

Produces: <div class="dablink">This is a hatnote.</div>

Displays as:

Rellink

mHatnote._rellink(s, extraclasses)

Formats the string s as a "related articles" link. This encloses s in the tags <div class="rellink">...</div>. The CSS of the dablink class is defined in MediaWiki:Common.css. Extra classes can be added as the string extraclasses.

Example 1
mHatnote._rellink('This is a related article link.')

Produces: <div class="rellink">This is a related article link.</div>

Displays as: Template:Rellink

Example 2
mHatnote._rellink('This is a related article link.', 'boilerplate seealso')

Produces: <div class="rellink boilerplate seealso">This is a related article link.</div>

Displayed as: Template:Rellink

Format link

mHatnote._formatLink(link, display)

Formats link as a wikilink for display in hatnote templates, with optional display value display. Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section.

Examples
mHatnote._formatLink('Lion') → [[Lion]] → Lion
mHatnote._formatLink('Lion#Etymology') → [[Lion#Etymology|Lion § Etymology]] → Lion § Etymology
mHatnote._formatLink('Category:Lions') → [[:Category:Lions]] → Category:Lions
mHatnote._formatLink('Lion#Etymology', 'Etymology of lion') → [[Lion#Etymology|Etymology of lion]] → Etymology of lion