Difference between revisions of "Module:About/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Nihiltres
m (Updated usage count and bumped template to {{high-risk}} as it's passed 100k)
blackwiki>Adem20
m (template)
Line 1: Line 1:
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
{{high-risk|106000+}}
 
{{high-risk|106000+}}
 +
{{Module rating|protected}}
  
 
This module implements the {{tl|about}} [[Wikipedia:Hatnote|hatnote]] template.
 
This module implements the {{tl|about}} [[Wikipedia:Hatnote|hatnote]] template.

Revision as of 14:57, 8 May 2017

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'.
    • pageTypeStrings Gives the page type string when provided by namespace. Defaults to {[0] = 'article', [14] = 'category'}.
    • defaultPageType Gives the page type string when neither the section argument nor the namespace provide the page type. Defaults to 'page'.