Module:Box-header/doc: Difference between revisions
Content deleted Content added
Dreamy Jazz (talk | contribs) add high use |
m Typo/general fixes, replaced: the the → the |
||
| Line 3: | Line 3: | ||
<!-- 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. |
||
== Usage == |
== Usage == |
||
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|boxHeader}}</code> |
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|boxHeader}}</code> |
||
| Line 14: | Line 15: | ||
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|_autoColour|args}}</code> |
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|_autoColour|args}}</code> |
||
:For use in modules; calculates appropriate colours for |
:For use in modules; calculates appropriate colours for the box header, and then constructs it using <code>_boxHeader</code>. 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.) |
||
==See |
==See also== |
||
{{portal templates navbox}} |
{{portal templates navbox}} |
||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | | |
||
Revision as of 07:41, 4 October 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
_boxHeaderwith 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
_autoColourwith the parameters passed to the template as arguments.
{{#invoke:Box-header|_autoColour|args}}
- For use in modules; calculates appropriate colours for 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.)
