Module:Box-header/doc: Difference between revisions
Content deleted Content added
Added the page to Category:Module documentation pages |
add deps |
||
| Line 2: | Line 2: | ||
{{Module rating|protected}} |
{{Module rating|protected}} |
||
{{High-use|11169}} |
{{High-use|11169}} |
||
{{Lua|Module:Box-header/colours|Module:Color contrast}} |
{{Lua|Module:Box-header/colours|Module:Color contrast|Module:Arguments}} |
||
{{Uses TemplateStyles|Module:Box-header/styles.css}} |
|||
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. |
||
Latest revision as of 04:54, 2 June 2025
 | 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 depends on the following other modules: |
 | This module uses TemplateStyles: |
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
[edit]{{#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.)
