Difference between revisions of "Module:About/doc"

From blackwiki
Jump to navigation Jump to search
(Blanked the page)
blackwiki>Chompy Ace
m (Reverted edits by 130.105.99.124 (talk) to last version by Nihiltres)
Line 1: Line 1:
 +
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 +
{{high-risk| 109000+ }}
 +
{{Module rating|protected}}
  
 +
This module implements the {{tl|about}} [[Wikipedia:Hatnote|hatnote]] template.
 +
 +
== Usage ==
 +
*The <code>about</code> function implements the {{tl|about}} template directly, using the frame and applying no options. This should probably only be used in {{tl|about}}.
 +
 +
*The <code>_about</code> 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:
 +
**<code>aboutForm</code> 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 <code>'This %s is about %s. '</code>.
 +
**<code>sectionString</code> Gives the page type string for when the named argument <code>section</code> is specified. Defaults to <code>'section'</code>.
 +
 +
<includeonly>{{Sandbox other||
 +
<!-- Categories below this line, please; interwikis at Wikidata -->
 +
[[Category:Hatnote modules]]
 +
}}</includeonly>

Revision as of 04:50, 27 December 2019

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

Usage

  • 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'.