Module:Box-header/doc: Difference between revisions
Appearance
Content deleted Content added
navbox |
Dreamy Jazz (talk | contribs) add high use |
||
Line 1: | Line 1: | ||
{{Module rating|alpha}} |
{{Module rating|alpha}} |
||
{{high-use|9,703}} |
|||
<!-- 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]]) --> |
||
This module creates the header section for boxed content. It is intended to mainly be used in portals, but can also be used elsewhere. |
This module creates the header section for boxed content. It is intended to mainly be used in portals, but can also be used elsewhere. |
Revision as of 11:19, 5 September 2018
![]() | This Lua module is used on approximately 5,800 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
This module creates the header section for boxed content. It is intended to mainly be used in portals, but can also be used elsewhere.
Usage
{{#invoke:Box-header|boxHeader}}
- For use in templates; calls
_boxHeader
with the parameters passed to the template as arguments.
{{#invoke:Box-header|_boxHeader|args}}
- For use in modules; constructs the box header (and the start of the box body). The args are the parameters accepted by Template:Box-header. (The output may need to be expanded, depending on the values in the args.)
{{#invoke:Box-header|autoColour}}
- For use in templates; calls
_autoColour
with the parameters passed to the template as arguments.
{{#invoke:Box-header|_autoColour|args}}
- For use in modules; calculates appropriate colours for the the box header, and then constructs it using
_boxHeader
. The args are the parameters accepted by Template:Box-header colour – the same as for Template:Box-header, apart from those specifying colours and the title. (The output may need to be expanded, depending on the values in the args.)