grim/purple-objects-docbook

created a graphs page to explain how the graphs are built and what they mean

2009-04-17, Gary Kramlich
4db72ca102ec
Parents dedc55db0d25
Children 4608408a1f6f
created a graphs page to explain how the graphs are built and what they mean
3 files changed, 54 insertions(+), 2 deletions(-)
  • +3 -2
    Makefile
  • +50 -0
    graphs.xml
  • +1 -0
    purple-objects.xml
    • --- a/Makefile Fri Apr 17 18:33:06 2009 -0500
    +++ b/Makefile Fri Apr 17 20:03:05 2009 -0500
    @@ -5,8 +5,9 @@
    BOOK=purple-objects.xml
    BOOK_SOURCES=\
    - purple-objects.xml \
    - about.xml
    + about.xml \
    + graphs.xml \
    + purple-objects.xml
    IMAGES=\
    object-key.png \
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/graphs.xml Fri Apr 17 20:03:05 2009 -0500
    @@ -0,0 +1,50 @@
    +<?xml version="1.0" encoding="utf-8"?>
    +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    +<refentry id="graphs">
    + <refmeta>
    + <refentrytitle>Graphs</refentrytitle>
    + </refmeta>
    +
    + <refsect1>
    + <title>All about the graphs</title>
    +
    + <para>
    + There are many graphs in use in this document. All of the graphs
    + are generated by the graphviz package.
    + </para>
    +
    + <refsect2>
    + <title>Object Key</title>
    +
    + <imageobject>
    + <imagedata fileref="object-key.png"/>
    + </imageobject>
    +
    + <para>
    + All object and interfaces are represented by a rectangle. The
    + color is used to describe the type of object. In the key above
    + we see that abstract classes are pale green, concrete classes
    + are light pink, and interfaces are powder blue.
    + </para>
    + </refsect2>
    +
    + <refsect2>
    + <title>Relationship Key</title>
    +
    + <imageobject>
    + <imagedata fileref="relationship-key.png"/>
    + </imageobject>
    +
    + <para>
    + Similar to the object key, the relationship key shows how
    + objects relate to one another. Subclasses, expressed here as
    + concrete classes, will point to their parent class with a solid
    + line with a solid arrow. Classes that implement interfaces
    + point to the interface they're implementing with a dotted line
    + with an open circle.
    + </para>
    + </refsect2>
    + </refsect1>
    +</refentry>
    +
    --- a/purple-objects.xml Fri Apr 17 18:33:06 2009 -0500
    +++ b/purple-objects.xml Fri Apr 17 20:03:05 2009 -0500
    @@ -7,4 +7,5 @@
    </bookinfo>
    <xi:include href="about.xml"/>
    + <xi:include href="graphs.xml"/>
    </book>