Difference between revisions of "Module:About/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Paine Ellsworth
m (update /doc)
blackwiki>Stranger195
m (Replace {{#ifeq:}} with {{Sandbox other}})
Line 14: Line 14:
 
**<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>.
 
**<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>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
<includeonly>{{Sandbox other||
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Hatnote modules]]
 
[[Category:Hatnote modules]]
 
}}</includeonly>
 
}}</includeonly>

Revision as of 09:46, 12 April 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'.
    • 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'.