Template:Scroll data/abilities/doc

Purpose
This template displays abilities of a scroll, or related information, 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 abilities in the text. However, it can also be included in other pages provided the  parameter is defined (see below example).

Various information can be displayed by this template: The default behavior is to display the ability whose position is given by the  parameter. Other pieces of information may be displayed using flags (see Anonymous parameters).
 * all abilities of a scroll in sequence as seen in-game,
 * all abilities of a scroll as a list,
 * the total number of abilities of a scroll,
 * the text of one particular ability.

Single ability 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 parameters.

Other uses blank templates
To use this template, you can copy and paste one of the following codes to the scroll page you want to use it on, fill in parameters, and remove unwanted flags.

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).

Single ability example
Below example shows what the template would output if used on Gravehawk page. No flag is set, and the first ability is selected.

's first ability:

Result:

's first ability:

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 Gravehawk page.

Number-dependent example
Below example illustrates how the  flag can be used to write sentences depending on the number of abilities. Here, it is achieved using MediaWiki's  magic word.

Results show what would be displayed if used on Gravehawk or Machine Priest page.

's NaN ability iss:

Result: (on Gravehawk page, which has 1 ability)

's NaN ability iss:

Result: (on Machine Priest page, which has 2 abilities)

's NaN ability iss:

Default message example
This example demonstrates the effects of the  parameter.

Results show what would be displayed if used on Gravehawk or Kinfolk Brave page.

Result: (on Gravehawk page, which has 1 ability)

Result: (on Kinfolk Brave page, which has no abilities)

Example with a specific data page
Below example refers to Machine Priest data but works in any page (contrary to previous examples).

Result:

Related templates

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