From ae0695b00a7fb1455613d4c8e8c1ccb7a2262488 Mon Sep 17 00:00:00 2001
From: David King <david.king@canonical.com>
Date: Thu, 18 Oct 2012 10:55:35 +0100
Subject: [PATCH] Improve reference documentation main page

---
 .gitignore                             |  2 +-
 configure.ac                           |  1 +
 docs/reference/libsignon-glib-docs.xml | 81 ++++++++++++++++----------
 docs/reference/version.xml.in          |  1 +
 4 files changed, 52 insertions(+), 33 deletions(-)
 create mode 100644 docs/reference/version.xml.in

diff --git a/.gitignore b/.gitignore
index 1c65885..95a98ed 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,7 +11,7 @@ debian
 /docs/reference/html/
 /docs/reference/libsignon-glib*
 !/docs/reference/libsignon-glib-sections.txt
-/docs/reference/tmpl/
+/docs/reference/version.xml
 /docs/reference/xml/
 gtk-doc.make
 /INSTALL
diff --git a/configure.ac b/configure.ac
index 7dca4ac..af5e663 100644
--- a/configure.ac
+++ b/configure.ac
@@ -84,6 +84,7 @@ AC_CONFIG_FILES([
 	libsignon-glib.pc
 	docs/Makefile
 	docs/reference/Makefile
+	docs/reference/version.xml
 	tests/Makefile
 	pygobject/Makefile
 ])
diff --git a/docs/reference/libsignon-glib-docs.xml b/docs/reference/libsignon-glib-docs.xml
index 1dcd206..4521f38 100644
--- a/docs/reference/libsignon-glib-docs.xml
+++ b/docs/reference/libsignon-glib-docs.xml
@@ -1,42 +1,59 @@
 <?xml version="1.0"?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
-               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
+               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
+<!ENTITY version SYSTEM "version.xml">
+]>
+
 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
     <title>libsignon-glib Reference Manual</title>
     <releaseinfo>
-      The latest version of this documentation can be built from the source code
-      at <ulink role="online-location" url="https://code.google.com/p/accounts-sso/source/checkout?repo=libsignon-glib">https://code.google.com/p/accounts-sso/source/checkout?repo=libsignon-glib</ulink>.
+      This document is for libsignon-glib, version &version;. The latest
+      version of this documentation can be built from the source code at
+      <ulink role="online-location" url="https://code.google.com/p/accounts-sso/source/checkout?repo=libsignon-glib">https://code.google.com/p/accounts-sso/source/checkout?repo=libsignon-glib</ulink>.
     </releaseinfo>
   </bookinfo>
 
-  <chapter id="libsignon-glib">
-    <title>libsignon-glib</title>
-    <para>
-    libsignon-glib provides authorization and authentication management for GLib
-    applications.
-    </para>
-    <xi:include href="xml/signon-auth-service.xml"/>
-    <xi:include href="xml/signon-auth-session.xml"/>
-    <xi:include href="xml/signon-errors.xml"/>
-    <xi:include href="xml/signon-identity.xml"/>
-    <xi:include href="xml/signon-identity-info.xml"/>
-  </chapter>
-
-  <chapter id="object-tree">
-    <title>Object Hierarchy</title>
-    <xi:include href="xml/tree_index.sgml"/>
-  </chapter>
-
-  <index id="api-index-full">
-    <title>API Index</title>
-    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <index id="api-index-deprecated" role="deprecated">
-    <title>Index of deprecated symbols</title>
-    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
-  </index>
-
-  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+  <part id="libsignon-glib-overview">
+    <title>libsignon-glib Overview</title>
+
+    <partintro>
+      <para>
+      libsignon-glib provides authorization and authentication management for
+      GLib applications.
+      </para>
+    </partintro>
+  </part>
+
+  <part id="libsignon-glib-objects">
+    <title>libsignon-glib Objects</title>
+
+    <chapter id="object-tree">
+      <title>Object Hierarchy</title>
+      <xi:include href="xml/tree_index.sgml"/>
+    </chapter>
+    <chapter id="credential-management">
+      <title>Credential management</title>
+      <xi:include href="xml/signon-auth-service.xml"/>
+      <xi:include href="xml/signon-auth-session.xml"/>
+      <xi:include href="xml/signon-errors.xml"/>
+      <xi:include href="xml/signon-identity.xml"/>
+      <xi:include href="xml/signon-identity-info.xml"/>
+    </chapter>
+  </part>
+
+  <part id="appendices">
+    <title>Appendices</title>
+    <index id="api-index-full">
+      <title>API Index</title>
+      <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
+    </index>
+
+    <index id="api-index-deprecated" role="deprecated">
+      <title>Index of deprecated symbols</title>
+      <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
+    </index>
+
+    <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+  </part>
 </book>
diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in
new file mode 100644
index 0000000..a24f987
--- /dev/null
+++ b/docs/reference/version.xml.in
@@ -0,0 +1 @@
+@PACKAGE_VERSION@
-- 
2.34.1