Template:AlertSmall: Difference between revisions

From Step Mods | Change The Game
mNo edit summary
(Separated the values more distinctly. Added ''Starfield'' as the first game parameter. Added small images to the ''Icon Optional'' list.)
 
Line 9: Line 9:
|note  
|note  
|notice=blue
|notice=blue
|starfield=blue
|warn  
|warn  
|warning=red
|warning=red
Line 21: Line 22:
|note  
|note  
|notice=Info-Logo.png
|notice=Info-Logo.png
|starfield=StarfieldIcon.png
|warn  
|warn  
|warning=Warning-Logo.png
|warning=Warning-Logo.png
Line 33: Line 35:
|note  
|note  
|notice=NOTE
|notice=NOTE
|starfield=Starfield
|warn  
|warn  
|warning=WARNING
|warning=WARNING
Line 42: Line 45:
=== Required Parameters ===
=== Required Parameters ===
<span class="salmontx">'''type'''</span> - Sets the type of alert, which dictates icon and color
<span class="salmontx">'''type'''</span> - Sets the type of alert, which dictates icon and color
: '''Values'''
: '''General Values'''
:: Default: <code>type=notice</code>
:: Default: <code>type=notice</code>
:* bug  
:* ''bug''
:* wip or construction
:* loot - LOOT specific
:* mcm - Mod Confuguration Manager specific
:* mo - Mod Organizer specific
:* ''note'' or ''notice''
:* ''note'' or ''notice''
:* warn or warning
:* ''warn'' or ''warning''
:* ''wip'' or ''construction'' - work in progress
: '''ToolsValues'''
:* ''loot'' - LOOT specific
:* ''mcm'' - Mod Confuguration Manager specific
:* ''mo'' - Mod Organizer specific
: '''Game Values'''
:* ''starfield'' - Starfield


<span class="salmontx">'''text'''</span> - The alert message
<span class="salmontx">'''text'''</span> - The alert message
: '''Values'''
: '''Values'''
:: Default: n/a, <code>text=''ContentHere''</code>
:: Default: <span class="orangetx">''none''</span>
:: <code>text=''ContentHere''</code>


=== Optional Parameters ===
=== Optional Parameters ===
<span class="salmontx">'''icon'''</span> - Determines the icon used
<span class="salmontx">'''icon'''</span> - Determines the icon used.
: '''Values'''
:: ''There is no reason to include this unless a custom alert is being created, in which case it would be best to expand the template to include the custom alert; to be determined on a case by case basis.''
 
: '''General Values'''
:: Default: <code>icon=notice</code>
:: Default: <code>icon=notice</code>
:* bug  
:* ''bug'' = [[File:Bug-Logo.png|20px|]]
:* wip or construction
:* ''note'' or ''notice'' = [[File:Info-Logo.png|20px|]]
:* loot
:* ''warn or ''warning = [[File:Warning-Logo.png|20px|]]
:* mcm
:* ''wip'' or ''construction'' = [[File:Weapon.png|20px|]]
:* mo
: '''Tool Values'''
:* ''note'' or ''notice''
:* ''loot'' = [[File:loot.png|20px|]]
:* warn or warning
:* ''mcm'' = [[File:Mcmicon1.png|20px|]]
:* ''mo'' = [[File:Moicon.png|20px|]]
: '''Game Values'''
:* starfield = [[File:StarfieldIcon.png|20px|]]


== Examples ==
== Examples ==
Line 106: Line 118:
: '''Result:'''
: '''Result:'''
:: {{AlertSmall|type=bug|text=Bug message}}
:: {{AlertSmall|type=bug|text=Bug message}}
:: {{AlertSmall|type=warn|text=Warning message}}
:: {{AlertSmall|type=wip|text=Under construction (WIP) message}}
:: {{AlertSmall|type=wip|text=Under construction (WIP) message}}
:: {{AlertSmall|type=loot|text=Loot-specific message}}
:: {{AlertSmall|type=loot|text=Loot-specific message}}
:: {{AlertSmall|type=mcm|text=MCM-specific message}}
:: {{AlertSmall|type=mcm|text=MCM-specific message}}
:: {{AlertSmall|type=mo|text=MO-specific message}}
:: {{AlertSmall|type=mo|text=MO-specific message}}
:: {{AlertSmall|type=warn|text=Warning message}}
:: {{AlertSmall|type=starfield|text=Starfield message}}


== Related Templates ==
== Related Templates ==

Latest revision as of 03:53, November 9, 2023

Forum Topic

Purpose & Usage[edit source]

This template displays a small alert on the page that can also be used within lists. For this reason, this alert has all but top outer margins set to zero, so use blank lines or breaks to separate from body text where appropriate. This template is intended for use with brief alerts or alerts used within lists. For more lengthy and prominent alerts, use Template:Alert instead.

Required Parameters[edit source]

type - Sets the type of alert, which dictates icon and color

General Values
Default: type=notice
  • bug
  • note or notice
  • warn or warning
  • wip or construction - work in progress
ToolsValues
  • loot - LOOT specific
  • mcm - Mod Confuguration Manager specific
  • mo - Mod Organizer specific
Game Values
  • starfield - Starfield

text - The alert message

Values
Default: none
text=ContentHere

Optional Parameters[edit source]

icon - Determines the icon used.

There is no reason to include this unless a custom alert is being created, in which case it would be best to expand the template to include the custom alert; to be determined on a case by case basis.
General Values
Default: icon=notice
  • bug = Bug-Logo.png
  • note or notice = Info-Logo.png
  • warn or warning = Warning-Logo.png
  • wip or construction = Weapon.png
Tool Values
  • loot = Loot.png
  • mcm = Mcmicon1.png
  • mo = Moicon.png
Game Values
  • starfield = StarfieldIcon.png

Examples[edit source]

Default Call[edit source]

The simplest call returns defaults for the template.

Code: {{AlertSmall|text=Your text here.}}
Result:
Info-Logo.png
NOTE:
Your text here.

Width is automatic, and text wraps, but this template is intended for use with brief alerts or alerts used in lists. For more lengthy alerts, use Template:Alert instead.

Info-Logo.png
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.

Within Lists[edit source]

Use in lists is appropriate.

Code:
* List item 1
*: {{AlertSmall|text='Silent' indented bullet list item}}
* List item 2
Result:
  • List item 1
    Info-Logo.png
    NOTE:
    'Silent' indented bullet list item
  • List item 2
Code:
# List item 1
# List item 2<br>{{AlertSmall|text={{lorem}} }}
# List item 3
Result:
  1. List item 1
  2. List item 2
    Info-Logo.png
    NOTE:
    Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
  3. List item 3

Types[edit source]

The simplest call returns defaults for the template.

Code: {{AlertSmall|type=bug|text=Your text here.}}
Result:
Bug-Logo.png
BUG:
Bug message
Warning-Logo.png
WARNING:
Warning message
Weapon.png
WIP:
Under construction (WIP) message
Loot.png
LOOT:
Loot-specific message
Mcmicon1.png
MCM:
MCM-specific message
Moicon.png
MO2:
MO-specific message
StarfieldIcon.png
Starfield:
Starfield message

Related Templates[edit source]

  • Template:Alert - A more prominent alert that will NOT work in lists as this version does.