Module:About/doc
 | This is a documentation subpage for Module:About. It may contain usage information, categories and other content that is not part of the original module page. |
| This is a documentation subpage for Module:About. It may contain usage information, categories and other content that is not part of the original module page. |
 | This Lua module is used on 170,000+ pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
 | This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
 | This module depends on the following other modules: |
This module implements the {{about}} hatnote template.
Usage
[edit]- 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'.