webhelp.start.filename.xml #1

<refentry xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:xi="http://www.w3.org/2001/XInclude"
          xmlns:src="http://nwalsh.com/xmlns/litprog/fragment"
          xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
          version="5.0" xml:id="webhelp.start.filename">
<refmeta>
<refentrytitle>webhelp.start.filename</refentrytitle>
<refmiscinfo class="other" otherclass="datatype">string</refmiscinfo>
</refmeta>
<refnamediv>
<refname>webhelp.start.filename</refname>
<refpurpose>The name of the start file in the webhelp base directory.</refpurpose>
</refnamediv>

<refsynopsisdiv>
<src:fragment xml:id="webhelp.start.filename.frag">
<xsl:param name="webhelp.start.filename">index.html</xsl:param>
</src:fragment>
</refsynopsisdiv>

<refsection><info><title>Description</title></info>
<para>Currently webhelp creates a base directory and puts the output
files in a <filename>content</filename> subdirectory. It creates a
file in the base directory that redirects to a configured file in the
<filename>content</filename> directory. The <parameter>webhelp.start.filename</parameter> parameter lets you configure the name of the redirect file.
<note>
  <para>This parameter will be removed from a future version of
  webhelp along with the <filename>content</filename>
  directory.</para>
</note>
</para>
</refsection>
</refentry>