docs/adg-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                       "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY README SYSTEM "../README">
   5 <!ENTITY version SYSTEM "version.xml">
   6 ]>
   7 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   8   <bookinfo>
   9     <title>ADG Reference Manual</title>
  10     <releaseinfo>for ADG &version;</releaseinfo>
  11   </bookinfo>
  12
  13   <part id="Overview">
  14     <title>ADG Overview</title>
  15     <chapter id="Introduction">
  16       <title>Introduction</title>
  17
  18       <para>
  19       The overall description of what it is the ADG library is well reported in the
  20       README file.
  21       </para>
  22
  23       <synopsis>&README;</synopsis>
  24     </chapter>
  25     <chapter id="Compiling">
  26       <title>Compiling the ADG library</title>
  27
  28       <section id="Requirements">
  29         <title>Requirements</title>
  30         <para>
  31         The ADG library is strongly based on the GObject framework (included inside
  32         the GLib abstraction layer) and uses Cairo as rendering engine. Both the
  33         libraries are required.
  34         </para>
  35
  36         <variablelist>
  37
  38         <varlistentry>
  39         <term><ulink url="http://www.gtk.org/">GLib</ulink></term>
  40         <listitem><para>[required] 2.10.1 or later</para></listitem>
  41         </varlistentry>
  42
  43         <varlistentry>
  44         <term><ulink url="http://sourceforge.net/projects/gcontainer/">GContainer</ulink></term>
  45         <listitem><para>[required] 1.99.2 or later</para></listitem>
  46         </varlistentry>
  47
  48         <varlistentry>
  49         <term><ulink url="http://cairographics.org/">Cairo</ulink></term>
  50         <listitem><para>[required] 1.6.0 or later</para></listitem>
  51         </varlistentry>
  52
  53         <varlistentry>
  54         <term><ulink url="http://www.gtk.org/">Gtk+2</ulink></term>
  55         <listitem><para>[optional] 2.8.0 or later, in order to compile the demonstration programs</para></listitem>
  56         </varlistentry>
  57
  58         </variablelist>
  59       </section>
  60     </chapter>
  61   </part>
  62
  63   <part id="Core">
  64     <title>ADG core reference</title> <xi:include href="xml/tree_index.sgml"/> <xi:include href="xml/pair.xml"/>
  65     <xi:include href="xml/point.xml"/>
  66     <xi:include href="xml/matrix.xml"/>
  67     <xi:include href="xml/pattern.xml"/>
  68     <xi:include href="xml/enums.xml"/>
  69     <xi:include href="xml/util.xml"/>
  70     <chapter id="Hierarchy">
  71       <title>Object Hierarchy</title>
  72        <xi:include href="xml/tree_index.sgml"/>
  73     </chapter>
  74   </part>
  75
  76   <part id="Defining">
  77     <title>Defining the model</title>
  78     <xi:include href="xml/model.xml"/>
  79   </part>
  80
  81   <part id="Populating">
  82     <title>Populating the canvas</title>
  83     <chapter id="Populating-abstract">
  84       <title>Abstract base classes</title>
  85       <xi:include href="xml/entity.xml"/>
  86       <xi:include href="xml/container.xml"/>
  87       <xi:include href="xml/dim.xml"/>
  88     </chapter>
  89     <chapter id="Populating-interface">
  90       <title>Shared interfaces</title>
  91       <xi:include href="xml/positionable.xml"/>
  92       <xi:include href="xml/rotable.xml"/>
  93     </chapter>
  94     <xi:include href="xml/canvas.xml"/>
  95     <xi:include href="xml/toytext.xml"/>
  96     <xi:include href="xml/path.xml"/>
  97     <chapter id="Quoting">
  98       <title>Quoting</title>
  99       <xi:include href="xml/ldim.xml"/>
 100       <xi:include href="xml/adim.xml"/>
 101     </chapter>
 102   </part>
 103
 104   <part id="Rendering">
 105     <title>The rendering process</title>
 106     <chapter id="Rendering-abstract">
 107       <title>Abstract base classes</title>
 108       <xi:include href="xml/style.xml"/>
 109     </chapter>
 110     <xi:include href="xml/context.xml"/>
 111     <xi:include href="xml/line-style.xml"/>
 112     <xi:include href="xml/arrow-style.xml"/>
 113     <xi:include href="xml/font-style.xml"/>
 114     <xi:include href="xml/dim-style.xml"/>
 115   </part>
 116
 117   <index id="Index">
 118     <title>Index</title>
 119   </index>
 120
 121 </book>