Blame docs/figure.xml

Packit 0f19cf
Packit 0f19cf
Packit 0f19cf
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
Packit 0f19cf
  <section id="sec-figinclude">
Packit 0f19cf
   <title>
Packit 0f19cf
   Figure Inclusion
Packit 0f19cf
  </title>
Packit 0f19cf
   <section>
Packit 0f19cf
    <title>
Packit 0f19cf
    Presentation
Packit 0f19cf
   </title>
Packit 0f19cf
   <para>
Packit 0f19cf
    The expected format of the included figures depends on the backend driver used:
Packit 0f19cf
   </para>
Packit 0f19cf
   <variablelist>
Packit 0f19cf
    <varlistentry>
Packit 0f19cf
    <term>
Packit 0f19cf
    dvips:
Packit 0f19cf
</term><listitem><para>EPS format is required.
Packit 0f19cf
    </para>
Packit 0f19cf
   </listitem>
Packit 0f19cf
   </varlistentry>
Packit 0f19cf
    <varlistentry>
Packit 0f19cf
    <term>
Packit 0f19cf
    pdftex:
Packit 0f19cf
</term><listitem><para>PDF or PNG format is required.
Packit 0f19cf
    </para>
Packit 0f19cf
   </listitem>
Packit 0f19cf
   </varlistentry>
Packit 0f19cf
   </variablelist>
Packit 0f19cf
   <para>
Packit 0f19cf
    In order to be able to use both backends, it is wise to not write the suffix of the file that references the figure. The suffix will be deduced from the backend used.
Packit 0f19cf
   </para>
Packit 0f19cf
   <para>
Packit 0f19cf
    The figures must either already exists in the expected format, or must be able to be converted on the fly.
Packit 0f19cf
   </para>
Packit 0f19cf
<example><title>Figure inclusion</title>
Packit 0f19cf
   <programlisting>
Packit 0f19cf
 
Packit 0f19cf
]]>Components</title> 
Packit 0f19cf
]]>
Packit 0f19cf
]]> 
Packit 0f19cf
]]> 
Packit 0f19cf
]]> 
Packit 0f19cf
]]>
Packit 0f19cf
]]>
Packit 0f19cf
]]>   </programlisting>
Packit 0f19cf
</example>
Packit 0f19cf
   </section>
Packit 0f19cf
   <section id="sec-figconv">
Packit 0f19cf
    <title>
Packit 0f19cf
    Converting on the fly
Packit 0f19cf
   </title>
Packit 0f19cf
   <para>When it is needed dblatex tries to automatically convert the figures to
Packit 0f19cf
   the expected format (i.e. EPS or PDF). The principle is to detect the original
Packit 0f19cf
   figure format from the suffix of the fileref attribute. If no suffix is given,
Packit 0f19cf
   the tool checks if a file whose basename is conformant with the
Packit 0f19cf
   fileref attribute and with one of the predefined suffixes exists (that is, ".eps",
Packit 0f19cf
   ".fig", ".pdf", or ".png"). If such a file exists, conversion is done from the
Packit 0f19cf
   original format found.
Packit 0f19cf
   </para>
Packit 0f19cf
   <para>
Packit 0f19cf
    The option <option>-f <replaceable>fig_format</replaceable></option> allows to specify the default included figures format (<replaceable>fig_format</replaceable>), that will be used when automatic format scanning gives no result. Then, the tool converts the figures from the specified format to the expected one.
Packit 0f19cf
   </para>
Packit 0f19cf
   <para>
Packit 0f19cf
    If the specified format is unknown, no conversion is done. The supported formats are:
Packit 0f19cf
   </para>
Packit 0f19cf
   <variablelist>
Packit 0f19cf
    <varlistentry>
Packit 0f19cf
    <term>
Packit 0f19cf
    fig:
Packit 0f19cf
</term><listitem><para>native format of the figures produced by XFig.
Packit 0f19cf
    </para>
Packit 0f19cf
   </listitem>
Packit 0f19cf
   </varlistentry>
Packit 0f19cf
    <varlistentry>
Packit 0f19cf
    <term>
Packit 0f19cf
    eps:
Packit 0f19cf
</term><listitem><para>Encapsulated PostScript format. This format shall be specified only when using the pdftex backend.
Packit 0f19cf
    </para>
Packit 0f19cf
   </listitem>
Packit 0f19cf
   </varlistentry>
Packit 0f19cf
   </variablelist>
Packit 0f19cf
<example><title>Figure conversion</title>
Packit 0f19cf
   <para>
Packit 0f19cf
    The following command compiles a document that contains figures produced with XFig.
Packit 0f19cf
   </para>
Packit 0f19cf
   <programlisting>
Packit 0f19cf
Packit 0f19cf
]]>   </programlisting>
Packit 0f19cf
</example>
Packit 0f19cf
   </section>
Packit 0f19cf
   <section id="sec-lookup">
Packit 0f19cf
    <title>
Packit 0f19cf
    Paths Lookup
Packit 0f19cf
   </title>
Packit 0f19cf
   <para>
Packit 0f19cf
    You can use and cumulate the option <option>-I <replaceable>path</replaceable></option> to specify where the figures are. The given paths can be absolute or relative.
Packit 0f19cf
    The paths are added to the document root path.
Packit 0f19cf
   </para>
Packit 0f19cf
<example><title>Figures lookup</title>
Packit 0f19cf
   <para>
Packit 0f19cf
    This example shows how figure lookup is done. Let's consider this document source:
Packit 0f19cf
   </para>
Packit 0f19cf
   <programlisting>
Packit 0f19cf
 
Packit 0f19cf
]]>Composants</title> 
Packit 0f19cf
]]>
Packit 0f19cf
]]> 
Packit 0f19cf
]]> 
Packit 0f19cf
]]> 
Packit 0f19cf
]]>
Packit 0f19cf
]]>
Packit 0f19cf
]]>   </programlisting>
Packit 0f19cf
   <para>
Packit 0f19cf
    And the document is compiled like this:
Packit 0f19cf
   </para>
Packit 0f19cf
   <programlisting>
Packit 0f19cf
Packit 0f19cf
]]>   </programlisting>
Packit 0f19cf
   <para>
Packit 0f19cf
    The figure1 lookup is done in the following directories, in respect of the order:
Packit 0f19cf
   </para>
Packit 0f19cf
   <itemizedlist spacing="compact">
Packit 0f19cf
    <listitem>
Packit 0f19cf
    <para>
Packit 0f19cf
    <filename>/initial/path/rep1/rep2</filename> ;
Packit 0f19cf
    </para>
Packit 0f19cf
   </listitem>
Packit 0f19cf
    <listitem>
Packit 0f19cf
    <para>
Packit 0f19cf
    <filename>/another/path/rep1/rep2</filename> ;
Packit 0f19cf
    </para>
Packit 0f19cf
   </listitem>
Packit 0f19cf
    <listitem>
Packit 0f19cf
    <para>
Packit 0f19cf
    <filename>/last/case/rep1/rep2</filename>.
Packit 0f19cf
    </para>
Packit 0f19cf
   </listitem>
Packit 0f19cf
   </itemizedlist>
Packit 0f19cf
</example>
Packit 0f19cf
   </section>
Packit 0f19cf
  </section>