Module:Format link/doc

This module, migrated from origins in Module:Hatnote, provides functionality for formatting links for display, including that powering the format link template.

It can pretty-format section links with the section symbol ("§") and appropriate whitespace, it automatically escapes category and file names with the colon trick, and includes functionality for italicizing the page or section name, and for detecting and categorizing results that produce red links.

Use from wikitext
The functions in this module cannot be used directly from #invoke, and must be used through templates instead. Please see Template:Format link for documentation on usage of that template.

Use from other Lua modules
To load this module from another Lua module, use the following code:

You can then use the functions as documented below.

_formatLink
Formats link as a wikilink. 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.

Several options modify the output:
 * If the display value is present, then it will be used as a display value. Any manual piping (using the  magic word or similar) present in link will be overridden by the display value if present.
 * If the target value is present, then it will override link as a target, but the result will still be displayed using either the value from display, or the result of formatting link.
 * If italicizePage is true, then the page portion of the link is italicized if present.
 * If italicizeSection is true, then the section portion of the link is italicized if present.
 * If categorizeMissing is a non-empty string, then that value is used as a category name, and that category will be applied if the resulting target of the link (no matter whether through link or through target ) doesn't exist.


 * Examples:
 * &rarr; Foo §&amp;nbsp;Bar &rarr;
 * &rarr; Qux &rarr;
 * &rarr; Baz &rarr;
 * &rarr; §&amp;nbsp;Foo &rarr;
 * &rarr; The Lord of the Rings §&amp;nbsp;Plot &rarr;
 * &rarr; Cybercrime Prevention Act of 2012 §&amp;nbsp;Disini v. Secretary of Justice &rarr;
 * &rarr; Nonexistent page &rarr;
 * &rarr; Existing &rarr;

formatPages
This derived function is useful for lists that format many links. It formats an array of pages using the _formatLink function, and returns the result as an array. Options in the options table are applied, and use the same names as the options for _formatLink.


 * Example
 * mFormatLink.formatPages({categorizeMissing = 'Example'}, {'Foo#Bar', 'Nonexistent page'}) &rarr; {'Foo § Bar', 'Nonexistent page'}

Errors
If _formatLink is used and neither a link nor a target argument is provided, then the module will produce an error message instead of its usual output, as it cannot then produce valid output.

You can solve this error by providing appropriate parameters to _formatLink, or you may want to ensure that a more descriptive error is provided by a downstream template or module when it would otherwise call _formatLink with inadequate arguments.