<?xml version="1.0" encoding="iso-8859-1"?>
<?xml-stylesheet href="../make-menu.xsl" type="text/xsl"?><html>
<head>
<this-is section="xsl-elements" page="output" subpage=""/>
<!--
Generated at 2011-12-09T20:47:22.916Z--><title>Saxonica: XSLT and XQuery Processing: xsl:output</title>
<meta name="coverage" content="Worldwide"/>
<meta name="copyright" content="Copyright Saxonica Ltd"/>
<meta name="title" content="Saxonica: XSLT and XQuery Processing: xsl:output"/>
<meta name="robots" content="noindex,nofollow"/>
<link rel="stylesheet" href="../saxondocs.css" type="text/css"/>
</head>
<body class="main">
<h1>xsl:output</h1>
<p>The <code>xsl:output</code> element is used to control the format of serial output files resulting
from the transformation. It is always a top-level element immediately below the<code>xsl:stylesheet</code> element.
There may be multiple <code>xsl:output</code> elements; their values are accumulated as described in the
XSLT specification.</p>
<p>The following standard attributes may be specified:</p>
<table>
<tr>
<td content="para">
<p>name</p>
</td>
<td content="para">
<p>This provides a name for this output format, which may be referenced
in the <code>xsl:result-document</code> element.
By default, the unnamed output format is used.</p>
</td>
</tr>
<tr>
<td content="para">
<p>method</p>
</td>
<td content="para">
<p>This indicates the format or destination of the output. The value "xml" indicates
XML output (though if disable-output-escaping or character maps are
used there is no guarantee that it is well-formed).
A value of "html" is used for HTML output, and "xhtml" for XHTML. The value "text" indicates plain text output: in this case
no markup may be written to the file using constructs such as literal result elements, xsl:element,
xsl:attribute, or xsl:comment.Alternatively output can be directed to a user-defined
Java program by specifying the name of the class as the value of the method attribute, prefixed by
a namespace prefix, for example "xx:com.me.myjava.MyEmitter". The class must be
on the classpath, and must implement either the
<code>org.xml.sax.ContentHandler</code> interface, or the
<a class="bodylink" href="../javadoc/net/sf/saxon/event/Receiver.html"><code>Receiver</code></a> interface. The last of these, though proprietary, is a richer interface that
gives access to additional information.</p>
</td>
</tr>
<tr>
<td content="para">
<p>cdata-section-elements</p>
</td>
<td content="para">
<p>This is used only for XML output. It is a whitespace-separated list of
element names. Character data belonging to these output elements will be written within CDATA
sections.</p>
</td>
</tr>
<tr>
<td content="para">
<p>doctype-system</p>
</td>
<td content="para">
<p>This is used only for XML output: it is copied into the DOCTYPE declaration
as the system identifier. If the value is an empty string, Saxon interprets this as if the attribute were
omitted, which can be useful it you want to override an actual value with "absent".</p>
</td>
</tr>
<tr>
<td content="para">
<p>doctype-public</p>
</td>
<td content="para">
<p>This is used only for XML output: it is copied into the DOCTYPE declaration
as the public identifier. It is ignored if there is no system identifier. If the value is an empty string, Saxon interprets this as if the attribute were
omitted, which can be useful it you want to override an actual value with "absent".</p>
</td>
</tr>
<tr>
<td content="para">
<p>encoding</p>
</td>
<td content="para">
<p>A character encoding, e.g. iso-8859-1 or utf-8. The value must be one recognised
both by the Java run-time system and by Saxon itself: the encoding names that Saxon recognises are ASCII,
US-ASCII, iso-8859-1, utf-8, utf8, KOI8R, cp1251. It is used for three distinct purposes: to control character conversion
by the Java I/O routines; to determine which characters will be represented as character entities; and
to document the encoding in the output file itself. The default (and fallback) is utf-8.</p>
</td>
</tr>
<tr>
<td content="para">
<p>escape-uri-attributes</p>
</td>
<td content="para">
<p>New in XSLT 2.0: values "yes" or "no" are accepted. This affects HTML output only.
It controls whether non-ASCII characters in HTML URI-valued attributes (for example, <code>href</code>)
are escaped using the %HH convention. The default is "yes".</p>
</td>
</tr>
<tr>
<td content="para">
<p>include-content-type</p>
</td>
<td content="para">
<p>New in XSLT 2.0: values "yes" or "no" are accepted. This affects HTML output only.
It controls whether a <code>meta</code> tag is inserted into the HTML <code>head</code>
element. The default is "yes".</p>
</td>
</tr>
<tr>
<td content="para">
<p>indent</p>
</td>
<td content="para">
<p>as in the XSLT spec: values "yes" or "no" are accepted. The indentation
algorithm is different for HTML and XML. For HTML it avoids outputting extra space before or
after an inline element, but will indent text as well as tags, except in elements such as PRE
and SCRIPT. For XML, it avoids outputting extra whitespace except between two tags. The
emphasis is on conformance rather than aesthetics!</p>
</td>
</tr>
<tr>
<td content="para">
<p>suppress-indentation</p>
</td>
<td content="para">
<p>This is a new property in XSLT 3.0 (it was previously available
in Saxon as an extension). The value is a whitespace-separated list of element names,
and it typically identifies "inline" elements that should not cause indentation;
in XHTML, for example, these would be <code>b</code>, <code>i</code>, <code>span</code>,
and the like.</p>
</td>
</tr>
<tr>
<td content="para">
<p>media-type</p>
</td>
<td content="para">
<p>For example, "text/xml" or "text/html". This is largely documentary. However,
the value assigned is passed back to the calling application in the OutputDetails object, where
is can be accessed using the getMediaType() method. The supplied servlet application SaxonServlet
uses this to set the media type in the HTTP header.</p>
</td>
</tr>
<tr>
<td content="para">
<p>omit-xml-declaration</p>
</td>
<td content="para">
<p>The values are "yes" or "no".
For XML output this controls whether an xml declaration should be output; the default is "no".
</p>
</td>
</tr>
<tr>
<td content="para">
<p>standalone</p>
</td>
<td content="para">
<p>This is used only for XML output: if it is present, a standalone attribute
is included in the XML declaration, with the value "yes" or "no".</p>
</td>
</tr>
<tr>
<td content="para">
<p>use-character-maps</p>
</td>
<td content="para">
<p>A space-separated list of the names of character maps
(see <a class="bodylink" href="../xsl-elements/character-map.xml">xsl:character-map</a>)
which will be applied to transform individual characters during serialization.</p>
</td>
</tr>
<tr>
<td content="para">
<p>version</p>
</td>
<td content="para">
<p>Determines the version of XML or HTML to be output. This is largely
documentary. However, for XML the distinction between "1.0" and "1.1" determines whether or not namespace
undeclarations will be output; and for HTML, the value "5" can be used to force the HTML5
style of DOCTYPE declaration.</p>
</td>
</tr>
</table>
<p>See <a class="bodylink" href="../extensions/output-extras.xml">Additional Serialization Parameters</a>
for descriptions of additional attributes supported by Saxon on the <code>xsl:output</code> declaration.</p>
<table width="100%">
<tr>
<td>
<p align="right"><a class="nav" href="output-character.xml">Next</a></p>
</td>
</tr>
</table>
</body>
</html>
