xsl:number Element (Compact 2013)

3/26/2014

Inserts a formatted number into the result tree.

Syntax

<xsl:number
  level = "single" | "multiple" | "any"
  count = pattern 
  from = pattern 
  value = number-expression 
  format = { string }
  lang = { nmtoken }
  letter-value = { "alphabetic" | "traditional" }
  grouping-separator = { char }
  grouping-size = { number } />

Attributes

• level
  Specifies what levels of the source tree should be considered; it has the values single, multiple or any. The default is single.

• count
  A pattern that specifies what nodes should be counted at those levels. If the count attribute is not specified, then it defaults to the pattern that matches any node with the same node type as the current node and, if the current node has an expanded-name, with the same expanded-name as the current node.

• from
  A pattern that specifies where counting starts.

• value
  Specifies the expression to be converted to a number and output to the result tree. If no value attribute is specified, then the <xsl:number> element inserts a number based on the position of the current node in the source tree.

• format
  A sequence of tokens that specifies the format to be used for each number in the list. If there are no format tokens, then the default value of 1 is used which generates a sequence 1 2 ... 10 11 12.... Each number after the first is separated from the preceding number by the separator token preceding the format token used to format that number. If there are no separator tokens, a period character is used ".".  

  Format token	Sequence generated
  1	1 2 3 4 5 ... 10 11 12 ...
  01	01 02 03 ... 19 10 11 ... 99 100 101...
  A	A B C ... Z AA AB AC...
  i	i ii iii iv v vi vii viii ix x...
  I	I II III IV V VI VII VIII IX X...

• lang
  Specifies which language's alphabet is used. If no lang value is specified, the language is determined from the system environment.

• letter-value
  Disambiguates between numbering sequences that use letters. One numbering sequence assigns numeric values to letters in alphabetic sequence, and the other assigns numeric values to each letter in some other manner traditional in that language. In English, these correspond to the numbering sequences specified by the format tokens "a" and "i". In some languages, the first member of each sequence is the same, and so the format token alone would be ambiguous. A value of "alphabetic" specifies the alphabetic sequence; a value of "traditional" specifies the other sequence. Default is "alphabetic."

• grouping-separator
  Gives the separator used as a grouping (for example, thousands) separator in decimal numbering sequences. For example, grouping-separator="," and grouping-size="3" would produce numbers of the form 1,000,000. If only one of the grouping-separator and grouping-size attributes is specified, then it is ignored.

• grouping-size
  Specifies the size (usually 3) of the grouping. For example, grouping-separator="," and grouping-size="3" would produce numbers of the form 1,000,000. If only one of the grouping-separator and grouping-size attributes is specified, then it is ignored.

Element Information

Remarks

The number to be inserted is specified by an expression contained in the value attribute. The expression is evaluated and the resulting object is converted to a number. The number is rounded to an integer and then converted to a string and inserted in the result tree.

The <xsl:number> element first constructs a list of positive integers using the level, count and from attributes:

• When level="single", it goes up to the first node in the ancestor-or-self axis that matches the count pattern, and constructs a list of length one containing one plus the number of preceding siblings of that ancestor that match the count pattern. If there is no such ancestor, it constructs an empty list. If the from attribute is specified, then the only ancestors that are searched are those that are descendants of the nearest ancestor that matches the from pattern. Preceding-siblings has the same meaning here as with the preceding-sibling axis.
• When level="multiple", it constructs a list of all ancestors of the current node in document order followed by the element itself; it then selects from the list those nodes that match the count pattern; it then maps each node in the list to one plus the number of preceding siblings of that node that match the count pattern. If the from attribute is specified, then the only ancestors that are searched are those that are descendants of the nearest ancestor that matches the from pattern. Preceding siblings has the same meaning here as with the preceding-sibling axis.
• When level="any", it constructs a list of length one containing the number of nodes that match the count pattern and belong to the set containing the current node and all nodes at any level of the document that are before the current node in document order, excluding any name space and attribute nodes (in other words the union of the members of the preceding and ancestor-or-self axes). If the from attribute is specified, then only nodes after the first node before the current node that match the from pattern are considered.

The following languages/numbering schemes are supported. "Format Token" corresponds to the format attribute, "Language" corresponds to the "lang" attribute, and "Letter-Value" corresponds to the letter-value attribute.

If the format token alone is enough to disambiguate a particular numbering scheme, there is no need to specify the language or letter-value.

Example

The following sample demonstrates the use of the <xsl:number> element.

<xsl:template match="items">
  <xsl:for-each select="item">
    <xsl:sort select="."/>
    <p>
      <xsl:number value="position()" format="1. "/>
      <xsl:value-of select="."/>
    </p>
  </xsl:for-each>
</xsl:template>

Here are some examples of conversion specifications.

format="ア" specifies Katakana numbering.
format="イ" specifies Katakana numbering in the "iroha" order.
format="๑" specifies numbering with Thai digits.
format="א" letter-value="traditional" specifies "traditional" Hebrew numbering.
format="ა" letter-value="traditional" specifies Georgian numbering.
format="α" letter-value="traditional" specifies "classical" Greek numbering.
format="а" letter-value="traditional" specifies Old Slavic numbering.

See Also

Reference

XSLT Elements