|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gnome/help/gnome-doc-xslt/C/ |
Upload File : |
<section id="section-db2omf">
<title>DocBook to ScrollKeeper OMF</title>
<variablelist>
<title>Parameters</title>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="param_db2omf.basename">
<parameter>db2omf.basename</parameter>
</link>
</term>
<listitem>
<para>
The basename of the referenced document
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="param_db2omf.format">
<parameter>db2omf.format</parameter>
</link>
</term>
<listitem>
<para>
The format of the referenced document
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="param_db2omf.mime">
<parameter>db2omf.mime</parameter>
</link>
</term>
<listitem>
<para>
The MIME type of the referenced document, docbook or html
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="param_db2omf.dtd">
<parameter>db2omf.dtd</parameter>
</link>
</term>
<listitem>
<para>
The FPI of the DocBook version used
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="param_db2omf.lang">
<parameter>db2omf.lang</parameter>
</link>
</term>
<listitem>
<para>
The written language of the referenced document
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="param_db2omf.omf_dir">
<parameter>db2omf.omf_dir</parameter>
</link>
</term>
<listitem>
<para>
The top-level ScrollKeeper OMF directory
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="param_db2omf.help_dir">
<parameter>db2omf.help_dir</parameter>
</link>
</term>
<listitem>
<para>
The top-level directory where documentation is installed
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="param_db2omf.omf_in">
<parameter>db2omf.omf_in</parameter>
</link>
</term>
<listitem>
<para>
Path to the .omf.in file containing common fields
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<title>Templates</title>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf">
<function role="template">db2omf.omf</function>
</link>
</term>
<listitem>
<para>
Generate the top-level omf and all its children
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.creator">
<function role="template">db2omf.omf.creator</function>
</link>
</term>
<listitem>
<para>
Generate all creator elements
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.maintainer">
<function role="template">db2omf.omf.maintainer</function>
</link>
</term>
<listitem>
<para>
Generate all maintainer elements
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.contributor">
<function role="template">db2omf.omf.contributor</function>
</link>
</term>
<listitem>
<para>
Generate all contributor elements
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.title">
<function role="template">db2omf.omf.title</function>
</link>
</term>
<listitem>
<para>
Generate the title element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.date">
<function role="template">db2omf.omf.date</function>
</link>
</term>
<listitem>
<para>
Generate the date element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.version">
<function role="template">db2omf.omf.version</function>
</link>
</term>
<listitem>
<para>
Generate the version element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.subject">
<function role="template">db2omf.omf.subject</function>
</link>
</term>
<listitem>
<para>
Generate the subject element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.description">
<function role="template">db2omf.omf.description</function>
</link>
</term>
<listitem>
<para>
Generate the description element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.type">
<function role="template">db2omf.omf.type</function>
</link>
</term>
<listitem>
<para>
Generate the type element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.format">
<function role="template">db2omf.omf.format</function>
</link>
</term>
<listitem>
<para>
Generate the format element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.identifier">
<function role="template">db2omf.omf.identifier</function>
</link>
</term>
<listitem>
<para>
Generate the identifier element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.language">
<function role="template">db2omf.omf.language</function>
</link>
</term>
<listitem>
<para>
Generate the language element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.relation">
<function role="template">db2omf.omf.relation</function>
</link>
</term>
<listitem>
<para>
Generate the relation element
</para>
</listitem>
</varlistentry>
<varlistentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude">
<term>
<link linkend="template_db2omf.omf.rights">
<function role="template">db2omf.omf.rights</function>
</link>
</term>
<listitem>
<para>
Generate the rights element
</para>
</listitem>
</varlistentry>
</variablelist>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="param_db2omf.basename">
<indexterm>
<primary>db2omf.basename</primary>
</indexterm>
<refnamediv>
<refname>db2omf.basename</refname>
<refpurpose>
The basename of the referenced document
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This parameter has no description</para>
</refsection>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="param_db2omf.format">
<indexterm>
<primary>db2omf.format</primary>
</indexterm>
<refnamediv>
<refname>db2omf.format</refname>
<refpurpose>
The format of the referenced document
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This parameter has no description</para>
</refsection>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="param_db2omf.mime">
<indexterm>
<primary>db2omf.mime</primary>
</indexterm>
<refnamediv>
<refname>db2omf.mime</refname>
<refpurpose>
The MIME type of the referenced document, docbook or html
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This parameter has no description</para>
</refsection>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="param_db2omf.dtd">
<indexterm>
<primary>db2omf.dtd</primary>
</indexterm>
<refnamediv>
<refname>db2omf.dtd</refname>
<refpurpose>
The FPI of the DocBook version used
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This parameter has no description</para>
</refsection>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="param_db2omf.lang">
<indexterm>
<primary>db2omf.lang</primary>
</indexterm>
<refnamediv>
<refname>db2omf.lang</refname>
<refpurpose>
The written language of the referenced document
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This parameter has no description</para>
</refsection>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="param_db2omf.omf_dir">
<indexterm>
<primary>db2omf.omf_dir</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf_dir</refname>
<refpurpose>
The top-level ScrollKeeper OMF directory
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This parameter has no description</para>
</refsection>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="param_db2omf.help_dir">
<indexterm>
<primary>db2omf.help_dir</primary>
</indexterm>
<refnamediv>
<refname>db2omf.help_dir</refname>
<refpurpose>
The top-level directory where documentation is installed
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This parameter has no description</para>
</refsection>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="param_db2omf.omf_in">
<indexterm>
<primary>db2omf.omf_in</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf_in</refname>
<refpurpose>
Path to the .omf.in file containing common fields
</refpurpose>
</refnamediv>
<refsection>
<title>Description</title>
<para>This parameter has no description</para>
</refsection>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf">
<indexterm>
<primary>db2omf.omf</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf</refname>
<refpurpose>
Generate the top-level <sgmltag>omf</sgmltag> 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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.creator">
<indexterm>
<primary>db2omf.omf.creator</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.creator</refname>
<refpurpose>
Generate all <sgmltag>creator</sgmltag> elements
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.maintainer">
<indexterm>
<primary>db2omf.omf.maintainer</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.maintainer</refname>
<refpurpose>
Generate all <sgmltag>maintainer</sgmltag> elements
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.contributor">
<indexterm>
<primary>db2omf.omf.contributor</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.contributor</refname>
<refpurpose>
Generate all <sgmltag>contributor</sgmltag> elements
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.title">
<indexterm>
<primary>db2omf.omf.title</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.title</refname>
<refpurpose>
Generate the <sgmltag>title</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.date">
<indexterm>
<primary>db2omf.omf.date</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.date</refname>
<refpurpose>
Generate the <sgmltag>date</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.version">
<indexterm>
<primary>db2omf.omf.version</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.version</refname>
<refpurpose>
Generate the <sgmltag>version</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.subject">
<indexterm>
<primary>db2omf.omf.subject</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.subject</refname>
<refpurpose>
Generate the <sgmltag>subject</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.description">
<indexterm>
<primary>db2omf.omf.description</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.description</refname>
<refpurpose>
Generate the <sgmltag>description</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.type">
<indexterm>
<primary>db2omf.omf.type</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.type</refname>
<refpurpose>
Generate the <sgmltag>type</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.format">
<indexterm>
<primary>db2omf.omf.format</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.format</refname>
<refpurpose>
Generate the <sgmltag>format</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.identifier">
<indexterm>
<primary>db2omf.omf.identifier</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.identifier</refname>
<refpurpose>
Generate the <sgmltag>identifier</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.language">
<indexterm>
<primary>db2omf.omf.language</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.language</refname>
<refpurpose>
Generate the <sgmltag>language</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.relation">
<indexterm>
<primary>db2omf.omf.relation</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.relation</refname>
<refpurpose>
Generate the <sgmltag>relation</sgmltag> element
</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>
</refentry>
<refentry xmlns:fxi="http://www.w3.org/2001/XInclude" xmlns:xi="http://www.w3.org/2001/XInclude" id="template_db2omf.omf.rights">
<indexterm>
<primary>db2omf.omf.rights</primary>
</indexterm>
<refnamediv>
<refname>db2omf.omf.rights</refname>
<refpurpose>
Generate the <sgmltag>rights</sgmltag> element
</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>
</refentry>
</section>