Difference between revisions of "Module:About/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Stranger195
m (Replace {{#ifeq:}} with {{Sandbox other}})
blackwiki>Nihiltres
(→‎Usage: Deleted documentation of removed options)
Line 11: Line 11:
 
**<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>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>.
 
**<code>sectionString</code> Gives the page type string for when the named argument <code>section</code> is specified. Defaults to <code>'section'</code>.
**<code>pageTypeStrings</code> Gives the page type string when provided by namespace. Defaults to <code>{[0] = 'article', [14] = 'category'}</code>.
 
**<code>defaultPageType</code> Gives the page type string when neither the <code>section</code> argument nor the namespace provide the page type. Defaults to <code>'page'</code>.
 
  
 
<includeonly>{{Sandbox other||
 
<includeonly>{{Sandbox other||

Revision as of 16:13, 26 June 2018

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