Template:Fc: Difference between revisions

Latest revision as of 19:57, September 22, 2021

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.

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.

@@ Line 1: / Line 1: @@
 <includeonly><span class="{{#switch:{{lc:{{{1|}}}}}
+| red | warn | warning = redtx
+| salmon | instruction | heading | note | notice = salmontx
+| orange = orangetx
+| yellow | issue = yellowtx
+| chartr | bug = chartrtx
+| green = greentx
+| blue = bluetx
+| purple | dev = purpletx
 | magenta = magenttx
-| purple = purpletx
+| important | highlight | bright | brighter = hltx
-| addition | enhancement | confirmation | blue = bluetx
+| dim | dimmer = dimtx
-| added | fix | functional | relevant | green = greentx
+| #default = }}">{{{text|{{{2|}}}}}}</span></includeonly><noinclude>__NOTOC__ [[Category:Formatting Templates]][https://stepmodifications.org/forum/topic/9769-font-color/ '''Forum Topic''']
-| chartreuse = chartrtx
-| issue | unknown | yellow = yellowtx
-| instruction | ilheading | salmon | notice = salmontx
-| change | merged | modification | updated | orange = orangetx
-| dropped | removal | replaced | non-functional | warning | irrelevant | red = redtx
-| important | highlight = hltx
-| dimmer = dimtx
-| #default = }}">{{{2}}}</span></includeonly><noinclude>__NOTOC__ [[Category:Formatting Templates]]
 ==Purpose & Usage==
-This template is used to change text color. 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.}}
-===Parameters:===
+=== Required Parameters ===
-: '''Template:''' <code><nowiki>{{Fc|keyword|text=}}</nowiki></code>
+This template uses 'anonymous' and optionally 'named' parameters, and all are required and must appear in a particular order.
-; {{Fc|red|''<nowiki>keyword</nowiki>''}}
+<span class="salmontx">'''First Prameter - color'''</span> - Sets the color of text
-: This is the keyword used to control the color of the text. The available keywords are in the table below.
+: '''Values'''
-: '''How to use:''' <code>notice</code>
+:: See Color Table
-; {{Fc|red|''<nowiki>text</nowiki>''}}
+<span class="salmontx">'''Second Prameter - text'''</span> - Sets the text to be colored
-: This is the text that displays.
+: '''Values'''
-: '''How to use:''' <code>text=BlahBlahBlah</code>
+:: Free text (this parameter can also be 'named' if the text to be colored includes an equal ('=') symbol)
-=== Color Table ===
+=== Optional Parameters ===
-Only the colors listed below are available for use. The reason the colors are restricted is because the Wiki supports themes; thus, the available colors have been carefully selected to work with all available themes.
+Not applicable.
-The following keywords will produce their respective colors. At least one keyword is provided beyond the "color" keyword. These additional keywords help to specify the situations in which their respective colors are used. Bad keywords will result in no effect, thus, the ''parent'' text color will display.
+== Color Table ==
+The following is a table of the colors supported by the Step Wiki to maintain compatibility with site themes and colors. See the [[Project:SiteColorPallet|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.
-{| class="wikitable"
+{| class="wikitable mb-5"
 |-
-! Key Words
+! class="text-left" | Key Words (first parameter)
+! class="text-left" | Usage
 |-
-| {{Template:Fc|red|removal, non-functional, irrelevant, warning, red}}
+| {{Template:Fc|red|red, warn, warning}}
+| Warning text without an "Alert" template, dropped mods, required elements, etc.
 |-
-| {{Template:Fc|salmon|instruction, ilheading{{Template:Fc|highlight|<sup>1</sup>}}, salmon, notice}}
+| {{Template:Fc|salmon|salmon, instruction, heading, note, notice}}
+| Should be the most prevalent "callout" text color for notes and special instructions. Preferred over [[:Template:AlertSmall]]
 |-
-| {{Template:Fc|orange|change, modification, orange}}
+| {{Template:Fc|orange|orange}}
+| Call attention to changes such as updates or file moves, etc.
 |-
-| {{Template:Fc|yellow|issue, unknown, yellow}}
+| {{Template:Fc|yellow|yellow, issue}}
+| Call attention to issues, etc.
 |-
-| {{Template:Fc|chartreuse|chartreuse}}
+| {{Template:Fc|chartr|chartr, bug}}
+| Chartreuse text; can represent 'bug' notes, etc.
 |-
-| {{Template:Fc|green|fix, functional, relevant, green}}
+| {{Template:Fc|green|green}}
+| Green text
 |-
-| {{Template:Fc|blue|addition, enhancement, confirmation, blue}}
+| {{Template:Fc|blue|blue}}
+| Use sparingly. {{fc|warning|''Do not use for {{fc|blue|short phases}} as it can resemble {{fc|blue|links}}.''}}
 |-
-| {{Template:Fc|purple|purple}}
+| {{Template:Fc|purple|purple, dev, development}}
+| Call out development, etc.
 |-
 | {{Template:Fc|magenta|magenta}}
+| Magenta text.
 |-
-| {{Template:Fc|highlight|important, highlight}}
+| {{Template:Fc|highlight|highlight, important, bright, brighter}}
-|-
+| Secondary emphasis within normal text (salmon preferred), instructions, and notes
-| {{Template:Fc|dimmer|dimmer}}
 |-
-| colspan="2" | {{Template:Fc|highlight|<sup>1</sup>}}{{Fs|.8em|Only use this for "inline headings," which begin a paragraph instead of being on their own line.}}
+| {{Template:Fc|dim|dim, dimmer}}
+| Subtle text used for de-emphasis
 |}
 ==Examples==
+===Default Call===
+No applicable (all parameters must be specified)
+===Fully Specified===
 '''Code:'''
-<pre>{{Fc|instruction|The {{Fc|important|important part}} of an instruction is highlighted.}}</pre>
+<pre>{{Fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}</pre>
-'''Result:'''
+'''Result:''' {{Fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}
-{{Fc|instruction|The {{Fc|important|important part}} of an instruction is highlighted.}}
-<hr class="mx-5">
+<hr class="my-5">
 '''Code:'''
-<pre>{{Fc|nonsense|Bad key words}} don't affect text color.</pre>
+<pre>{{Fc|green|text=Use the ''text'' parameter when "=" characters are used.}}</pre>
-'''Result:'''
+'''Result:''' {{Fc|green|text=Use the ''text'' parameter when "=" characters are used.}}
-{{Fc|nonsense|Bad key words}} don't affect text color.
+<hr class="my-5">
+'''Code:'''
+<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.
 == See Also ==
-[[:Template:Fs]]
+[[:Template:Fs]]<br>
+[[Project:SiteColorPallet|Site Color Usage]]
 </noinclude>

Template:Fc: Difference between revisions

Latest revision as of 19:57, September 22, 2021

Purpose & Usage[edit source]

Required Parameters[edit source]

Optional Parameters[edit source]

Color Table[edit source]

Examples[edit source]

Default Call[edit source]

Fully Specified[edit source]

See Also[edit source]