Module:About/doc: Difference between revisions
(Transcluded the TM:Documentation subpage template directly so it adds Category:Module documentation pages. See phab:T289404.) |
m (1 revision imported: Initial setup) |
(No difference)
| |
Latest revision as of 17:54, 31 August 2024
 | This is a documentation subpage for Module:About. It contains usage information, categories and other content that is not part of the original Module page. |
 | This Lua module is used on approximately 109,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this module should first be tested in its /sandbox or /testcases subpages. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | Uses Lua: |
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'.