• Chapter 1: Getting Started with Stylus Studio®
• Chapter 2: Editing and Querying XML
• Chapter 3: Converting Non-XML Files to XML
• Chapter 4: Working with XSLT
  • Getting Started with XSLT
  • Tutorial: Understanding How Templates Work
  • Working with Stylesheets
  • Specifying Extension Functions in Stylesheets
  • Working with Templates
  • Using Third-Party XSLT Processors
  • Validating Result Documents
  • Post-processing Result Documents
  • Generating Formatting Objects
  • Generating Scalable Vector Graphics
  • Generating Java Code for XSLT
  • Generating C# Code for XSLT
  • XSLT Instructions Quick Reference
    • xsl:apply-imports
    • xsl:apply-templates
    • xsl:attribute
    • xsl:attribute-set
    • xsl:call-template
    • xsl:character-map
    • xsl:choose
    • xsl:comment
    • xsl:copy
    • xsl:copy-of
    • xsl:decimal-format
    • xsl:element
    • xsl:fallback
    • xsl:for-each
    • xsl:for-each-group
    • xsl:function
    • xsl:if
    • xsl:import
    • xsl:import-schema
    • xsl:include
    • xsl:key
      • Format
      • Description
    • xsl:message
    • xsl:namespace-alias
    • xsl:number
    • xsl:otherwise
    • xsl:output
    • xsl:output-character
    • xsl:param
    • xsl:preserve-space
    • xsl:processing-instruction
    • xsl:sequence
    • xsl:sort
    • xsl:strip-space
    • xsl:stylesheet
    • xsl:template
    • xsl:text
    • xsl:transform
    • xsl:value-of
    • xsl:variable
    • xsl:when
    • xsl:with-param
• Chapter 5: Creating XSLT Using the XSLT Mapper
• Chapter 6: Debugging Stylesheets
• Chapter 7: Defining XML Schemas
• Chapter 8: Defining Document Type Definitions
• Chapter 9: Writing XPath Expressions
• Chapter 10: Working with XQuery in Stylus Studio
• Chapter 11: Composing Web Service Calls
• Chapter 12: Working with WSDL Documents
• Chapter 13: Building XML Pipelines
• Chapter 14: Publishing XML Data
• Chapter 15: Integrating with Third-Party File Systems
• Chapter 16: Extending Stylus Studio
• Chapter 17: The Stylus Studio Java API
• Chapter 18: Stylus Studio GUI Reference

Home > Online Product Documentation > Table of Contents > xsl:key

xsl:key

Declares a key for a document.

Format

<xsl:key name="qname" 
               
match = "pattern" 
               
use = "use" />
               

            

Description

Keys provide a way to work with documents that contain an implicit cross-reference structure. A stylesheet declares a key for a document with the xsl:key instruction.

The xsl:key instruction must be a top-level element. It has no contents, but it specifies three attributes.

Replace qname with the name of the key. You must specify a qualified name.

Replace pattern with a pattern that identifies one or more nodes that have this key. In other words, the nodes in the document that match the pattern are included in the key. The default is node().

Replace use with an expression that you want to use for the key values. The XSLT processor evaluates the expression once for each node in the set identified by pattern.

Each key name represents a separate, independent set of identifiers. Each node included in a key is associated with a set of string key values. These values result from evaluating the use expression with that node as the current node.

A document can contain multiple keys with the same node and the same key name, but with different key values. A document can contain multiple keys with the same key name and value, but with different nodes. In other words:

The value of a key can be an arbitrary string. It need not be a name.

Use the XSLT key() function to retrieve the list of nodes included in a given key that have given key values. See Finding an Element with a Particular Key.

You cannot specify multiple declarations for the same key in a stylesheet. Stylus Studio expects to remove this restriction in a future release.