Docs/manual.xml

   1 <!DOCTYPE article PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.1//EN" "docbook-simple/sdocbook.dtd"
   2 [
   3 <!ENTITY bugs            SYSTEM "bugs.xml">
   4 <!ENTITY configuration   SYSTEM "configuration.xml">
   5 <!ENTITY header_examples SYSTEM "header_examples.xml">
   6 <!ENTITY examples        SYSTEM "examples.xml">
   7 <!ENTITY extracting      SYSTEM "extracting.xml">
   8 <!ENTITY installing      SYSTEM "installing.xml">
   9 <!ENTITY options         SYSTEM "options.xml">
  10 <!ENTITY preface         SYSTEM "preface.xml">
  11 <!ENTITY preparing       SYSTEM "preparing.xml">
  12 <!ENTITY tips            SYSTEM "tips.xml">
  13 ] >
  14
  15 <!-- $Id: manual.xml,v 1.63 2007/07/10 19:13:51 gumpu Exp $ -->
  16
  17 <article lang="en">
  18
  19 <articleinfo>
  20     <title>ROBODoc 4.99.36 User Manual</title>
  21     <authorgroup>
  22         <author>
  23             <firstname>Frans</firstname>
  24             <surname>Slothouber</surname>
  25         </author>
  26         <author>
  27             <firstname>Petteri</firstname>
  28             <surname>Kettunen</surname>
  29         </author>
  30         <author>
  31             <firstname>Gergely</firstname>
  32             <surname>Budai</surname>
  33         </author>
  34     </authorgroup>
  35     <edition>Users Guide $Revision: 1.63 $</edition>
  36     <pubdate>Apr 2007</pubdate>
  37     <copyright>
  38         <year>1994-2007</year>
  39         <holder>
  40           Frans Slothouber, Petteri Kettunen,
  41           Jacco van Weert, Gergely Budai
  42         </holder>
  43     </copyright>
  44 </articleinfo>
  45
  46 &preface;
  47 <!-- ========== I N S T A L L I N G  ======= -->
  48 &installing;
  49 <!-- ========== P R E P A R I N G ======= -->
  50 &preparing;
  51 <!-- ========== E X T R A C T I N G ======= -->
  52 &extracting;
  53 <!-- ========== E X A M P L E S  =========== -->
  54 &examples;
  55 <!-- ========== O P T I O N S ======= -->
  56 &options;
  57 <!-- ========== C O N F I G U R A T I O N -->
  58 &configuration;
  59 <!-- ========== T I P S  =========== -->
  60 &tips;
  61 <!-- ========== H I S T O R Y  =========== -->
  62 <!-- TODO -->
  63 <!-- ========== A P P E N D I X =============-->
  64 <section id="defaultheaders">
  65     <title id="defaultheaders.title">Languages Supported by Default</title>
  66     <para>
  67         ROBODoc support a whole range of languages by default.
  68         These languages are listed in the following sections.
  69         For each language two example headers are shown.
  70         One example header without any source items and
  71         one example header with source items.
  72     </para>
  73
  74     <para> Any of these markers can be mixed, and they are not limited
  75     to the languages listed.  So if you have a language that is not
  76     listed but that has remarks that start with a <literal>#</literal>
  77     you can use the Tcl markers, and create headers such as:
  78     </para>
  79
  80 <programlisting>
  81 #****f* Foo/Bar
  82 # FUNCTION
  83 #   Bar snarfs the Foo input and mangles it.  Given the right settings
  84 #   it might also do a bit of snu snu.
  85 #***
  86 </programlisting>
  87
  88     <para>
  89         In addition for each language the corresponding entries in
  90         the <filename>robodoc.rc</filename> are shown.
  91         You do not need these, as ROBODoc has these entries
  92         built-in.  They are shown to make it easier
  93         to determine what needs to be specified for languages
  94         that ROBODoc does not yet support.
  95     </para>
  96
  97     <para>
  98         You can also use these entries if you want to create
  99         a <filename>robodoc.rc</filename> that supports only a limited
 100         number of languages.
 101         This because if you specify your own markers, ROBODoc
 102         ignores any of the in-built markers.
 103     </para>
 104     &header_examples;
 105 </section>
 106
 107 &bugs;
 108
 109 </article>
 110