Home > Articles

The XSLT Transformation Environment

Learn the basics of XSLT by going through the aspects of the environment and where the XSLT processor is used. Topics include stylesheet basics and communicating with the processor.
This chapter is from the book

This chapter is from the book

Some aspects of our stylesheets are of a global nature that we must consider before we delve into the details of template instruction execution and behaviors. This chapter overviews the aspects of our environment in which we use our XSLT processor from the perspectives of the stylesheet contents, the serialized output (if any), and the operator invoking the processor.

All explicitly declared stylesheets follow a required shape of container and top-level (container children) elements. Methods are also specified for including arbitrary information in a stylesheet file, useful for supplemental information for processing, or as documentation of the stylesheet content.

The stylesheet can declare its desire for values of certain parameters of the output serialization that influence the contents of the reified result node tree.

In addition, there are a number of ways available to communicate with an XSLT processor that is interpreting a stylesheet resource against a source resource. Communication to the processor can be engaged at invocation as well as from the processor during execution.

Finally, this chapter reviews aspects of the transformation environment that cannot be controlled by the operator or the stylesheet. It is important to understand the limitations of what can be asked for or even supported by the XSLT processor.

This chapter includes discussion of the following XSLT instructions regarding the transformation environment in which a stylesheet is used.

Instructions for wrapping the content of a stylesheet are as follows.

  • <xsl:stylesheet>

    • encapsulates a stylesheet specification.

  • <xsl:transform>

    • encapsulates a stylesheet specification.

Instructions for serializing the result tree are as follows.

  • <xsl:namespace-alias>

    • specifies a result tree namespace translation.

  • <xsl:output>

    • specifies the desired serialization of the result tree.

Instructions for communicating with the operator are as follows.

  • <xsl:message>

    • reports a stylesheet condition to the operator.

  • <xsl:param>

    • supplies a parameterized value from the operator.

5.1 Stylesheet basics

5.1.1 The stylesheet document/container element

Two identical and interchangeable choices for the document element are:

  • <xsl:stylesheet>

  • <xsl:transform>

They can also be used as a container element for a stylesheet embedded in another context.

  • They may use id="unique identifier".

    • It identifies the stylesheet when there are multiple ones from which to choose.

    • The use of this XML IDattribute is outside the scope of the Recommendation.

    • It could be used as a fragment identifier by the stylesheet association processing instruction or by other techniques to identify a given stylesheet among many.

