doc/refentry/frontend-spec.sgml

   1 <refentry id="frontend-spec">
   2   <docinfo>
   3  <author>
   4    <firstname>Eric</firstname> <surname>Bischoff</surname>
   5    <affiliation>
   6      <address><email>ebisch@cybercable.tm.fr</email></address>
   7    </affiliation>
   8  </author>
   9   </docinfo>
  10   <refmeta>
  11  <refentrytitle>frontend-spec</refentrytitle>
  12  <manvolnum>7</manvolnum>
  13   </refmeta>
  14
  15   <refnamediv>
  16  <refname>frontend-spec</refname>
  17  <refpurpose>interface between jw and its frontends</refpurpose>
  18   </refnamediv>
  19
  20   <refsect1>
  21     <title>Description</title>
  22
  23     <para><citerefentry> <refentrytitle>jw</refentrytitle>
  24     <manvolnum>1</manvolnum> </citerefentry> calls frontends like
  25     <filename>frontends/docbook</filename> to get the informations
  26     specific to a given input format. The frontend knows which information
  27     to return from the first command line parameter. It gets all necessary
  28     data via environment variables ready to use.</para>
  29
  30     <para>This document describes that command line parameter and those
  31     environment variables.</para>
  32
  33     <para>The frontend should return 0 if there weren't any problem,
  34     and return a positive value otherwise.</para>
  35
  36   </refsect1>
  37
  38   <refsect1>
  39     <title>Variables</title>
  40
  41     <glosslist>
  42       <glossentry>
  43         <glossterm>
  44           <envar>$1</envar>
  45         </glossterm>
  46         <glossdef>
  47           <para>The command line parameter, specifying which information
  48           to return. It can take the following values:
  49           <variablelist>
  50             <varlistentry>
  51               <term>centralized-catalog</term>
  52               <listitem><para>The frontend must return the DTD-specific
  53               centralized catalog name.  Centralized catalogs normally
  54               reside in <filename>/etc/sgml</filename> and provide the
  55               location of all the catalog files useful for handling
  56               this input type (the catalog for the DTD, the catalog
  57               for the stylesheets, the catalog for the entities,
  58               ...)</para></listitem>
  59             </varlistentry>
  60             <varlistentry>
  61               <term>style-sheet</term>
  62               <listitem><para>The frontend must return the filename
  63               of the style sheet to be used for this document type and
  64               with the chosen backend.</para></listitem>
  65             </varlistentry>
  66           </variablelist>
  67           </para>
  68         </glossdef>
  69       </glossentry>
  70     </glosslist>
  71
  72     <para></para>
  73
  74     <glosslist>
  75       <glossentry>
  76         <glossterm>
  77           <envar>SGML_CATALOGS_DIR</envar>
  78         </glossterm>
  79         <glossdef>
  80           <para>The directory where the centralized catalogs reside. It is normally
  81             <filename>/etc/sgml</filename>.</para>
  82           <para>(This variable is valid only while determining
  83             the centralized catalog to use.)</para>
  84         </glossdef>
  85       </glossentry>
  86     </glosslist>
  87
  88     <para></para>
  89
  90     <glosslist>
  91       <glossentry>
  92         <glossterm>
  93           <envar>SGML_BASE_DIR</envar>
  94         </glossterm>
  95         <glossdef>
  96           <para>The base directory of the SGML system. It is normally
  97             <filename>/usr/share/sgml</filename>.</para>
  98           <para>(This variable is valid only while determining
  99             the style sheet to use.)</para>
 100         </glossdef>
 101       </glossentry>
 102     </glosslist>
 103
 104     <para></para>
 105
 106     <glosslist>
 107       <glossentry>
 108         <glossterm>
 109           <envar>SGML_FILE</envar>
 110         </glossterm>
 111         <glossdef>
 112           <para>The name of the file to convert.</para>
 113           <para>(This variable is valid only while determining
 114             the centralized catalog to use.)</para>
 115         </glossdef>
 116       </glossentry>
 117     </glosslist>
 118
 119     <para></para>
 120
 121     <glosslist>
 122       <glossentry>
 123         <glossterm>
 124           <envar>SGML_TYPE</envar>
 125         </glossterm>
 126         <glossdef>
 127           <para>The type of the backend to use, whether it produces output
 128             files to be displayed online or to be printed out.
 129             It can take the value <constant>html</constant> or
 130             <constant>print</constant>.</para>
 131           <para>(This variable is valid only while determining
 132             the style sheet to use).</para>
 133         </glossdef>
 134       </glossentry>
 135     </glosslist>
 136
 137     <para></para>
 138
 139     <glosslist>
 140       <glossentry>
 141         <glossterm>
 142           <envar>SGML_STYLESHEETS</envar>
 143         </glossterm>
 144         <glossdef>
 145           <para>The desired custom stylesheet type, either <constant>none</constant>
 146             or <constant>default</constant>.
 147             If <constant>none</constant>, the frontend must return the file name of
 148             the style sheet provided by the system beneath the docbook-utils.
 149             If <constant>default</constant>, the frontend must return the custom
 150             stylesheet provided by the docbook-utils.</para>
 151           <para>(This variable is valid only while determining
 152             the style sheet to use).</para>
 153         </glossdef>
 154       </glossentry>
 155     </glosslist>
 156
 157     <glosslist>
 158       <glossentry>
 159         <glossterm>
 160           <envar>SGML_XML</envar>
 161         </glossterm>
 162         <glossdef>
 163           <para>The metalanguage of the file to convert, either <constant>sgml</constant>
 164             or <constant>xml</constant>.</para>
 165           <para>(This variable is valid only while determining
 166             the centralized catalog to use).</para>
 167         </glossdef>
 168       </glossentry>
 169     </glosslist>
 170
 171   </refsect1>
 172
 173   <refsect1>
 174      <title>Files</title>
 175
 176     <para></para>
 177
 178   </refsect1>
 179
 180   <refsect1>
 181     <title>See also</title>
 182
 183     <para><citerefentry>
 184       <refentrytitle>backend-spec</refentrytitle>
 185       <manvolnum>7</manvolnum>
 186     </citerefentry></para>
 187   </refsect1>
 188
 189   <refsect1>
 190     <title>Authors</title>
 191
 192     <para>Jochem Huhmann <email>joh@revier.com</email></para>
 193
 194   </refsect1>
 195
 196 </refentry>