]> git.stg.codes - stg.git/blob - doc/xslt/params/rootid.xml
Merge remote-tracking branch 'origin/stg-2.409' into ticket26
[stg.git] / doc / xslt / params / rootid.xml
1 <refentry xmlns="http://docbook.org/ns/docbook"
2           xmlns:xlink="http://www.w3.org/1999/xlink"
3           xmlns:xi="http://www.w3.org/2001/XInclude"
4           xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
5           xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
6           version="5.0" xml:id="rootid">
7 <refmeta>
8 <refentrytitle>rootid</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>rootid</refname>
13 <refpurpose>Specify the root element to format</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="rootid.frag">
18 <xsl:param name="rootid" ></xsl:param></src:fragment>
19 </refsynopsisdiv>
20
21 <refsection><info><title>Description</title></info>
22
23 <para>If <parameter>rootid</parameter> is not empty, it must be the
24 value of an ID that occurs in the document being formatted. The entire
25 document will be loaded and parsed, but formatting will begin at the
26 element identified, rather than at the root. For example, this allows
27 you to process only <tag>chapter</tag> 4 of a <tag>book</tag>.</para>
28 <para>Because the entire document is available to the processor, automatic
29 numbering, cross references, and other dependencies are correctly
30 resolved.</para>
31
32 </refsection>
33 </refentry>