From 91c2a0aadfbe5bf0ec7b1f9cfecc7131a62a6fb0 Mon Sep 17 00:00:00 2001
From: Pierre Pronchery <khorben@defora.org>
Date: Thu, 13 Feb 2020 09:33:43 +0100
Subject: [PATCH] Use config.ent for the Gtk-Doc documentation

---
 doc/gtkdoc/libApp-docs.xml        | 28 ++++++++++------
 doc/gtkdoc/libApp-sections.txt    | 56 +++++++++++++++++++++++++++++++
 doc/gtkdoc/project.conf           |  2 +-
 doc/gtkdoc/xml/gtkdocentities.ent |  2 ++
 doc/project.conf                  | 22 ++++++------
 project.conf                      |  4 +--
 6 files changed, 91 insertions(+), 23 deletions(-)
 create mode 100644 doc/gtkdoc/libApp-sections.txt
 create mode 100644 doc/gtkdoc/xml/gtkdocentities.ent

diff --git a/doc/gtkdoc/libApp-docs.xml b/doc/gtkdoc/libApp-docs.xml
index 68ac82a..d87004a 100644
--- a/doc/gtkdoc/libApp-docs.xml
+++ b/doc/gtkdoc/libApp-docs.xml
@@ -3,28 +3,35 @@
                "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
 [
   <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
-  <!ENTITY server "www.defora.org/doc/gtk-doc/html">
-  <!ENTITY title "DeforaOS libApp">
-  <!ENTITY version "0.1.5">
+  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+  %gtkdocentities;
+  <!ENTITY % configentities SYSTEM "config.ent">
+  %configentities;
 ]>
-<book id="index">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
-    <title>libApp Reference Manual</title>
+    <title>&vendor; &package; &title;</title>
     <releaseinfo>
-      for libApp &version;.
+      for &vendor; &package; &version;.
       The latest version of this documentation can be found on-line at
-      <ulink role="online-location" url="http://&server;/libApp/index.html">http://&server;/libApp/</ulink>.
+      <ulink role="online-location" url="https://&server;/&package;/">https://&server;/&package;/</ulink>.
     </releaseinfo>
   </bookinfo>
 
   <chapter>
-    <title>&title;</title>
+    <title>&vendor; &package;</title>
+    <xi:include href="xml/app.xml"/>
     <xi:include href="xml/appclient.xml"/>
     <xi:include href="xml/appmessage.xml"/>
     <xi:include href="xml/appserver.xml"/>
     <xi:include href="xml/apptransport.xml"/>
-
   </chapter>
+  <!-- enable this when you use gobject types
+  <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>
@@ -33,6 +40,7 @@
     <title>Index of deprecated API</title>
     <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
   </index>
-
+  <!-- enable this when you use gobject introspection annotations
   <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+  -->
 </book>
