Module:Broader/doc

From LIMSWiki
Jump to: navigation, search

This is the documentation page for Module:Broader

This module produces a "for a broader coverage related to this topic" link. It implements the {{broader}} template.

Use from wikitext

This module cannot be used directly from #invoke. Instead, it can only be used through the {{broader}} template. Please see the template page for documentation.

Use from other Lua modules

Load the module:

local mBroader = require('Module:Broader')

You can then use the _broader function like this:

mBroader._broader(page, topic, options)

The page variable is the page to be linked to, and is required. The page name can include a section link if desired. If the page includes a section link, it is automatically formatted as page § section, rather than the MediaWiki default of page#section.

The topic variable is a description of the topic, and is optional. The default topic value is "this topic".

The options table can be used to configure the function's output. At current, the only option available is "selfref", which is used when the output is a self-reference to LIMSwiki. to set this option, use ​{selfref = true}​. (See the {{selfref}} template for more details on self-references.)

Example 1
mBroader._broader('Carbon dioxide data')

Produces:

<div class="hatnote">For a broader coverage related to this topic, see [[Carbon dioxide data]].</div>

Displays as:

For a broader coverage related to this topic, see Carbon dioxide data.
Example 2
mBroader._broader('Carbon dioxide data', 'the physical properties of carbon dioxide')

Produces:

<div class="hatnote">For a broader coverage related to the physical properties of carbon dioxide, see [[Carbon dioxide data]].</div>

Displays as:

For a broader coverage related to the physical properties of carbon dioxide, see Carbon dioxide data.

Technical details

This module uses Module:Hatnote to format the hatnote text and Module:Arguments to fetch the arguments from wikitext.