htmlhelp.default.topic.xml 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637
  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. <refsynopsisdiv>
  16. <src:fragment xml:id="htmlhelp.default.topic.frag">
  17. <xsl:param name="htmlhelp.default.topic"></xsl:param>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>Normally first chunk of document is displayed when you open HTML
  22. Help file. If you want to display another topic, simply set its
  23. filename by this parameter.</para>
  24. <para>This is useful especially if you don't generate ToC in front of
  25. your document and you also hide root element in ToC. E.g.:</para>
  26. <programlisting>&lt;xsl:param name="generate.book.toc" select="0"/&gt;
  27. &lt;xsl:param name="htmlhelp.hhc.show.root" select="0"/&gt;
  28. &lt;xsl:param name="htmlhelp.default.topic">pr01.html&lt;/xsl:param>
  29. </programlisting>
  30. </refsection>
  31. </refentry>