Blame docs/params/imagedata.default.scale.xml

Packit Service 76cb02
Packit Service 76cb02
Packit Service 76cb02
<refentry id="imagedata.default.scale">
Packit Service 76cb02
  <refmeta>
Packit Service 76cb02
    <refentrytitle>imagedata.default.scale</refentrytitle>
Packit Service 76cb02
  </refmeta>
Packit Service 76cb02
  <refnamediv>
Packit Service 76cb02
    <refname><parameter>imagedata.default.scale</parameter></refname>
Packit Service 76cb02
    <refpurpose>Specifies the default image scaling properties</refpurpose>
Packit Service 76cb02
  </refnamediv>
Packit Service 76cb02
  <refsynopsisdiv>
Packit Service 76cb02
    <programlisting>
Packit Service 76cb02
      <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="syn/imagedata.default.scale.xml"/></programlisting>
Packit Service 76cb02
  </refsynopsisdiv>
Packit Service 76cb02
  <refsection id="sec-defaultscale">
Packit Service 76cb02
    <title>Description</title>
Packit Service 76cb02
Packit Service 76cb02
    <para>Default scale to apply to every <sgmltag>imagedata</sgmltag> that does not contain any scaling attribute.</para>
Packit Service 76cb02
<para>By default this parameter is set to `pagebound`
Packit Service 76cb02
so that the included images keep their natural size up to the page
Packit Service 76cb02
boundaries.</para>
Packit Service 76cb02
<para>Two other special parameters are available:
Packit Service 76cb02
'maxwidth=<replaceable>width</replaceable>' and
Packit Service 76cb02
'maxheight=<replaceable>height</replaceable>' where <replaceable>width</replaceable>
Packit Service 76cb02
and <replaceable>height</replaceable> define the maximum image
Packit Service 76cb02
dimensions, i.e. the image keeps its natural size up to the specified
Packit Service 76cb02
maximum dimension. Both 'maxwidth' and 'maxheight' settings can be combined in a
Packit Service 76cb02
comma separated list.</para>
Packit Service 76cb02
<para>Example:
Packit Service 76cb02
<programlisting>dblatex -P imagedata.default.scale=maxwidth=10cm,maxheight=8cm file.xml</programlisting>
Packit Service 76cb02
</para>
Packit Service 76cb02
<para>Except these special reserved values, the expected value of the parameter
Packit Service 76cb02
must be some valid options passed to the \includegraphics command.</para>
Packit Service 76cb02
  </refsection>
Packit Service 76cb02
</refentry>