Template:Alert: Difference between revisions
From Step Mods | Change The Game
m (Text replacement - "chartreuse" to "chartr") |
mNo edit summary |
||
Line 1: | Line 1: | ||
<includeonly>{{#vardefine:color|{{#switch:{{lc:{{{type|}}}}} | {{TOC}}<includeonly>{{#vardefine:color|{{#switch:{{lc:{{{type|}}}}} | ||
|bug=mgreen | |bug=mgreen | ||
|construction= | |wip | ||
|mcm= | |construction=morange | ||
|mo= | |loot=myellow | ||
|mcm=msalmon | |||
|mo2 | |||
|mo=mpurple | |||
|note | |||
|notice=mblue | |notice=mblue | ||
|warn | |||
|warning=mred | |warning=mred | ||
|#default=mblue}}}} | |#default=mblue}}}}<div class="{{{bgcolor|{{#var:color}}}}}bg d-flex mx-5 my-3 stepalert neutbd hltx">[[File:{{#switch:{{{icon|{{lc:{{{type}}}}}}}} | ||
|bug=Bug-Logo.png | |bug=Bug-Logo.png | ||
|wip | |||
|construction=Weapon.png | |construction=Weapon.png | ||
|loot=loot.png | |||
|mcm=Mcmicon1.png | |mcm=Mcmicon1.png | ||
|mo2 | |||
|mo=Moicon.png | |mo=Moicon.png | ||
|note | |||
|notice=Info-Logo.png | |notice=Info-Logo.png | ||
|warn | |||
|warning=Warning-Logo.png | |warning=Warning-Logo.png | ||
|#default={{{icon|Info-Logo.png}}}}}|35px]] | |#default={{{icon|Info-Logo.png}}}}}|35px]]<div class="ml-2"><p class="h4">'''{{#switch:{{{type|}}} | ||
|bug= | |bug=BUG | ||
|construction= | |wip | ||
|mcm= | |construction=WIP | ||
|mo= | |loot=LOOT | ||
|notice= | |mcm=MCM | ||
|warning= | |mo2 | ||
|#default= | |mo=MO2 | ||
|note | |||
|notice=NOTE | |||
|warn | |||
</includeonly><noinclude> | |warning=WARNING | ||
|#default=NOTE}}'''</p> | |||
{{{text}}}</div></div></includeonly><noinclude> | |||
== Purpose & Usage == | == Purpose & Usage == | ||
This template displays a | This template displays a standard and prominent alert message. This alert should be used sparingly and is NOT intended for use within lists. For brief and prominent alerts suitable for use within lists, use [[:Template:AlertSmall]] instead. | ||
=== Required Parameters === | === Required Parameters === | ||
<span class="salmontx">'''type'''</span> - Sets the type of alert, which dictates icon and color | |||
: '''Values''' | |||
:: Default: <code>type=notice</code> | |||
: | :* bug | ||
::* | :* wip or construction - work in progress | ||
:* loot - LOOT specific | |||
:* mcm - Mod Confuguration Manager specific | |||
:* mo or mo2 - Mod Organizer 2 specific | |||
:* ''note'' or ''notice'' | |||
:* warn or warning | |||
<span class="salmontx">'''text'''</span> - The alert message | |||
: | : '''Values''' | ||
:: Default: n/a, <code>text=''ContentHere''</code> | |||
=== Optional Parameters === | === Optional Parameters === | ||
<span class="salmontx">'''icon'''</span> - Determines the icon used | |||
: '''Values''' | |||
: | :: Default: <code>icon=notice</code> | ||
: | :* bug | ||
::* | :* wip or construction | ||
::* | :* loot | ||
::* ''' | :* mcm | ||
:* mo or mo2 | |||
:* ''note'' or ''notice'' | |||
:* warn or warning | |||
==Examples== | |||
===Default Call=== | |||
The simplest call returns defaults for the template. | |||
: '''Code:''' <code><nowiki>{{Alert|text=Your text here.}}</nowiki></code> | |||
== Examples == | |||
=== | |||
: '''Code:''' | |||
: '''Result:''' | : '''Result:''' | ||
{{Alert | :: {{Alert|text=Your text here.}} | ||
:: {{Alert|text=Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam condimentum pretium tellus nec scelerisque. Nam nisi magna, venenatis at nibh quis, consequat pretium velit. Mauris fringilla mollis molestie. Fusce tellus justo, tempor id efficitur non, dapibus eu nunc. Integer nec hendrerit diam. Quisque aliquet nunc id vestibulum tincidunt. Vivamus dictum rutrum dolor auctor commodo.}} | |||
... | |||
=== | === Including Lists === | ||
: '''Code:''' | : '''Code:''' | ||
<pre>{{Alert|text=Using wiki markup like lists with this alert is appropriate. | |||
# For numbered | |||
#* Bulleted | |||
#: or mixed lists | |||
Behavior should mimic body text. | |||
}}</pre> | |||
: '''Result:''' | : '''Result:''' | ||
{{Alert | :: {{Alert|text=Using wiki markup like lists with this alert is appropriate. | ||
# For numbered | |||
#* Bulleted | |||
#: or mixed lists | |||
Behavior should mimic body text. | |||
}} | |||
=== | === Types === | ||
: '''Code:''' | The simplest call returns defaults for the template. | ||
: '''Code:''' <code><nowiki>{{Alert|type=bug|text=Your text here.}}</nowiki></code> | |||
: '''Result:''' | : '''Result:''' | ||
{{Alert|type=construction|text= | :: {{Alert|type=bug|text=Bug message}} | ||
:: {{Alert|type=wip|text=Under construction (WIP) message}} | |||
:: {{Alert|type=loot|text=Loot-specific message}} | |||
:: {{Alert|type=mcm|text=MCM-specific message}} | |||
:: {{Alert|type=mo|text=MO2-specific message}} | |||
:: {{Alert|type=warn|text=Warning message}} | |||
== | == Related Templates == | ||
: | *[[:Template:AlertSmall]] - A more subtle version suitable for brief messages or messages within lists. | ||
</noinclude> | |||
Revision as of 20:10, July 25, 2021
Purpose & Usage[edit source]
This template displays a standard and prominent alert message. This alert should be used sparingly and is NOT intended for use within lists. For brief and prominent alerts suitable for use within lists, use Template:AlertSmall instead.
Required Parameters[edit source]
type - Sets the type of alert, which dictates icon and color
- Values
- Default:
type=notice
- bug
- wip or construction - work in progress
- loot - LOOT specific
- mcm - Mod Confuguration Manager specific
- mo or mo2 - Mod Organizer 2 specific
- note or notice
- warn or warning
- Default:
text - The alert message
- Values
- Default: n/a,
text=ContentHere
- Default: n/a,
Optional Parameters[edit source]
icon - Determines the icon used
- Values
- Default:
icon=notice
- bug
- wip or construction
- loot
- mcm
- mo or mo2
- note or notice
- warn or warning
- Default:
Examples[edit source]
Default Call[edit source]
The simplest call returns defaults for the template.
- Code:
{{Alert|text=Your text here.}}
- Result:
NOTE
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam condimentum pretium tellus nec scelerisque. Nam nisi magna, venenatis at nibh quis, consequat pretium velit. Mauris fringilla mollis molestie. Fusce tellus justo, tempor id efficitur non, dapibus eu nunc. Integer nec hendrerit diam. Quisque aliquet nunc id vestibulum tincidunt. Vivamus dictum rutrum dolor auctor commodo.Including Lists[edit source]
- Code:
{{Alert|text=Using wiki markup like lists with this alert is appropriate. # For numbered #* Bulleted #: or mixed lists Behavior should mimic body text. }}
- Result:
NOTE
Using wiki markup like lists with this alert is appropriate.
- For numbered
- Bulleted
- or mixed lists
Types[edit source]
The simplest call returns defaults for the template.
- Code:
{{Alert|type=bug|text=Your text here.}}
- Result:
Related Templates[edit source]
- Template:AlertSmall - A more subtle version suitable for brief messages or messages within lists.