Template:Scroll data/doc

Purpose
This template is used to store data about scrolls, including:
 * name,
 * type,
 * subtypes,
 * rarity,
 * resource,
 * cost,
 * attack points,
 * countdown,
 * health points,
 * talents,
 * abilities,
 * flavor text.

It goes hand in hand with its sub-templates (see Related templates) which retrieve information stored this way.

It is strongly advisable not to copy-paste scroll information in different places of the wiki (including, but not limited to, scroll pages and listing pages) but rather use these templates each time you would write such information. This allows all references to a scroll, in any page, to be updated by a single edit to the data storage page if that scroll is modified in a later version.

Usage
Each scroll should have its own data storage page (which must be different from the scroll page itself). As a convention, the data storage page of a scroll is the  subpage of the scroll page (e.g. Ancestral Totem's data storage page is Ancestral Totem/data). For this reason, data storage pages are often referred to as data subpages.

Each data storage page should contain one call to this template, with parameters properly filled in with data. Doing this allows other templates to transclude the page thus getting access to stored data (via variables).

It is essential that when transcluded, the data page has no output, including no white space characters nor line breaks. Note that the default behavior of the template (without  flag enabled) is to give access to data without displaying anything, which makes it safe for data page transclusion. As a consequence, if anything is to be displayed on the data page (when viewed in a browser, not transcluded), it must be enclosed with  tags. This is the reason why it is advisable to use the  flag of this template within such tags (see below Blank template).

Blank template
To use this template, you can copy and paste the following code to the scroll data storage page you want to create, and fill in parameters.

As explained previously, don't add any white space or line breaks before opening brackets nor after closing brackets.

Preloading
It is also possible to preload a new page with a blank template, along with some instructions, by entering the data storage page name (including ) in the below text field and click the button.

See Template:Scroll data/preload for more information.

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 (unless stated otherwise).

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

Variables
Below table shows what variables are created by this template.

Regular example
&rarr; See result

(It shows what would be displayed if used on Gravehawk/data page)

Multi-valued parameters example
Below examples shows how to write data for scrolls which have several subtypes, talents or abilities. It doesn't correspond to any actual scroll.

&rarr; See result

Example with a specific scroll page
The following template can be used in any place of the wiki as the data storage page of Gravehawk. (Note the  parameter.)

However, as stated in Usage, it is advisable to keep data storage in  subpages.

&rarr; See result

Demonstration example
The following template can be used in a page which is actually not a data storage page. (Note the  flag.)

(No result is shown since the output is similar to previous examples.)

Related templates

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