Template:Fc: Difference between revisions

From Step Mods | Change The Game
mNo edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
<includeonly><span class="{{#switch:{{lc:{{{1|}}}}}
<includeonly><span class="{{#switch:{{lc:{{{1|}}}}}
| red | warning | warn = redtx
| red | warn | warning = redtx
| salmon | instruction | heading = salmontx
| salmon | instruction | heading | note | notice = salmontx
| orange = orangetx
| orange = orangetx
| yellow | issue = yellowtx
| yellow | issue = yellowtx
| chartr | bug = chartrtx
| chartr | bug = chartrtx
| green = greentx
| green = greentx
| blue | notice = bluetx
| blue = bluetx
| purple | dev = purpletx
| purple | dev = purpletx
| magenta = magenttx
| magenta = magenttx
Line 26: 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 (this parameter can also be 'named' if the text to be clored includes an equal ('=') symbol)
:: Free text (this parameter can also be 'named' if the text to be colored includes an equal ('=') symbol)


=== Optional Parameters ===
=== Optional Parameters ===
Line 39: Line 39:
! class="text-left" | Usage
! class="text-left" | Usage
|-
|-
| {{Template:Fc|red|red, warning}}   
| {{Template:Fc|red|red, warn, warning}}   
| Warning text without an "Alert" template, dropped mods, required elements, etc.
| Warning text without an "Alert" template, dropped mods, required elements, etc.
|-
|-
| {{Template:Fc|salmon|salmon, instruction, heading}}
| {{Template:Fc|salmon|salmon, instruction, heading, note, notice}}
| Emphasis within instruction sets, alterative color for headings, etc.
| Should be the most prevalent "callout" text color for notes and special instructions. Preferred over [[:Template:AlertSmall]]
|-
|-
| {{Template:Fc|orange|orange}}
| {{Template:Fc|orange|orange}}
Line 52: Line 52:
|-
|-
| {{Template:Fc|chartr|chartr, bug}}
| {{Template:Fc|chartr|chartr, bug}}
| Call out bugs, etc.
| Chartreuse text; can represent 'bug' notes, etc.
|-
|-
| {{Template:Fc|green|green}}
| {{Template:Fc|green|green}}
| Call attention to additions, etc.
| Green text
|-
|-
| {{Template:Fc|blue|blue, notice}}
| {{Template:Fc|blue|blue}}
| Notice text without an "Alert" template, etc.<br>{{fc|warning|''Try not to use this color for {{fc|notice|short phases}} as it can resemble {{fc|notice|links}}.''}}
| Use sparingly. {{fc|warning|''Do not use for {{fc|blue|short phases}} as it can resemble {{fc|blue|links}}.''}}
|-
|-
| {{Template:Fc|purple|purple, dev}}
| {{Template:Fc|purple|purple, dev, development}}
| Call out development, etc.
| Call out development, etc.
|-
|-
| {{Template:Fc|magenta|magenta}}
| {{Template:Fc|magenta|magenta}}
| Unknown, but it was requested by users.
| Magenta text.
|-
|-
| {{Template:Fc|highlight|highlight, important, bright, brighter}}
| {{Template:Fc|highlight|highlight, important, bright, brighter}}
| Emphasis within normal text or additional emphasis within instruction sets, etc.
| Secondary emphasis within normal text (salmon preferred), instructions, and notes
|-
|-
| {{Template:Fc|dim|dim, dimmer}}
| {{Template:Fc|dim|dim, dimmer}}
| Sub/Sup text, etc.
| Subtle text used for de-emphasis
|}
|}


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


== See Also ==
== See Also ==
[[:Template:Fs]]<br>
[[:Template:Fs]]<br>
[[Project:SiteColorPallet|Site Color Pallet]]
[[Project:SiteColorPallet|Site Color Usage]]
</noinclude>
</noinclude>

Latest revision as of 19:57, 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 colored 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, warn, warning Warning text without an "Alert" template, dropped mods, required elements, etc.
salmon, instruction, heading, note, notice Should be the most prevalent "callout" text color for notes and special instructions. Preferred over Template:AlertSmall
orange Call attention to changes such as updates or file moves, etc.
yellow, issue Call attention to issues, etc.
chartr, bug Chartreuse text; can represent 'bug' notes, etc.
green Green text
blue Use sparingly. Do not use for short phases as it can resemble links.
purple, dev, development Call out development, etc.
magenta Magenta text.
highlight, important, bright, brighter Secondary emphasis within normal text (salmon preferred), instructions, and notes
dim, dimmer Subtle text used for de-emphasis

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 Usage