Template:Scroll infobox/doc

Purpose
This template displays an infobox to be used on pages describing scrolls.

Usage
As any infobox, it should be added at the beginning of the page.

The default behavior of this template is to get its content from the data subpage of the scroll page. As a consequence, in order to work, it requires that a data storage page is properly defined for the scroll it is referring to (see Template:Scroll data documentation). However, thanks to the  flag, it is also possible to display an infobox whose data is taken from template parameters.

By default, it also adds the page to appropriate categories among the following:
 * Creature scrolls
 * Enchantment scrolls
 * Spell scrolls
 * Structure scrolls
 * Decay scrolls
 * Energy scrolls
 * Growth scrolls
 * Order scrolls
 * Common scrolls
 * Uncommon scrolls
 * Rare scrolls

For this reason, always use a scroll infobox in a scroll page, unless you enable the  flag.

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

Data-dependent infobox blank template
To use this template, you can copy and paste the following code to the scroll page you want to use it on, and fill in the parameters.

Custom infobox blank template
To use this template, you can copy and paste the following code to the page you want to use it on, and fill in the parameters.

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.

Regular example
Below example shows what the template would output if used on Brother of the Wolf page.

Result:

(See on the right.)

Note that the infobox has a footer with links for easy access to the data storage page.

Custom data example
Below examples shows how to use the template with the  flag enabled. It is independent from the data storage page of the scroll shown in the infobox.

Result:

(See on the right.)

Note that, contrary to previous example, the infobox doesn't have any footer since it is not dependent on any data page.

Example with a specific data page
Below example shows how to use this template when the data storage page isn't the  subpage. However, it must not be used in a page which is not a scroll page since it would be added to scroll categories (see Demonstration example in such case).

Result: Considering (for the sake of example) that  is the data storage page for Brother of the Wolf, it would have the output as in the Regular example.

Demonstration example
The following template can be used in a page which is actually not a scroll page although its data comes from a data storage page.

(No result is shown since the output is similar to previous examples, except that the page isn't added to categories.)

Related templates

 * Infobox