Kulemba Module:Box-header/doc

<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Module rating|protected}}
{{High-use|11169}}
{{Lua|Module:Box-header/colours|Module:Color contrast}}

This module creates the header section for boxed content. It implements {{tl|box-header}}. It is intended to mainly be used in portals, but can also be used elsewhere.

== Usage ==
<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|boxHeader}}</code>
:For use in templates; calls <code>_boxHeader</code> with the parameters passed to the template as arguments.

<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|_boxHeader|args}}</code>
: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.)

<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|autoColour}}</code>
:For use in templates; calls <code>_autoColour</code> with the parameters passed to the template as arguments.

<code><nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|_autoColour|args}}</code>
: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 also==
{{portal templates navbox}}
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
<!-- Categories below this line, please; interwikis at Wikidata -->

}}</includeonly>