Template:Race rule/Documentation: Difference between revisions

Template page
m (→‎Usage: add how to use equals)
m (fix documentation for including a category)
 
Line 2: Line 2:


==Usage==
==Usage==
''Note: examples have to be displayed using manual HTML to avoid adding this documentation page and itself to the category.''
<pre>
<pre>
{{race rule|The reason it is a race rule}}
{{race rule|The reason it is a race rule}}
</pre>
</pre>


{{race rule|The reason it is a race rule}}
<div class="tag-header noprint bg-danger text-danger race-rule"><p><b>This is an important racing rule!</b> If you do not follow it, you may be disqualified from a race.</p><p style="font-size:smaller"><b>Reason</b>: The reason it is a race rule</p><div style="clear: both;"></div></div>


<pre>
<pre>
Line 12: Line 14:
</pre>
</pre>


{{race rule|The reason it is a race rule|rule=The important rule}}
<div class="tag-header noprint bg-danger text-danger race-rule"><p><b>This is an important racing rule!</b> If you do not follow it, you may be disqualified from a race.</p><p style="font-size:smaller"><b>The important rule</b>: The reason it is a race rule</p><div style="clear: both;"></div></div>


===Need to Use Equals===
===Need to Use Equals===
Line 21: Line 23:
</pre>
</pre>


{{race rule|1=The reason it is a race rule. This Rule = Important|rule=The important rule}}
<div class="tag-header noprint bg-danger text-danger race-rule"><p><b>This is an important racing rule!</b> If you do not follow it, you may be disqualified from a race.</p><p style="font-size:smaller"><b>The important rule</b>: The reason it is a race rule. This Rule = Important</p><div style="clear: both;"></div></div>

Latest revision as of 07:11, 27 February 2022

Marks a section of a page as a racing rule that if not followed will result in disqualification in a race.

Usage

Note: examples have to be displayed using manual HTML to avoid adding this documentation page and itself to the category.

{{race rule|The reason it is a race rule}}

This is an important racing rule! If you do not follow it, you may be disqualified from a race.

Reason: The reason it is a race rule

{{race rule|The reason it is a race rule|rule=The important rule}}

This is an important racing rule! If you do not follow it, you may be disqualified from a race.

The important rule: The reason it is a race rule

Need to Use Equals

If the reason you are including includes an equals sign, the easiest way to keep the template working is to explicitly number the unnamed parameter with 1=

{{race rule|1=The reason it is a race rule. This Rule = Important|rule=The important rule}}

This is an important racing rule! If you do not follow it, you may be disqualified from a race.

The important rule: The reason it is a race rule. This Rule = Important