Shawndouglas: Created as needed.

2016-08-19T19:25:44Z

Created as needed.

New page

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

== Use from wikitext ==

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

== Use from other Lua modules ==

Load the module:

<source lang="lua">
local mBroader = require('Module:Broader')
</source>

You can then use the _broader function like this:

<source lang="lua">
mBroader._broader(page, topic, options)
</source>

The <var>page</var> 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 <var>topic</var> variable is a description of the topic, and is optional. The default topic value is "this topic".

The <var>options</var> 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 {{code|1={selfref = true}|2=lua}}. (See the {{tl|selfref}} template for more details on self-references.)

; Example 1
<source lang="lua">
mBroader._broader('Carbon dioxide data')
</source>
Produces:
:<code><nowiki><div class="hatnote">For a broader coverage related to this topic, see [[Carbon dioxide data]].</div></nowiki></code>
Displays as:
{{broader|Carbon dioxide data}}

; Example 2
<source lang="lua">
mBroader._broader('Carbon dioxide data', 'the physical properties of carbon dioxide')
</source>
Produces:
:<code><nowiki><div class="hatnote">For a broader coverage related to the physical properties of carbon dioxide, see [[Carbon dioxide data]].</div></nowiki></code>
Displays as:
{{broader|Carbon dioxide data|the physical properties of carbon dioxide}}

== Technical details ==

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

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||


}}</includeonly>

Module:Broader/doc - Revision history

Shawndouglas: Created as needed.