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>
  65     <xi:include href="xml/tree_index.sgml"/>
  66     <xi:include href="xml/pair.xml"/>
  67     <xi:include href="xml/point.xml"/>
  68     <xi:include href="xml/matrix.xml"/>
  69     <xi:include href="xml/pattern.xml"/>
  70     <xi:include href="xml/enums.xml"/>
  71     <xi:include href="xml/util.xml"/>
  72     <chapter id="Hierarchy">
  73       <title>Object Hierarchy</title>
  74        <xi:include href="xml/tree_index.sgml"/>
  75     </chapter>
  76   </part>
  77
  78   <part id="Defining">
  79     <title>Defining the model</title>
  80     <xi:include href="xml/model.xml"/>
  81   </part>
  82
  83   <part id="Populating">
  84     <title>Populating the canvas</title>
  85     <chapter id="Populating-abstract">
  86       <title>Abstract base classes</title>
  87       <xi:include href="xml/entity.xml"/>
  88       <xi:include href="xml/container.xml"/>
  89       <xi:include href="xml/dim.xml"/>
  90     </chapter>
  91     <chapter id="Populating-interface">
  92       <title>Shared interfaces</title>
  93       <xi:include href="xml/positionable.xml"/>
  94     </chapter>
  95     <xi:include href="xml/canvas.xml"/>
  96     <xi:include href="xml/toytext.xml"/>
  97     <xi:include href="xml/path.xml"/>
  98     <chapter id="Quoting">
  99       <title>Quoting</title>
 100       <xi:include href="xml/ldim.xml"/>
 101       <xi:include href="xml/adim.xml"/>
 102     </chapter>
 103   </part>
 104
 105   <part id="Rendering">
 106     <title>The rendering process</title>
 107     <chapter id="Rendering-abstract">
 108       <title>Abstract base classes</title>
 109       <xi:include href="xml/style.xml"/>
 110     </chapter>
 111     <xi:include href="xml/context.xml"/>
 112     <xi:include href="xml/line-style.xml"/>
 113     <xi:include href="xml/arrow-style.xml"/>
 114     <xi:include href="xml/font-style.xml"/>
 115     <xi:include href="xml/xatch-style.xml"/>
 116     <xi:include href="xml/dim-style.xml"/>
 117   </part>
 118
 119   <index id="Index">
 120     <title>Index</title>
 121   </index>
 122
 123 </book>