Module:About/doc

This is the documentation page for Module:About

This module uses material from the Wikipedia module Module:About/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors).

This module is rated as ready for general use. It has reached a mature form and is thought to be bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Ricochet Wiki resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing.

This module implements the {{about}} hatnote template.

Usage[edit source]

The about function implements the {{about}} template directly, using the frame and applying no options. This should probably only be used in {{about}}.

The _about function can be used from Lua to supply a custom arguments list (its first argument) and/or an options table (its second argument). Options include:
- aboutForm A string that can be used to substitute the form of the initial "about" message. It should include two substitution points: the first for the page type (e.g. "article"), and the second for the description of what the page is about. It should also include a trailing space for easy concatenation or omission. Defaults to 'This %s is about %s. '.
- sectionString Gives the page type string for when the named argument section is specified. Defaults to 'section'.