summaryrefslogtreecommitdiffstats
path: root/kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml
diff options
context:
space:
mode:
authortoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
committertoma <toma@283d02a7-25f6-0310-bc7c-ecb5cbfe19da>2009-11-25 17:56:58 +0000
commitce4a32fe52ef09d8f5ff1dd22c001110902b60a2 (patch)
tree5ac38a06f3dde268dc7927dc155896926aaf7012 /kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml
downloadtdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.tar.gz
tdelibs-ce4a32fe52ef09d8f5ff1dd22c001110902b60a2.zip
Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.
BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da
Diffstat (limited to 'kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml')
-rw-r--r--kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml31
1 files changed, 31 insertions, 0 deletions
diff --git a/kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml b/kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml
new file mode 100644
index 000000000..9350d7b3a
--- /dev/null
+++ b/kdoctools/docbook/xsl/params/htmlhelp.default.topic.xml
@@ -0,0 +1,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>