Controls available on container element or any literal result element are:

  • exclude-result-prefixes="whitespace-separated-prefixes"  

    • scope of influence is all descendent elements in stylesheet;  

    • this declaration indicates which stylesheet namespace prefixes are not expected in the result, thus are not to be included in the stylesheet tree;  

      • a list of whitespace-separated namespace prefixes specifies prefixes that are to be explicitly excluded from the stylesheet tree (using #default as the name to reference the default namespace, which is sometimes unofficiallycalled the null namespace);  

    • user-specified prefixes and associated namespace declarations are often used in XSLT stylesheets (but not desired in the result) for various purposes such as:

      • top-level documentation,

      • embedded structured data,

      • named XSLT constructs;

    • recall that copying an element node from the stylesheet to the result will copy all attached namespace nodes, thus stylesheet namespace declarations can easily end up in the result tree;

      • a stylesheet wrapper-element namespace declaration is typically used for top-level namespace usage, thus the document element of the result will typically end up with the same declarations;

    • this exclusion declaration tells the XSLT processor to not include the specified namespace nodes on descendent nodes of the stylesheet tree;

    • this exclusion declaration has no effect on namespace nodes of the source tree,

  • extension-element-prefixes="whitespace-separated-prefixes"

    • scope of influence is all descendent elements in stylesheet;

    • this declaration indicates which stylesheet namespace prefixes are instruction prefixes;

      • a list of whitespace-separated namespace prefixes specifying prefixes that are extension namespaces to be recognized by the XSLT processor (using #default as the name to reference the default namespace);

    • recall that everything that is not an instruction is considered to be a literal result element;

    • elements prefixed with the namespace prefix associated with the XSLT URI are interpreted as instructions;

    • this declaration tells the XSLT processor what other prefixes are to be interpreted as instructions because they are extension elements required by the stylesheet;

    • the processor need not implement the extension elements (detailed in Chapter 6).

Child elements of the document or container element are referred to as "top-level" elements.

  • If present, the following must occur before all other top-level elements:

    • xsl:import

      • see Chapter 6.

  • If present, the following (listed alphabetically) may occur in any order as top-level elements:

    • xsl:attribute-set

      • see Chapter 7,

    • xsl:include

      • see Chapter 6,

    • xsl:key

      • see Chapter 8,

    • xsl:decimal-format

      • see Chapter 8,

    • xsl:namespace-alias

      • see this chapter,

    • xsl:output

      • see this chapter,

    • xsl:preserve-space

      • see Chapter 3,

    • xsl:strip-space

      • see Chapter 3,

    • xsl:template

      • see Chapter 4.

  • The following are used not only as top-level elements, while all others listed above are only used as top-level elements:

    • xsl:param

      • see Chapter 6,

    • xsl:variable

      • 6 see Chapter 6.

Because an XSL stylesheet is an XML document —

  • XML comments can be used to provide documentation about the stylesheet,

  • all XML comments and processing instructions found in an XSL stylesheet are ignored.

    • Note that some XML editing tools may leave processing instructions in files for remembering locations such as the last cursor position.

Adding richly marked up documentation to a stylesheet:

  • allows the stylesheet to be run through a documenting stylesheet to extract the documentation in any fashion desired,

  • is accomplished by including non-XSLT constructs as top-level elements (children of the stylesheet document element) provided that the default namespace is not used as the namespace for such constructs, as in the following example:

Example 5–1 Using non-XSLT constructs as top-level elements

Line 1  <?xml version="1.0"?>    <!--hellodoc.xsl-->
     2  <!--XSLT 1.0 - http://www.CraneSoftwrights.com/training -->
     3
     4  <xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
     5  version="1.0" exclude-result-prefixes="mydoc"
     6  xmlns:mydoc="http://www.mycompany.com/mydoc">
     7
     8  <xsl:output method="html"/>
     9
    10  <mydoc:para>
    11  The following construct is the root template.
    12  </mydoc:para>
    13
    14  <xsl:template match="/">	<!--root rule-->
    15  <b><i><u><xsl:value-of select="greeting"/></u></i></b>
    16  <?test a processing instruction here?>
    17  </xsl:template>
    18
    19  </xsl:transform>

Note the use of exclude-result-prefixes= in the document element above to tell the XSLT processor to not emit a namespace declaration for the prefix of the documentation namespace —

  • if the stylesheet writer knows that namespace will never be needed in the result;

  • because the XSLT processor doesn't know when creating the document element node of the result tree whether the namespace will ever be needed in the instance, so by default the declaration is emitted.

5.1.3 Namespace protection

Some special concern regarding the use of namespaces are as follows.

  • The "transformation by example" paradigm utilizes literal result elements.

    • It represents result tree element nodes with associated attribute nodes.

      • An element is written with associated attributes in a template in the stylesheet and can use —  

        • the default namespace,

        • a namespace prefix and associated namespace URI.

      • An alternative described later is the use of XSLT instructions to synthesize result tree nodes.

  • Some namespaces can be sensitive in the document processing environment;

    • this includes automatically-triggered platform services;

    • for example: digital signature processing.

  • If the result tree requires a sensitive namespace, the stylesheet can't use the namespace in a literal result element —

    • to produce an XSLT script as the output of translation;

      • the XSLT processor would incorrectly interpret the result vocabulary as input,

    • to use a platform service for the output of translation;

      • the stylesheet use of the URI would incorrectly trigger the service.

  • The <xsl:namespace-alias attributes/> top-level element can be used, which:

    • is an instruction to translate a namespace prefix in the stylesheet into another namespace prefix when used in the result;

    • with attribute stylesheet-prefix="prefix":

      • specifies the prefix used in the stylesheet tree that is being added to the result tree by the stylesheet,

        • has no influence or recognition in the source tree,

    • with attribute result-prefix="prefix":

      • specifies the prefix of the stylesheet tree whose URI is to be used for the result tree prefix,

      • must have this attribute declared in the stylesheet even if no element in the stylesheet uses the prefix.

Note in the example below how the XSLT namespace URI cannot be used for the declaration for the xslo prefix, otherwise the xslo prefixed elements would be interpreted as XSLT instructions.

Example 5–2 A stylesheet that produces a stylesheet

Line 1  <?xml version="1.0"?>    <!--xsl.xsl-->
     2  <!--XSLT 1.0 - http://www.CraneSoftwrights.com/training -->
     3
     4  <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
     5  xmlns:xslo="any-URI" version="1.0">
     6
     7  <xsl:output indent="yes"/>
     8
     9  <xsl:namespace-alias stylesheet-prefix="xslo"
    10  result-prefix="xsl"/>
    11
    12  <xsl:template match="/">    <!--root rule-->
    13  <xslo:stylesheet version="1.0">
    14  <xslo:template match="/">
    15  <html>
    16  <p>Hello world</p>
    17  </html>
    18  </xslo:template>
    19  </xslo:stylesheet>
    20  </xsl:template>
    21
    22  </xsl:stylesheet>
  • When this particular stylesheet is run with itself (or any XML file) as the source, the XSLT processor will assign the "xslo:" prefix's URI used in the result tree with the URI for the "xsl" prefix as indicated in the <xsl:namespace-alias> instruction, thus using the XSLT URI when the result tree is serialized as XML markup:

Example 5–3 A stylesheet produced by a stylesheet

Line 1  <xslo:stylesheet version="1.0"
     2  xmlns:xslo="http://www.w3.org/1999/XSL/Transform">
     3  <xslo:template match="/">
     4  <html>
     5  <p>Hello world</p>
     6  </html>
     7  </xslo:template>
     8  </xslo:stylesheet>
  • When run with itself (or any XML file) as the source, the output will be:

Example 5–4 The result produced by the produced stylesheet

Line 1  <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 
     2  <html> 
     3  <p>Hello world</p>
     4  </html>

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020