Template:Fc: Difference between revisions

From Step Mods | Change The Game
mNo edit summary
mNo edit summary
Line 15: Line 15:
==Purpose & Usage==
==Purpose & Usage==
This template is used to change text color in accordance with the [[Project:SiteColorPallet|site color pallet]]. Deviation from this template using inline styling or other means is not recommended.
This template is used to change text color in accordance with the [[Project:SiteColorPallet|site color pallet]]. Deviation from this template using inline styling or other means is not recommended.
{{Alert|text=Always use a 'named' second parameter (text) when using this template to color text that includes an equal ('=') symbol to avoid parser errors.}}


=== Required Parameters ===
=== Required Parameters ===
This template uses 'anonymous' parameters, which means that all are required and must appear in a particular order as follows:
This template uses 'anonymous' and optionally 'named' parameters, and all are required and must appear in a particular order.


<span class="salmontx">'''First Prameter - color'''</span> - Sets the color of text
<span class="salmontx">'''First Prameter - color'''</span> - Sets the color of text
Line 25: Line 26:
<span class="salmontx">'''Second Prameter - text'''</span> - Sets the text to be colored
<span class="salmontx">'''Second Prameter - text'''</span> - Sets the text to be colored
: '''Values'''
: '''Values'''
:: Free text
:: Free text (this parameter can also be 'named' if the text to be clored includes an equal ('=') symbol)


=== Optional Parameters ===
=== Optional Parameters ===
Line 35: Line 36:
{| class="wikitable mb-5"
{| class="wikitable mb-5"
|-
|-
! class="text-left" | Keywords (first parameter)
! class="text-left" | Key Words (first parameter)
! class="text-left" | Usage
! class="text-left" | Usage
|-
|-
Line 84: Line 85:


'''Code:'''
'''Code:'''
<pre>{{Fc|highlight|text=Use the ''text'' parameter when "=" characters are used.}}</pre>
<pre>{{Fc|green|text=Use the ''text'' parameter when "=" characters are used.}}</pre>
'''Result:''' {{Fc|highlight|text=Use the ''text'' parameter when "=" characters are used.}}
'''Result:''' {{Fc|green|text=Use the ''text'' parameter when "=" characters are used.}}


<hr class="my-5">
<hr class="my-5">


'''Code:'''
'''Code:'''
<pre>{{Fc|nonsense|Bad key words}} don't affect text color.</pre>
<pre>{{Fc|nonsense|Undefined parameter key words}} don't affect text color.</pre>
'''Result:''' {{Fc|nonsense|Bad key words}} don't affect text color.
'''Result:''' {{Fc|nonsense|Undefined parameter key words }} don't affect text color.


== See Also ==
== See Also ==

Revision as of 15:35, September 22, 2021

Forum Topic

Purpose & Usage[edit source]

This template is used to change text color in accordance with the site color pallet. Deviation from this template using inline styling or other means is not recommended.

Info-Logo.png

NOTE

Always use a 'named' second parameter (text) when using this template to color text that includes an equal ('=') symbol to avoid parser errors.

Required Parameters[edit source]

This template uses 'anonymous' and optionally 'named' parameters, and all are required and must appear in a particular order.

First Prameter - color - Sets the color of text

Values
See Color Table

Second Prameter - text - Sets the text to be colored

Values
Free text (this parameter can also be 'named' if the text to be clored includes an equal ('=') symbol)

Optional Parameters[edit source]

Not applicable.

Color Table[edit source]

The following is a table of the colors supported by the Step Wiki to maintain compatibility with site themes and colors. See the Site Color Usage for more in-depth information regarding the use of colors, including their Hex and CSS values, which will be useful for any custom development on user pages, theming, etc.

Key Words (first parameter) Usage
red, warning Warning text without an "Alert" template, dropped mods, required elements, etc.
salmon, instruction, heading Emphasis within instruction sets, alterative color for headings, etc.
orange Call attention to changes such as updates or file moves, etc.
yellow, issue Call attention to issues, etc.
chartr, bug Call out bugs, etc.
green Call attention to additions, etc.
blue, notice Notice text without an "Alert" template, etc.
Try not to use this color for short phases as it can resemble links.
purple, dev Call out development, etc.
magenta Unknown, but it was requested by users.
highlight, important, bright, brighter Emphasis within normal text or additional emphasis within instruction sets, etc.
dim, dimmer Sub/Sup text, etc.

Examples[edit source]

Default Call[edit source]

No applicable (all parameters must be specified)

Fully Specified[edit source]

Code:

{{Fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}

Result: The important part of an instruction is highlighted.


Code:

{{Fc|green|text=Use the ''text'' parameter when "=" characters are used.}}

Result: Use the text parameter when "=" characters are used.


Code:

{{Fc|nonsense|Undefined parameter key words}} don't affect text color.

Result: Undefined parameter key words don't affect text color.

See Also[edit source]

Template:Fs
Site Color Pallet