summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/rootid.xml
diff options
context:
space:
mode:
Diffstat (limited to 'kdoctools/docbook/xsl/params/rootid.xml')
-rw-r--r--kdoctools/docbook/xsl/params/rootid.xml27
1 files changed, 27 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/rootid.xml b/kdoctools/docbook/xsl/params/rootid.xml
new file mode 100644
index 000000000..49108ffa4
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/rootid.xml
@@ -0,0 +1,27 @@
+<refentry id="rootid">
+<refmeta>
+<refentrytitle>rootid</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>rootid</refname>
+<refpurpose>Specify the root element to format</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='rootid.frag'><xsl:param name="rootid" select="''"/></src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>If <parameter>rootid</parameter> is specified, it must be the
+value of an ID that occurs in the document being formatted. The entire
+document will be loaded and parsed, but formatting will begin at the
+element identified, rather than at the root. For example, this allows
+you to process only chapter 4 of a book.</para>
+<para>Because the entire document is available to the processor, automatic
+numbering, cross references, and other dependencies are correctly
+resolved.</para>
+
+</refsect1>
+</refentry>