Template:Effect/doc

This is the template documentation for {{Effect}}. It is transcluded from Template:Effect/doc and may be directly edited there.

Using this Template

Create new effect should be used to create a Effect article (page), then fill in the appropriate parameters.

You will find sections along with standard formatting and information for the created article. If you do not need a section, you don't have to keep it into your article.

Keep in mind, this is a general template for ALL Effects. Therefore not all parameters apply to any given effect.

It should allow one to duplicate the in-game tooltip!

Many parameters should simply use the same value as found in the in-game tooltip -- 10 s or 10 seconds

Most parameters simply insert the text you provide directly into the template according to position and color.

Template: Template: Effect - Category: General Wiki Templates

Documentation: Template: Effect/doc - Category: Template Documentation

Preload: Template: Effect/Preload - Category:Template Preloads

Naming Pattern:

Skill - if same name: gets name without suffix

Deed - if same name: <name> (Deed)

Effect - if same name: <name> (Effect)

Trait - if same name: <name> (Trait)

Usage

This template accepts the parameter | nocat = yes -- Blank or Yes. If yes, then do NOT perform automatic categorization for this article.

Syntax

__NOTOC__<onlyinclude>{{Effect
| mode={{{mode|}}}       Leave as is
| arg={{{arg|}}}         Leave as is
| nocat               =  Blank or y/Y -- special parameter used in testing to suppress automatic categorization
| name                =  The Effect name, as it appears in game.
| disambigpage        = {{subst:FULLPAGENAME}}
| icon                = Name of Effect-icon 
| main-category       = Required - blank or specify a wiki-category, e.g. Burglar - "Effects" will be appended to the category 
                        named - Example: "Burglar Effects"
| resistance          = blank or type of resistance against damage type, e.g. Cry/Song/Tactical/Physical
| description         = blank or Effect description from tooltip (in khaki text)
| every2sec           = blank or text as read in-game immediately after "Every 2 Seconds:"
| every3sec           = blank or text as read in-game immediately after "Every 3 Seconds:"
| every4sec           = blank or text as read in-game immediately after "Every 4 Seconds:"
| every5sec           = blank or text as read in-game immediately after "Every 5 Seconds:"
| attrib              = blank or green text ability as read in-game, e.g. -25% Target Run Speed
| requires            = blank or text as read in-game immediately after "Requires:"
| removal             = blank or text as read in-game immediately after "Applied on removal:"
| expires-ooc         = blank or # of seconds after which this effect expires when out of combat
| duration            = blank or a time, i.e. 30s
| ic-removal          = blank or text as read in-game immediately after "Applied on expiration if in combat:"
| expiration          = blank or text as read in-game immediately after "Applied on expiration:"
| expires             = blank or text when effect expires normally
| effect-text   = brief and informative text that will be displayed at pages that transcludes from an effect page
}}</onlyinclude>

Note about "effect-text" -- this text could be "description" or "attrib" but most often those are too verbose and/or lore-styled. Try to merge, re-write, and condense the text to get across only the most important aspects of the effect, the reader is expected to navigate to the effect page for the exhaustive details.

Transclusion Information

Linking to an Effect from, for example creature pages, may be done by the following example, also showing the result:

:{{:Minor Sprain|mode=imlink}} -- Displays Icon and link and "effect-text"
:{{:Minor Sprain|mode=link}}   -- Displays link only -- no icon.

Minor Sprain -20% Run Speed and -20*level Evade Rating for 5-30s

Minor Sprain

Note that the preceding italicized text is the "Effect-text" from the template. It only displays when using "mode=imlink" -- not with "mode=link"

Supplemental Formatting

== Effect Information ==
This effect is inflicted by [[Creature]].

== Effect Information ==
This effect is bestowed by [[Item]].

== Tactical Information ==
The <Class> <Some Legacy> [[Name of Legacy Something]] enhances/decreases this effect by <description> by up to <value>, for a total maximum of <value> [[Something]].

== Additional Information ==

== Skill Relationship ==
The skill {{:name|mode=imlink}} will activate this effect on...