Module:About/doc
< Module:About
Jump to navigation
Jump to search
Revision as of 19:28, 6 February 2017 by blackwiki>Nihiltres (Updated usage count and bumped template to {{high-risk}} as it's passed 100k)
This is the documentation page for Module:About
| This Lua module is used on 136,000+ pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
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'.