doc/xslt/params/htmlhelp.default.topic.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.default.topic">
   7 <refmeta>
   8 <refentrytitle>htmlhelp.default.topic</refentrytitle>
   9 <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10 </refmeta>
  11 <refnamediv>
  12 <refname>htmlhelp.default.topic</refname>
  13 <refpurpose>Name of file with default topic</refpurpose>
  14 </refnamediv>
  15
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="htmlhelp.default.topic.frag">
  18 <xsl:param name="htmlhelp.default.topic"></xsl:param>
  19 </src:fragment>
  20 </refsynopsisdiv>
  21
  22 <refsection><info><title>Description</title></info>
  23
  24 <para>Normally first chunk of document is displayed when you open HTML
  25 Help file. If you want to display another topic, simply set its
  26 filename by this parameter.</para>
  27
  28 <para>This is useful especially if you don't generate ToC in front of
  29 your document and you also hide root element in ToC. E.g.:</para>
  30
  31 <programlisting>&lt;xsl:param name="generate.book.toc" select="0"/&gt;
  32 &lt;xsl:param name="htmlhelp.hhc.show.root" select="0"/&gt;
  33 &lt;xsl:param name="htmlhelp.default.topic">pr01.html&lt;/xsl:param>
  34 </programlisting>
  35
  36 </refsection>
  37 </refentry>