webhelp.start.filename.xml 1.4 KB

12345678910111213141516171819202122232425262728293031323334
  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="webhelp.start.filename">
  7. <refmeta>
  8. <refentrytitle>webhelp.start.filename</refentrytitle>
  9. <refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
  10. </refmeta>
  11. <refnamediv>
  12. <refname>webhelp.start.filename</refname>
  13. <refpurpose>The name of the start file in the webhelp base directory.</refpurpose>
  14. </refnamediv>
  15. <refsynopsisdiv>
  16. <src:fragment xml:id="webhelp.start.filename.frag">
  17. <xsl:param name="webhelp.start.filename">index.html</xsl:param>
  18. </src:fragment>
  19. </refsynopsisdiv>
  20. <refsection><info><title>Description</title></info>
  21. <para>Currently webhelp creates a base directory and puts the output
  22. files in a <filename>content</filename> subdirectory. It creates a
  23. file in the base directory that redirects to a configured file in the
  24. <filename>content</filename> directory. The <parameter>webhelp.start.filename</parameter> parameter lets you configure the name of the redirect file.
  25. <note>
  26. <para>This parameter will be removed from a future version of
  27. webhelp along with the <filename>content</filename>
  28. directory.</para>
  29. </note>
  30. </para>
  31. </refsection>
  32. </refentry>