summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml
blob: 9350d7b3a2d9612e3ce60b2f7475d2c2f7b20d74 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<refentry id="htmlhelp.default.topic">
<refmeta>
<refentrytitle>htmlhelp.default.topic</refentrytitle>
<refmiscinfo role="type">string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>htmlhelp.default.topic</refname>
<refpurpose>Name of file with default topic</refpurpose>
</refnamediv>

<refsynopsisdiv>
<src:fragment id='htmlhelp.default.topic.frag'>
<xsl:param name="htmlhelp.default.topic" select="''"/>
</src:fragment>
</refsynopsisdiv>

<refsect1><title>Description</title>

<para>Normally first chunk of document is displayed when you open HTML
Help file. If you want to display another topic, simply set its
filename by this parameter.</para>

<para>This is useful especially if you don't generate ToC in front of
your document and you also hide root element in ToC. E.g.:</para>

<programlisting><![CDATA[<xsl:param name="generate.book.toc" select="0"/>
<xsl:param name="htmlhelp.hhc.show.root" select="0"/>
<xsl:param name="htmlhelp.default.topic" select="'pr01.html'"/>]]></programlisting>

</refsect1>
</refentry>