params/webhelp.start.filename.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="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
  16 <refsynopsisdiv>
  17 <src:fragment xml:id="webhelp.start.filename.frag">
  18 <xsl:param name="webhelp.start.filename">index.html</xsl:param>
  19 </src:fragment>
  20 </refsynopsisdiv>
  21
  22 <refsection><info><title>Description</title></info>
  23 <para>Currently webhelp creates a base directory and puts the output
  24 files in a <filename>content</filename> subdirectory. It creates a
  25 file in the base directory that redirects to a configured file in the
  26 <filename>content</filename> directory. The <parameter>webhelp.start.filename</parameter> parameter lets you configure the name of the redirect file.
  27 <note>
  28   <para>This parameter will be removed from a future version of
  29   webhelp along with the <filename>content</filename>
  30   directory.</para>
  31 </note>
  32 </para>
  33 </refsection>
  34 </refentry>