Difference between revisions of "Module:Box-header/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Pppery
(Add link to template)
blackwiki>Pppery
m
Line 4: Line 4:
 
{{Lua|Module:Box-header/colours|Module:Color contrast}}
 
{{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.
+
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 ==
 
== Usage ==

Revision as of 00:46, 23 February 2019

This module creates the header section for boxed content. It implements {{box-header}}. 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 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.)

See also