Template:Scroll data/rarity/doc

Purpose
This template displays the rarity of a scroll according to its data subpage.

This allows all references to scroll data in any page to be updated by a single edit to the data subpage.

Usage
In order to work, this template requires that a data subpage is properly defined for the scroll it is referring to (see Template:Scroll data documentation).

This template is mainly to be used in the said scroll's page, where one would write the rarity in the text. However, it can also be included in other pages provided the  parameter is defined (see below example).

The default behavior of this template is to display the rarity as plain text, with a leading upper-case letter. However, this can be altered by flags (see Anonymous parameters).

Blank template
To use this template, you can copy and paste the following code to the scroll page you want to use it on.

All flags template
To use this template, you can copy and paste the following code to the scroll page you want to use it on, and remove unwanted flags.

Note that this code should not be used as is since  and   flags are incompatible.

Anonymous parameters
Anonymous parameters of this template are used as flags which alter the default behavior of the template (see Usage). This means that each anonymous parameter (without name and equals sign before the value) can be one of the fixed values detailed in the below table.

All flags are optional and they can be written in any order. They can also be mixed with named parameters.

Note that only the first 3 anonymous parameters are checked for flags (which is the maximum number of compatible flags in a single template use).

Regular example
Below example shows what the template would output if used on Brother of the Wolf page (and without any flags).

's rarity:

Result:

's rarity:

Flag combinations
Below table shows all possible flag combinations and their effect. As for previous example, results show what would be displayed if used on Brother of the Wolf page.

Sentence example
Below example shows how to use the template in a sentence, using the  flag. As for previous examples, this one shows what would be displayed if used on Brother of the Wolf page.

is scroll.

Result:

is scroll.

Example with a specific data page
Below example refers to Brother of the Wolf data but works in any page (contrary to previous examples).

Brother of the Wolf is scroll.

Result:

Brother of the Wolf is scroll.

Related templates

 * Scroll data
 * Scroll data/abilities
 * Scroll data/attack
 * Scroll data/cost
 * Scroll data/countdown
 * Scroll data/flavor
 * Scroll data/health
 * Scroll data/name
 * Scroll data/resource
 * Scroll data/subtypes
 * Scroll data/talents
 * Scroll data/type