Template:Abbreviation: Difference between revisions

From Step Mods | Change The Game
(Created page with "<includeonly><span class="{{#switch:{{lc:{{{1|}}}}} | red | warn | warning = redtx | salmon | instruction | heading | note | notice = salmontx | orange = orangetx | yellow | i...")
 
mNo edit summary
Line 1: Line 1:
<includeonly><span class="{{#switch:{{lc:{{{1|}}}}}
<includeonly>{{#switch:{{lc:{{{1|}}}}}
| red | warn | warning = redtx
| BeyondSkyrim | Beyond Skyrim = BYS
| salmon | instruction | heading | note | notice = salmontx
Fallout3 | Fallout 3 = FO3
| orange = orangetx
Fallout4 | Fallout 4 = FO4
| yellow | issue = yellowtx
FalloutNV | Fallout New Vegas = FNV
| chartr | bug = chartrtx
Morroblivion | Morroblivion = MOB
| green = greentx
Morrowind | Morrowind = MOR
| blue = bluetx
Oblivion | Oblivion = OBL
| purple | dev = purpletx
Skyblivion | Skyblivion = SKB
| magenta = magenttx
SkyrimLE | Skyrim Legendary Edition = SLE
| important | highlight | bright | brighter = hltx
SkyrimSE | Skyrim Special Edition = SSE
| dim | dimmer = dimtx
SkyrimVR | Skyrim VR = SVR
| #default = }}">{{{text|{{{2|}}}}}}</span></includeonly><noinclude>__NOTOC__ [[Category:Formatting Templates]][https://stepmodifications.org/forum/topic/9769-font-color/ '''Forum Topic''']
Skywind | Skywind = SKW
NoMansSky | No Man's Sky = NMS}}</includeonly><noinclude>__NOTOC__ [[Category:Helper Templates]]<!--[https://stepmodifications.org/forum/topic/9769-font-color/ '''Forum Topic''']-->


==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.
Used to provide common abbreviations for games so that guides and other common markup can be shared across GameSpaces ([[Property:Game]]).  
{{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' and optionally 'named' parameters, and all are required and must appear in a particular order.  
This template uses a single 'anonymous' parameter.  
 
<span class="salmontx">'''First Prameter - color'''</span> - Sets the color of text
: '''Values'''
:: See Color Table
 
<span class="salmontx">'''Second Prameter - text'''</span> - 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 ===
=== Optional Parameters ===
Not applicable.
Not applicable.
== 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 mb-5"
|-
! class="text-left" | Key Words (first parameter)
! class="text-left" | Usage
|-
| {{Template:Fc|red|red, warn, warning}} 
| Warning text without an "Alert" template, dropped mods, required elements, etc.
|-
| {{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|orange}}
| Call attention to changes such as updates or file moves, etc.
|-
| {{Template:Fc|yellow|yellow, issue}}
| Call attention to issues, etc.
|-
| {{Template:Fc|chartr|chartr, bug}}
| Chartreuse text; can represent 'bug' notes, etc.
|-
| {{Template:Fc|green|green}}
| Green text
|-
| {{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, dev, development}}
| Call out development, etc.
|-
| {{Template:Fc|magenta|magenta}}
| Magenta text.
|-
| {{Template:Fc|highlight|highlight, important, bright, brighter}}
| Secondary emphasis within normal text (salmon preferred), instructions, and notes
|-
| {{Template:Fc|dim|dim, dimmer}}
| Subtle text used for de-emphasis
|}


==Examples==
==Examples==
===Default Call===
===Default Call===
No applicable (all parameters must be specified)
No applicable


===Fully Specified===
===Fully Specified===
'''Code:'''
'''Code:'''
<pre>{{Fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}</pre>
<pre>{{GameAbbreviation|Fallout 3}}</pre>
'''Result:''' {{Fc|instruction|The {{Fc|highlight|important part}} of an instruction is highlighted.}}
'''Result:''' {{GameAbbreviation|Fallout 3}}


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


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


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


'''Code:'''
'''Code:'''
<pre>{{Fc|nonsense|Undefined parameter key words}} don't affect text color.</pre>
<pre>{{GameAbbreviation|No Man's Sky}}</pre>
'''Result:''' {{Fc|nonsense|Undefined parameter key words}} don't affect text color.
'''Result:''' {{GameAbbreviation|No Man's Sky}}


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

Revision as of 14:44, November 18, 2021


Purpose & Usage[edit source]

Used to provide common abbreviations for games so that guides and other common markup can be shared across GameSpaces (Property:Game).

Required Parameters[edit source]

This template uses a single 'anonymous' parameter.

Optional Parameters[edit source]

Not applicable.

Examples[edit source]

Default Call[edit source]

No applicable

Fully Specified[edit source]

Code: 

{{GameAbbreviation|Fallout 3}}

Result: Template:GameAbbreviation

Code: 

{{GameAbbreviation|Fallout3}}

Result: Template:GameAbbreviation

Code: 

{{GameAbbreviation|No Man's Sky}}

Result: Template:GameAbbreviation

See Also[edit source]

not applicable



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