Blame docs/params/literal.environment.xml

Packit Service 76cb02
Packit Service 76cb02
Packit Service 76cb02
<refentry id="literal.environment">
Packit Service 76cb02
  <refmeta>
Packit Service 76cb02
    <refentrytitle>literal.environment</refentrytitle>
Packit Service 76cb02
  </refmeta>
Packit Service 76cb02
  <refnamediv>
Packit Service 76cb02
    <refname><parameter>literal.environment</parameter></refname>
Packit Service 76cb02
    <refpurpose>Latex environment used to format verbatim blocks</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/literal.environment.xml"/></programlisting>
Packit Service 76cb02
  </refsynopsisdiv>
Packit Service 76cb02
  <refsection>
Packit Service 76cb02
    <title>Description</title>
Packit Service 76cb02
    <para>It specifies the Latex environment to use to render a verbatim
Packit Service 76cb02
    block.</para>
Packit Service 76cb02
    <para>Since <command>dblatex</command> uses the listings package 
Packit Service 76cb02
    capabilities to
Packit Service 76cb02
    handle the DocBook attributes, the specified environment must have the same
Packit Service 76cb02
    capabilities if written from scratch, but it is recommended to just extend
Packit Service 76cb02
    the listings environment with you own listings extension. See 
Packit Service 76cb02
    linkend="sec-literal-env"/> for more details.</para>
Packit Service 76cb02
    <para>The specified environment name must starts with
Packit Service 76cb02
    <literal>"lst"</literal>. Otherwise <command>dblatex</command> raises an
Packit Service 76cb02
    error and exits.</para>
Packit Service 76cb02
  </refsection>
Packit Service 76cb02
  <refsection>
Packit Service 76cb02
    <title>See Also</title>
Packit Service 76cb02
    <para><parameter>literal.extensions</parameter>.</para>
Packit Service 76cb02
  </refsection>
Packit Service 76cb02
</refentry>