<?xml version="1.0" encoding="utf-8"?>
<section id="S__db2omf">
  <title>DocBook to ScrollKeeper OMF</title>
  <remark>This needs documentation</remark>
  <variablelist>
    <title>Parameters</title>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_basename">
          <parameter>db2omf.basename</parameter>
        </link>
      </term>
      <listitem>
        <para>The basename of the referenced document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_format">
          <parameter>db2omf.format</parameter>
        </link>
      </term>
      <listitem>
        <para>The format of the referenced document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_mime">
          <parameter>db2omf.mime</parameter>
        </link>
      </term>
      <listitem>
        <para>The MIME type of the referenced document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_dtd">
          <parameter>db2omf.dtd</parameter>
        </link>
      </term>
      <listitem>
        <para>The FPI of the DocBook version used</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_lang">
          <parameter>db2omf.lang</parameter>
        </link>
      </term>
      <listitem>
        <para>The written language of the referenced document</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_omf_dir">
          <parameter>db2omf.omf_dir</parameter>
        </link>
      </term>
      <listitem>
        <para>The top-level ScrollKeeper OMF directory</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_help_dir">
          <parameter>db2omf.help_dir</parameter>
        </link>
      </term>
      <listitem>
        <para>The top-level directory where documentation is installed</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_omf_in">
          <parameter>db2omf.omf_in</parameter>
        </link>
      </term>
      <listitem>
        <para>Path to the OMF input file containing common fields</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="P__db2omf_scrollkeeper_cl">
          <parameter>db2omf.scrollkeeper_cl</parameter>
        </link>
      </term>
      <listitem>
        <para>The path to the installed scrollkeeper_cl.xml file</para>
      </listitem>
    </varlistentry>
  </variablelist>
  <variablelist>
    <title>Templates</title>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf">
          <function>db2omf.omf</function>
        </link>
      </term>
      <listitem>
        <para>Generates the top-level <literal>omf</literal> and all its children</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_creator">
          <function>db2omf.omf.creator</function>
        </link>
      </term>
      <listitem>
        <para>Generates all the <literal>creator</literal> elements for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_maintainer">
          <function>db2omf.omf.maintainer</function>
        </link>
      </term>
      <listitem>
        <para>Generates all the <literal>maintainer</literal> elements for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_contributor">
          <function>db2omf.omf.contributor</function>
        </link>
      </term>
      <listitem>
        <para>Generates all the <literal>contributor</literal> elements for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_title">
          <function>db2omf.omf.title</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>title</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_date">
          <function>db2omf.omf.date</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>date</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_version">
          <function>db2omf.omf.version</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>version</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_subject">
          <function>db2omf.omf.subject</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>subject</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_description">
          <function>db2omf.omf.description</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>description</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_type">
          <function>db2omf.omf.type</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>type</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_format">
          <function>db2omf.omf.format</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>format</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_identifier">
          <function>db2omf.omf.identifier</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>identifier</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_language">
          <function>db2omf.omf.language</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>language</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_relation">
          <function>db2omf.omf.relation</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>relation</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
    <varlistentry>
      <term>
        <link linkend="T__db2omf_omf_rights">
          <function>db2omf.omf.rights</function>
        </link>
      </term>
      <listitem>
        <para>Generates the <literal>rights</literal> element for an OMF file</para>
      </listitem>
    </varlistentry>
  </variablelist>
  <refentry id="P__db2omf_basename">
    <indexterm>
      <primary>db2omf.basename</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.basename</parameter>
      </refname>
      <refpurpose>The basename of the referenced document</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document what a basename is</remark>
  </refsection>
  </refentry>
  <refentry id="P__db2omf_format">
    <indexterm>
      <primary>db2omf.format</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.format</parameter>
      </refname>
      <refpurpose>The format of the referenced document</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="P__db2omf_mime">
    <indexterm>
      <primary>db2omf.mime</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.mime</parameter>
      </refname>
      <refpurpose>The MIME type of the referenced document</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="P__db2omf_dtd">
    <indexterm>
      <primary>db2omf.dtd</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.dtd</parameter>
      </refname>
      <refpurpose>The FPI of the DocBook version used</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="P__db2omf_lang">
    <indexterm>
      <primary>db2omf.lang</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.lang</parameter>
      </refname>
      <refpurpose>The written language of the referenced document</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="P__db2omf_omf_dir">
    <indexterm>
      <primary>db2omf.omf_dir</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.omf_dir</parameter>
      </refname>
      <refpurpose>The top-level ScrollKeeper OMF directory</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="P__db2omf_help_dir">
    <indexterm>
      <primary>db2omf.help_dir</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.help_dir</parameter>
      </refname>
      <refpurpose>The top-level directory where documentation is installed</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="P__db2omf_omf_in">
    <indexterm>
      <primary>db2omf.omf_in</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.omf_in</parameter>
      </refname>
      <refpurpose>Path to the OMF input file containing common fields</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="P__db2omf_scrollkeeper_cl">
    <indexterm>
      <primary>db2omf.scrollkeeper_cl</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <parameter>db2omf.scrollkeeper_cl</parameter>
      </refname>
      <refpurpose>The path to the installed scrollkeeper_cl.xml file</refpurpose>
    </refnamediv>
    <refsection><title>Description</title>
  <remark>Document what this is for</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf">
    <indexterm>
      <primary>db2omf.omf</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf</function>
      </refname>
      <refpurpose>Generates the top-level <literal>omf</literal> and all its children</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_creator">
    <indexterm>
      <primary>db2omf.omf.creator</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.creator</function>
      </refname>
      <refpurpose>Generates all the <literal>creator</literal> elements for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_maintainer">
    <indexterm>
      <primary>db2omf.omf.maintainer</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.maintainer</function>
      </refname>
      <refpurpose>Generates all the <literal>maintainer</literal> elements for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_contributor">
    <indexterm>
      <primary>db2omf.omf.contributor</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.contributor</function>
      </refname>
      <refpurpose>Generates all the <literal>contributor</literal> elements for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_title">
    <indexterm>
      <primary>db2omf.omf.title</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.title</function>
      </refname>
      <refpurpose>Generates the <literal>title</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_date">
    <indexterm>
      <primary>db2omf.omf.date</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.date</function>
      </refname>
      <refpurpose>Generates the <literal>date</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_version">
    <indexterm>
      <primary>db2omf.omf.version</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.version</function>
      </refname>
      <refpurpose>Generates the <literal>version</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this, add the @description attr of version</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_subject">
    <indexterm>
      <primary>db2omf.omf.subject</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.subject</function>
      </refname>
      <refpurpose>Generates the <literal>subject</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_description">
    <indexterm>
      <primary>db2omf.omf.description</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.description</function>
      </refname>
      <refpurpose>Generates the <literal>description</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_type">
    <indexterm>
      <primary>db2omf.omf.type</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.type</function>
      </refname>
      <refpurpose>Generates the <literal>type</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_format">
    <indexterm>
      <primary>db2omf.omf.format</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.format</function>
      </refname>
      <refpurpose>Generates the <literal>format</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_identifier">
    <indexterm>
      <primary>db2omf.omf.identifier</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.identifier</function>
      </refname>
      <refpurpose>Generates the <literal>identifier</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_language">
    <indexterm>
      <primary>db2omf.omf.language</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.language</function>
      </refname>
      <refpurpose>Generates the <literal>language</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_relation">
    <indexterm>
      <primary>db2omf.omf.relation</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.relation</function>
      </refname>
      <refpurpose>Generates the <literal>relation</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
  <refentry id="T__db2omf_omf_rights">
    <indexterm>
      <primary>db2omf.omf.rights</primary>
    </indexterm>
    <refnamediv>
      <refname>
        <function>db2omf.omf.rights</function>
      </refname>
      <refpurpose>Generates the <literal>rights</literal> element for an OMF file</refpurpose>
    </refnamediv>
    <refsection>
      <title>Parameters</title>
      <variablelist>
        <varlistentry>
          <term>
            <parameter>info</parameter>
          </term>
          <listitem>
            <para>The info element containing metadata</para>
          </listitem>
        </varlistentry>
      </variablelist>
    </refsection>
    <refsection><title>Description</title>
  <remark>Document this</remark>
  </refsection>
  </refentry>
</section>
