Template:Alert

From Step Mods | Change The Game
Revision as of 03:38, November 9, 2023 by TechAngel85 (talk | contribs) (Separated the values more distinctly. Added ''Starfield'' as the first game parameter. Added small images to the ''Icon Optional'' list. Fixed the broken ''Including Lists'' example.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Forum Topic

Purpose & Usage

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

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
Tool Values
  • loot - LOOT
  • mcm - Mod Confuguration Manager
  • mo - Mod Organizer
Game Values
  • starfield - Starfield

text - The alert message

Values
Default: none
text=ContentHere

Optional Parameters

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

Default Call

The simplest call returns defaults for the template.

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

NOTE

Your text here.
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.

Including Lists

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

NOTE

Using wiki markup like lists with this alert is appropriate.

  1. For numbered
    • Bulleted
    or mixed lists
Behavior should mimic body text.

Types

The simplest call returns defaults for the template.

Code: {{Alert|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-specific message

Related Templates

  • Template:AlertSmall - A more subtle version suitable for brief messages or messages within lists.