Difference between revisions of "Template:Footer Cargo/doc"

From Captain of Industry Wiki
Jump to: navigation, search
m (L32 moved page Template:Footer Cargo/doc to Template:Footer Cargo/doc: Name should better fit template's purpose.)
m
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{stub}}
{{Documentation subpage}}<!--
Add categories to the template itself where indicated at the bottom of this page.-->


This template is supposed to be invoked on top of every article and every template.
This template is supposed to be invoked on the bottom of '''every article''' and '''every template'''.
It checks if the page is directly or inderectly relevant to Cargo data definition.


<includeonly>
It checks if the page is directly or indirectly relevant to Cargo data definition and displays appropriate message box.
 
The usage is requested at the very bottom of pages, because of the mechanic used to detect data definition.
 
It abuses the fact, that every defining template sets a variable ''cargo_define_invoked''. In general, we can't know where exactly on a page data was defined. To be reliable, the check must occur at the end, after all transclusions are resolved.
 
{{Footer Cargo}}
<includeonly><!--
Add categories to the template itself below this line.-->
[[Category:Cargo management templates]]
[[Category:Cargo management templates]]
</includeonly><!--
</includeonly>
--><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 01:51, 1 May 2023

This template is supposed to be invoked on the bottom of every article and every template.

It checks if the page is directly or indirectly relevant to Cargo data definition and displays appropriate message box.

The usage is requested at the very bottom of pages, because of the mechanic used to detect data definition.

It abuses the fact, that every defining template sets a variable cargo_define_invoked. In general, we can't know where exactly on a page data was defined. To be reliable, the check must occur at the end, after all transclusions are resolved.