grim/purple-objects-docbook

Changed from refsect's to chapters. This makes our TOC be number and so on.

2009-04-30, Gary Kramlich
2e8c3e6bb219
Parents 731c0c25b85a
Children 457f4ea1a35f
Changed from refsect's to chapters. This makes our TOC be number and so on.
Added a revision history as a separate page
Other misc changes
18 files changed, 184 insertions(+), 243 deletions(-)
  • +1 -0
    Makefile
  • +7 -15
    sheets/devtodo.xsl
  • +4 -0
    sheets/purple-objects.xsl
  • +19 -25
    xml/about.xml
  • +7 -13
    xml/accounts.xml
  • +7 -13
    xml/ciphers.xml
  • +7 -13
    xml/connections.xml
  • +10 -16
    xml/conversations.xml
  • +7 -13
    xml/filetransfers.xml
  • +35 -41
    xml/graphs.xml
  • +10 -16
    xml/plugin-loaders.xml
  • +16 -22
    xml/plugins.xml
  • +7 -13
    xml/pounces.xml
  • +7 -13
    xml/proxies.xml
  • +2 -0
    xml/purple-objects.xml
  • +19 -0
    xml/revhistory.xml
  • +12 -17
    xml/todo.xml
  • +7 -13
    xml/whiteboards.xml
    • --- a/Makefile Thu Apr 30 00:35:38 2009 -0500
    +++ b/Makefile Thu Apr 30 02:09:25 2009 -0500
    @@ -21,6 +21,7 @@
    xml/plugin-loaders.xml \
    xml/pounces.xml \
    xml/purple-objects.xml \
    + xml/revhistory.xml \
    xml/whiteboards.xml
    BOOK_BUILT_SOURCES=\
    --- a/sheets/devtodo.xsl Thu Apr 30 00:35:38 2009 -0500
    +++ b/sheets/devtodo.xsl Thu Apr 30 02:09:25 2009 -0500
    @@ -35,25 +35,17 @@
    <!-- main template -->
    <xsl:template match="todo">
    - <xsl:element name="refentry">
    + <xsl:element name="chapter">
    <xsl:attribute name="id">todo</xsl:attribute>
    - <xsl:element name="refmeta">
    - <xsl:element name="refentrytitle">
    - <xsl:text>Todo</xsl:text>
    - </xsl:element>
    + <xsl:element name="title">
    + <xsl:text>TODO List</xsl:text>
    </xsl:element>
    - <xsl:element name="refsect1">
    - <xsl:element name="title">
    - <xsl:text>TODO List</xsl:text>
    - </xsl:element>
    -
    - <xsl:element name="variablelist">
    - <xsl:for-each select="note">
    - <xsl:call-template name="note"/>
    - </xsl:for-each>
    - </xsl:element>
    + <xsl:element name="variablelist">
    + <xsl:for-each select="note">
    + <xsl:call-template name="note"/>
    + </xsl:for-each>
    </xsl:element>
    </xsl:element>
    </xsl:template>
    --- a/sheets/purple-objects.xsl Thu Apr 30 00:35:38 2009 -0500
    +++ b/sheets/purple-objects.xsl Thu Apr 30 02:09:25 2009 -0500
    @@ -11,4 +11,8 @@
    <xsl:param name="refentry.generate.name" select="0"/>
    <xsl:param name="refentry.generate.title" select="1"/>
    <xsl:param name="use.id.as.filename" select="1"/>
    + <xsl:param name="id.warnings" select="1"/>
    + <xsl:param name="annotate.toc" select="1"/>
    + <xsl:param name="toc.max.depth" select="1"/>
    + <xsl:param name="generate.revhistory.link" select="1"/>
    </xsl:stylesheet>
    --- a/xml/about.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/about.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,30 +1,24 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="about">
    - <refmeta>
    - <refentrytitle>About</refentrytitle>
    - </refmeta>
    +<chapter id="about">
    + <title>Why use GObjects in libpurple?</title>
    - <refsect1>
    - <title>Why use GObjects in libpurple?</title>
    + <para>
    + There are many benefits GObjects can bring to purple. Some of
    + which we have implemented ourselves already and others that we've
    + considered adding in the past but no one has gotten to yet.
    + </para>
    - <para>
    - There are many benefits GObjects can bring to purple. Some of
    - which we have implemented ourselves already and others that we've
    - considered adding in the past but no one has gotten to yet.
    - </para>
    + <para>
    + One of the biggest benefits is the type system. While it's a bit
    + more work to start up a GObject class, the benefit of using a
    + tested type system makes it worth it. Right now we're only lightly
    + using inheritance. For example: PurpleBlistNode is the base class
    + for PurpleBuddy, PurpleChat, PurpleContact, and PurpleGroup. There
    + are quite a few problems with the current setup. It's error prone,
    + theres no type checking, and it's impossible to subclass unless
    + the new "type" is added to libpurple itself.
    + </para>
    +</chapter>
    - <para>
    - One of the biggest benefits is the type system. While it's a bit
    - more work to start up a GObject class, the benefit of using a
    - tested type system makes it worth it. Right now we're only lightly
    - using inheritance. For example: PurpleBlistNode is the base class
    - for PurpleBuddy, PurpleChat, PurpleContact, and PurpleGroup. There
    - are quite a few problems with the current setup. It's error prone,
    - theres no type checking, and it's impossible to subclass unless
    - the new "type" is added to libpurple itself.
    - </para>
    - </refsect1>
    -</refentry>
    -
    --- a/xml/accounts.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/accounts.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,17 +1,11 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="accounts">
    - <refmeta>
    - <refentrytitle>Accounts</refentrytitle>
    - </refmeta>
    +<chapter id="accounts">
    + <title>Accounts</title>
    - <refsect1>
    - <title>Accounts</title>
    + <imageobject>
    + <imagedata fileref="graphs/accounts.png"/>
    + </imageobject>
    +</chapter>
    - <imageobject>
    - <imagedata fileref="graphs/accounts.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    -
    --- a/xml/ciphers.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/ciphers.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,17 +1,11 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="ciphers">
    - <refmeta>
    - <refentrytitle>Ciphers</refentrytitle>
    - </refmeta>
    +<chapter id="ciphers">
    + <title>Ciphers</title>
    - <refsect1>
    - <title>Ciphers</title>
    + <imageobject>
    + <imagedata fileref="graphs/ciphers.png"/>
    + </imageobject>
    +</chapter>
    - <imageobject>
    - <imagedata fileref="graphs/ciphers.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    -
    --- a/xml/connections.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/connections.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,17 +1,11 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="connections">
    - <refmeta>
    - <refentrytitle>Connections</refentrytitle>
    - </refmeta>
    +<chapter id="connections">
    + <title>Connections</title>
    - <refsect1>
    - <title>Connections</title>
    + <imageobject>
    + <imagedata fileref="graphs/connections.png"/>
    + </imageobject>
    +</chapter>
    - <imageobject>
    - <imagedata fileref="graphs/connections.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    -
    --- a/xml/conversations.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/conversations.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,21 +1,15 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="conversations">
    - <refmeta>
    - <refentrytitle>Conversations</refentrytitle>
    - </refmeta>
    -
    - <refsect1>
    - <title>Conversations</title>
    +<chapter id="conversations">
    + <title>Conversations</title>
    - <imageobject>
    - <imagedata fileref="graphs/conversations-objects.png"/>
    - </imageobject>
    + <imageobject>
    + <imagedata fileref="graphs/conversations-objects.png"/>
    + </imageobject>
    - <imageobject>
    - <imagedata fileref="graphs/conversations-interfaces.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    + <imageobject>
    + <imagedata fileref="graphs/conversations-interfaces.png"/>
    + </imageobject>
    +</chapter>
    --- a/xml/filetransfers.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/filetransfers.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,17 +1,11 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="filetransfers">
    - <refmeta>
    - <refentrytitle>File Transfers</refentrytitle>
    - </refmeta>
    +<chapter id="filetransfers">
    + <title>File Transfers</title>
    - <refsect1>
    - <title>File Transfers</title>
    + <imageobject>
    + <imagedata fileref="graphs/filetransfers.png"/>
    + </imageobject>
    +</chapter>
    - <imageobject>
    - <imagedata fileref="graphs/filetransfers.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    -
    --- a/xml/graphs.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/graphs.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,51 +1,45 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter 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>
    +<chapter id="graphs">
    + <title>All about the graphs</title>
    - <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>
    +
    + <sect1>
    + <title>Object Key</title>
    +
    + <imageobject>
    + <imagedata fileref="graphs/objects.png"/>
    + </imageobject>
    <para>
    - There are many graphs in use in this document. All of the graphs
    - are generated by the graphviz package.
    + 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>
    - <title>Object Key</title>
    + </sect1>
    - <imageobject>
    - <imagedata fileref="graphs/objects.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>
    + <sect1>
    + <title>Relationship Key</title>
    - <refsect2>
    - <title>Relationship Key</title>
    -
    - <imageobject>
    - <imagedata fileref="graphs/relationships.png"/>
    - </imageobject>
    + <imageobject>
    + <imagedata fileref="graphs/relationships.png"/>
    + </imageobject>
    - <para>
    - Similar to the object key, the relationship key shows how
    - objects relate to one another. Subclasses point to their
    - parent class with a solid line with an open arrow. Classes
    - that implement interfaces point to the interface they're
    - implementing with a dotted line with an open circle. Classes
    - that have an instance of another class, are pointed to by that
    - class with an open diamond.
    - </para>
    - </refsect2>
    - </refsect1>
    -</refentry>
    + <para>
    + Similar to the object key, the relationship key shows how
    + objects relate to one another. Subclasses point to their
    + parent class with a solid line with an open arrow. Classes
    + that implement interfaces point to the interface they're
    + implementing with a dotted line with an open circle. Classes
    + that have an instance of another class, are pointed to by that
    + class with an open diamond.
    + </para>
    + </sect1>
    +</chapter>
    --- a/xml/plugin-loaders.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/plugin-loaders.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,21 +1,15 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="plugin-loaders">
    - <refmeta>
    - <refentrytitle>Plugin Loaders</refentrytitle>
    - </refmeta>
    -
    - <refsect1>
    - <title>Plugin Loaders</title>
    +<chapter id="plugin-loaders">
    + <title>Plugin Loaders</title>
    - <imageobject>
    - <imagedata fileref="graphs/plugin-loaders.png"/>
    - </imageobject>
    + <imageobject>
    + <imagedata fileref="graphs/plugin-loaders.png"/>
    + </imageobject>
    - <imageobject>
    - <imagedata fileref="graphs/plugin-loader.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    + <imageobject>
    + <imagedata fileref="graphs/plugin-loader.png"/>
    + </imageobject>
    +</chapter>
    --- a/xml/plugins.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/plugins.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,29 +1,23 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="plugins">
    - <refmeta>
    - <refentrytitle>Plugins</refentrytitle>
    - </refmeta>
    +<chapter id="plugins">
    + <title>Plugins</title>
    - <refsect1>
    - <title>Plugins</title>
    -
    - <imageobject>
    - <imagedata fileref="graphs/plugins.png"/>
    - </imageobject>
    + <imageobject>
    + <imagedata fileref="graphs/plugins.png"/>
    + </imageobject>
    - <imageobject>
    - <imagedata fileref="graphs/plugin.png"/>
    - </imageobject>
    + <imageobject>
    + <imagedata fileref="graphs/plugin.png"/>
    + </imageobject>
    - <imageobject>
    - <imagedata fileref="graphs/plugin-info.png"/>
    - </imageobject>
    + <imageobject>
    + <imagedata fileref="graphs/plugin-info.png"/>
    + </imageobject>
    - <imageobject>
    - <imagedata fileref="graphs/plugin-state.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    + <imageobject>
    + <imagedata fileref="graphs/plugin-state.png"/>
    + </imageobject>
    +</chapter>
    --- a/xml/pounces.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/pounces.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,17 +1,11 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="pounces">
    - <refmeta>
    - <refentrytitle>Pounces</refentrytitle>
    - </refmeta>
    + <chapter id="pounces">
    + <title>Pounces</title>
    - <refsect1>
    - <title>Pounces</title>
    + <imageobject>
    + <imagedata fileref="graphs/pounces.png"/>
    + </imageobject>
    +</chapter>
    - <imageobject>
    - <imagedata fileref="graphs/pounces.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    -
    --- a/xml/proxies.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/proxies.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,17 +1,11 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="proxies">
    - <refmeta>
    - <refentrytitle>Proxies</refentrytitle>
    - </refmeta>
    +<chapter id="proxies">
    + <title>Proxies</title>
    - <refsect1>
    - <title>Proxies</title>
    + <imageobject>
    + <imagedata fileref="graphs/proxies.png"/>
    + </imageobject>
    +</chapter>
    - <imageobject>
    - <imagedata fileref="graphs/proxies.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    -
    --- a/xml/purple-objects.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/purple-objects.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -19,4 +19,6 @@
    <xi:include href="connections.xml"/>
    <xi:include href="filetransfers.xml"/>
    <xi:include href="pounces.xml"/>
    +
    + <xi:include href="revhistory.xml"/>
    </book>
    --- /dev/null Thu Jan 01 00:00:00 1970 +0000
    +++ b/xml/revhistory.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -0,0 +1,19 @@
    +<?xml version="1.0" encoding="utf-8"?>
    +<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    + "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    +<appendix id="revhistory">
    + <title>Revision History</title>
    +
    + <revhistory>
    + <revision>
    + <date>TBD</date>
    + <revnumber>0.1</revnumber>
    + <revremark>
    + Initial revision, basic overview, no input from any other
    + parties.
    + </revremark>
    + <authorinitials>GK</authorinitials>
    + </revision>
    + </revhistory>
    +</appendix>
    +
    --- a/xml/todo.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/todo.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,22 +1,17 @@
    <?xml version="1.0"?>
    -<!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="todo">
    - <refmeta>
    - <refentrytitle>Todo</refentrytitle>
    - </refmeta>
    - <refsect1>
    - <title>TODO List</title>
    - <variablelist>
    - <varlistentry>
    - <term class="veryhigh">
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    +<chapter id="todo">
    + <title>TODO List</title>
    + <variablelist>
    + <varlistentry>
    + <term class="veryhigh">
    Dump devtodo output into the book as well
    </term>
    - </varlistentry>
    - <varlistentry>
    - <term class="high">
    + </varlistentry>
    + <varlistentry>
    + <term class="high">
    Create conversation graphs
    </term>
    - </varlistentry>
    - </variablelist>
    - </refsect1>
    -</refentry>
    + </varlistentry>
    + </variablelist>
    +</chapter>
    --- a/xml/whiteboards.xml Thu Apr 30 00:35:38 2009 -0500
    +++ b/xml/whiteboards.xml Thu Apr 30 02:09:25 2009 -0500
    @@ -1,17 +1,11 @@
    <?xml version="1.0" encoding="utf-8"?>
    -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
    -<refentry id="whiteboards">
    - <refmeta>
    - <refentrytitle>Whiteboards</refentrytitle>
    - </refmeta>
    +<chapter id="whiteboards">
    + <title>Whiteboards</title>
    - <refsect1>
    - <title>Whiteboards</title>
    + <imageobject>
    + <imagedata fileref="graphs/whiteboards.png"/>
    + </imageobject>
    +</chapter>
    - <imageobject>
    - <imagedata fileref="graphs/whiteboards.png"/>
    - </imageobject>
    - </refsect1>
    -</refentry>
    -