Template:Fc: Difference between revisions

From Step Mods | Change The Game
mNo edit summary
Line 17: Line 17:


=== Required Parameters ===
=== Required Parameters ===
<span class="salmontx">'''title'''</span> - Sets the title
This template uses 'anonymous' parameters, which means that all are required and must appear in a particular order as follows:
<span class="salmontx">'''First Prameter - color'''</span> - Sets the color of text
: '''Values'''
: '''Values'''
:: Default: n/a, <code>title=''TitleHere''</code>
:: See Color Table


=== Optional Parameters ===
<span class="salmontx">'''Second Prameter - text'''</span> - Sets the text to be colored
<span class="salmontx">'''logo'''</span> - Displays a logo to the left of the content
: '''Values'''
: '''Values'''
:: Default: <code>logo=delta</code>
:: Free text
:* ''delta''
:* fo3
:* fo4
:* fnv
:* mo, mo2
:* morrowind
:* nomanssky
:* oblivion
:* nomanssky, nms
:* skyrim, skyrimle
:* skyrimse


<span class="salmontx">'''subtitle'''</span> - Sets a subtitle
=== Optional Parameters ===
: '''Values'''
Not applicable.
:: Default: n/a, <code>subtitle=''SubtitleHere''</code>


<span class="salmontx">'''author'''</span> - Sets a subtitle
== Color Table ==
: '''Values'''
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. The keywords are required for the template and will produce their respective colors.
:: Default: n/a, <code>author=''Author(s)Here''</code>
 
<span class="salmontx">'''forumtid'''</span> - Sets a forum link if a support forum exists for the page. The <uniqueForumID> is found in the forum topic's URL:<br>{{Fc|dim|<nowiki>https://stepmodifications.org/forum/topic/</nowiki>{{Fc|yellow|'''14917'''}}<nowiki>-system-setup-guide/</nowiki>}}
: '''Values'''
:: Default: n/a, <code>forumtid=''14917''</code>
 
==Examples==
===Default Call===
The simplest call returns defaults for the template.
: '''Code:''' <code><nowiki>{{PageTitle|title=Title Here}}</nowiki></code>
: '''Result:'''
:: {{Fc|Some text}}
<hr>
<hr>
 
===Parameters:===
: '''Template:''' <code><nowiki>{{Fc|keyword|displayedText}}</nowiki></code>
 
; {{Fc|red|''<nowiki>1 (color keyword)</nowiki>''}}
: This this the first ( {{{1}}} ) anonymous parameter. It accepts color keywords, which control the color of the text. The available keywords are in the table below.
: '''Default:''' ''blank'', which results in the inherited color displaying
: '''How to use:'''  <code><nowiki>{{Fc|notice|displayedText}}</nowiki></code>
 
; {{Fc|red|''<nowiki>2 / text</nowiki>''}}
: This is the second ( {{{2}}} ) anonymous parameter. It is the text that displays.
: '''Default:''' ''blank'', which results in no text being displayed.
: '''How to use:''' <code><nowiki>{{Fc|notice|BlahBlahBlah}}</nowiki></code>
:
:: By default, there is no need to name this parameter, however, there is a bug that exists when parsing the template that include "=" characters within this parameter. Essentially, the first instance of this character will break the template. To fix this, the second anonymous parameter is nested within a named parameter. Therefore, any time a "=" character has to be included within the displayed text, users will have to call the named parameter, {{Fc|red|'''''<nowiki>text</nowiki>'''''}}.
:: '''How to use:''' <code><nowiki>{{Fc|notice|text=BlahBlahBlah=3}}</nowiki></code>
 
=== Color Table ===
Only the colors listed below are available for use. The reason the colors are restricted is that the Wiki supports themes; thus, the available colors have been carefully selected to work with all available themes.
 
The following is a table of the colors supported by the Step Wiki. 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. The keywords are required for the template and will produce their respective colors, thus, have been included below with some usage information to guide users. Bad keywords will result in no effect, thus, the ''inherited'' text color from the ''parent'' will display.


{| class="wikitable mb-5"
{| class="wikitable mb-5"
|-
|-
! class="text-left" | Keywords
! class="text-left" | Keywords (first parameter)
! class="text-left" | Usage
! class="text-left" | Usage
|-
|-
Line 118: Line 71:
|}
|}


== Examples ==
==Examples==
===Default Call===
No applicable (all parameters must be specified)
 
===Fully Specified===
'''Code:'''
'''Code:'''
<pre>{{fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}</pre>
<pre>{{Fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}</pre>
'''Result:''' {{fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}
'''Result:''' {{Fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}


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


'''Code:'''
'''Code:'''
<pre>{{fc|highlight|text=Use the ''text'' parameter when "=" characters are used.}}</pre>
<pre>{{Fc|highlight|text=Use the ''text'' parameter when "=" characters are used.}}</pre>
'''Result:''' {{fc|highlight|text=Use the ''text'' parameter when "=" characters are used.}}
'''Result:''' {{Fc|highlight|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|Bad key words}} don't affect text color.</pre>
'''Result:''' {{fc|nonsense|Bad key words}} don't affect text color.
'''Result:''' {{Fc|nonsense|Bad key words}} don't affect text color.


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

Revision as of 15:23, 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.

Required Parameters[edit source]

This template uses 'anonymous' parameters, which means that all are required and must appear in a particular order as follows: First Prameter - color - Sets the color of text

Values
See Color Table

Second Prameter - text - Sets the text to be colored

Values
Free text

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. The keywords are required for the template and will produce their respective colors.

Keywords (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, brighter Emphasis within normal text or additional emphasis within instruction sets, etc.
dimmer, dim 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|highlight|text=Use the ''text'' parameter when "=" characters are used.}}

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

Code: 

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

Result: Bad key words don't affect text color.

See Also[edit source]

Template:Fs
Site Color Pallet

Retrieved from "https://stepmodifications.org/wiki/index.php?title=Template:Fc&oldid=165544"