Module:About/doc
< Module:About
Jump to navigation
Jump to search
Revision as of 17:11, 18 April 2016 by blackwiki>Nihiltres (Some basic documentation)
This is the documentation page for Module:About
| 26x26px | This module is rated as alpha. It is ready for third-party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
This module implements the {{about}} hatnote template.
Usage
- The
aboutfunction implements the {{about}} template directly, using the frame and applying no options. This should probably only be used in {{about}}.
- The
_aboutfunction can be used from Lua to supply a custom arguments list (its first argument) and/or an options table (its second argument). Options include:aboutFormA 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. '.sectionStringGives the page type string for when the named argumentsectionis specified. Defaults to'section'.pageTypeStringsGives the page type string when provided by namespace. Defaults to{[0] = 'article', [14] = 'category'}.defaultPageTypeGives the page type string when neither thesectionargument nor the namespace provide the page type. Defaults to'page'.