diff --git a/doc/gtkdoc/libApp-sections.txt b/doc/gtkdoc/libApp-sections.txt
new file mode 100644
index 0000000..773d909
--- /dev/null
+++ b/doc/gtkdoc/libApp-sections.txt
@@ -0,0 +1,56 @@
+<SECTION>
+<FILE>App</FILE>
+
+</SECTION>
+
+<SECTION>
+<FILE>app</FILE>
+AppMessage
+</SECTION>
+
+<SECTION>
+<FILE>appclient</FILE>
+AppClient
+appclient_call
+appclient_delete
+appclient_new
+appclient_new_event
+</SECTION>
+
+<SECTION>
+<FILE>appmessage</FILE>
+AppMessageType
+appmessage_delete
+appmessage_get_method
+appmessage_get_type
+appmessage_new_call
+appmessage_new_deserialize
+appmessage_serialize
+</SECTION>
+
+<SECTION>
+<FILE>appserver</FILE>
+APPSERVER_MAX_ARGUMENTS
+AppServer
+AppServerOptions
+appserver_delete
+appserver_get_client_id
+appserver_loop
+appserver_new
+appserver_new_event
+</SECTION>
+
+<SECTION>
+<FILE>apptransport</FILE>
+AppTransport
+AppTransportClient
+AppTransportMode
+AppTransportPlugin
+AppTransportPluginDefinition
+AppTransportStatus
+client_delete
+client_new
+client_receive
+status
+</SECTION>
+
diff --git a/doc/gtkdoc/project.conf b/doc/gtkdoc/project.conf
index 657bffc..edbcd0f 100644
--- a/doc/gtkdoc/project.conf
+++ b/doc/gtkdoc/project.conf
@@ -1 +1 @@
-dist=Makefile,libApp-docs.xml
+dist=Makefile,libApp-docs.xml,libApp-sections.txt,xml/gtkdocentities.ent
diff --git a/doc/gtkdoc/xml/gtkdocentities.ent b/doc/gtkdoc/xml/gtkdocentities.ent
new file mode 100644
index 0000000..db0b85f
--- /dev/null
+++ b/doc/gtkdoc/xml/gtkdocentities.ent
@@ -0,0 +1,2 @@
+<!ENTITY server "www.defora.org/doc/gtk-doc/html">
+<!ENTITY title "Reference Manual">
diff --git a/doc/project.conf b/doc/project.conf
index 261f350..4262d16 100644
--- a/doc/project.conf
+++ b/doc/project.conf
@@ -1,7 +1,8 @@
 subdirs=gtkdoc
-targets=AppBroker.1,AppBroker.html,AppClient.1,AppClient.html,gtkdoc/libApp.types,gtkdoc/tmpl.stamp,gtkdoc/sgml.stamp,gtkdoc/html.stamp
+targets=AppBroker.1,AppBroker.html,AppClient.1,AppClient.html,gtkdoc/html.stamp,gtkdoc/libApp.types,gtkdoc/tmpl.stamp,gtkdoc/xml.stamp
 dist=Makefile,AppBroker.css.xml,AppBroker.xml,AppClient.css.xml,AppClient.xml,docbook.sh,gtkdoc.sh,manual.css.xml
 
+#targets
 [AppBroker.1]
 type=script
 script=./docbook.sh
@@ -26,22 +27,23 @@ script=./docbook.sh
 depends=AppClient.css.xml,AppClient.xml,manual.css.xml
 #install=
 
+[gtkdoc/html.stamp]
+type=script
+script=./gtkdoc.sh
+depends=gtkdoc.sh,gtkdoc/libApp-docs.xml,$(OBJDIR)gtkdoc/xml.stamp,gtkdoc/xml/gtkdocentities.ent,../config.ent
+install=
+
 [gtkdoc/libApp.types]
 type=script
 script=./gtkdoc.sh
+depends=gtkdoc.sh
 
 [gtkdoc/tmpl.stamp]
 type=script
 script=./gtkdoc.sh
-depends=$(OBJDIR)gtkdoc/libApp.types
+depends=gtkdoc.sh,$(OBJDIR)gtkdoc/libApp.types
 
-[gtkdoc/sgml.stamp]
+[gtkdoc/xml.stamp]
 type=script
 script=./gtkdoc.sh
-depends=$(OBJDIR)gtkdoc/tmpl.stamp
-
-[gtkdoc/html.stamp]
-type=script
-script=./gtkdoc.sh
-depends=gtkdoc/libApp-docs.xml,$(OBJDIR)gtkdoc/sgml.stamp,$(OBJDIR)gtkdoc/tmpl.stamp
-install=
+depends=gtkdoc.sh,$(OBJDIR)gtkdoc/tmpl.stamp
diff --git a/project.conf b/project.conf
index 11f2c92..e611cbc 100644
--- a/project.conf
+++ b/project.conf
@@ -1,7 +1,7 @@
 package=libApp
 version=0.3.2
-config=h,sh
-dist=Makefile,COPYING,README.md,config.h,config.sh
+config=ent,h,sh
+dist=Makefile,COPYING,README.md,config.ent,config.h,config.sh
 
 subdirs=data,doc,include,src,src/transport,tools,tests
 targets=tests