Module:Further/doc

From Guild of Archivists
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

This is the documentation page for Module:Further

This module produces a "Further information: a, b and c" link. It implements the {{further}} template.

Usage from wikitext

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

Usage from other Lua modules

Load the module:

local mFurther = require('Module:Further')

You can then use the _further function like this:

mDetails._further(pages, options)

The pages argument should be a table of page link strings; if they use custom display values, each string should be preprocessed into a single piped string (e.g. page|display value). Links specifying a section are automatically formatted as page § section, rather than the MediaWiki default of page#section, if no custom display value is set.

The options argument is an optional configuration table. At current, the only option available is "selfref", which is used when the output is a self-reference to Wikipedia. to set this option, use {selfref = true}. (See the {{selfref}} template for more details on self-references.)

Example 1

mFurther._further({'A'})

Produces:

<div role="note" class="hatnote">Further information: [[A]]</div>

Displays as:

Further information: A

Example 2

mFurther._further({'A', 'B', 'C'})

Produces:

<div role="note" class="hatnote">Further information: [[A]], [[B]] and [[C]]</div>

Displays as:

Further information: A, B, and C

Example 3

mFurther._further({'A#D', 'B#D', 'C#D'}, {selfref = true})

Produces:

<div role="note" class="hatnote selfref">Further information: [[A#D|A § D]], [[B#D|B § D]] and [[B#D|C § D]]</div>

Displays as:

Further information: A § D, B § D, and C § D

Technical details

This module uses Module:Hatnote to format the hatnote text, Module:Hatnote list to process the list of links, and Module:Arguments to fetch the arguments from wikitext.