]> git.stg.codes - stg.git/blob - doc/xslt/params/htmlhelp.hhc.show.root.xml
Ticket 26. The 'const MODULE_SETTINGS & ms' parameter added in the
[stg.git] / doc / xslt / params / htmlhelp.hhc.show.root.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="htmlhelp.hhc.show.root">
7 <refmeta>
8 <refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
9 <refmiscinfo class="other" otherclass="datatype">boolean</refmiscinfo>
10 </refmeta>
11 <refnamediv>
12 <refname>htmlhelp.hhc.show.root</refname>
13 <refpurpose>Should there be an entry for the root element in the ToC?</refpurpose>
14 </refnamediv>
15
16 <refsynopsisdiv>
17 <src:fragment xml:id="htmlhelp.hhc.show.root.frag">
18 <xsl:param name="htmlhelp.hhc.show.root" select="1"/>
19 </src:fragment>
20 </refsynopsisdiv>
21
22 <refsection><info><title>Description</title></info>
23
24 <para>If set to zero, there will be no entry for the root element in the 
25 ToC. This is useful when you want to provide the user with an expanded
26 ToC as a default.</para>
27
28 </refsection>
29 </refentry>