Revamp the documentation to modernize and uniformize accross components

11 files changed, 39 insertions, 121 deletions

diff --git a/Makefile.am b/Makefile.am
index 4f11a21..596b90a 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -44,8 +44,6 @@ DISTCLEANFILES =							\
 	intltool-update
 
 DISTCHECK_CONFIGURE_FLAGS =						\
-	--enable-gtk-doc						\
-	--enable-gen-doc						\
-	--with-gio-module-dir=distcheck
+	--enable-gtk-doc
 
 # vi:set ts=8 sw=8 noet ai nocindent:
diff --git a/configure.ac.in b/configure.ac.in
index 0483c8f..56797ee 100644
--- a/configure.ac.in
+++ b/configure.ac.in
@@ -182,7 +182,7 @@ XDT_CHECK_LIBX11_REQUIRE()
 dnl *************************
 dnl *** Check for gtk-doc ***
 dnl *************************
-GTK_DOC_CHECK([1.9])
+GTK_DOC_CHECK([1.20])
 
 dnl ***********************************
 dnl *** Check for debugging support ***
@@ -237,7 +237,7 @@ AC_OUTPUT([
 Makefile
 docs/Makefile
 docs/reference/Makefile
-docs/reference/version.xml
+docs/man/Makefile
 exo/Makefile
 exo/exo-2.pc
 exo/exo-config.h
diff --git a/docs/Makefile.am b/docs/Makefile.am
index 95a2f7e..8a0ac97 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -1,5 +1,6 @@
 
 SUBDIRS =								\
-	reference
+	reference \
+	man
 
 # vi:set ts=8 sw=8 noet ai nocindent:
diff --git a/docs/man/Makefile.am b/docs/man/Makefile.am
new file mode 100644
index 0000000..862d99e
--- /dev/null
+++ b/docs/man/Makefile.am
@@ -0,0 +1,10 @@
+# Other files to distribute
+EXTRA_DIST = exo-open.1
+
+# manual pages
+man_MANS = exo-open.1
+
+if MAINTAINER_MODE
+%.1: %.xml
+	xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
+endif
diff --git a/docs/reference/exo-open.xml b/docs/man/exo-open.xml
index 8f38909..8f38909 100644
--- a/docs/reference/exo-open.xml
+++ b/docs/man/exo-open.xml
diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am
index 4d522c9..c1b0c35 100644
--- a/docs/reference/Makefile.am
+++ b/docs/reference/Makefile.am
@@ -13,17 +13,17 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 SCAN_OPTIONS=--deprecated-guards="EXO_DISABLE_DEPRECATED"
 
 # The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR=../..
+DOC_SOURCE_DIR=$(top_srcdir)
 
 # Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--output-format=xml --sgml-mode --name-space=exo
+MKDB_OPTIONS=--output-format=xml --xml-mode
 
 # Extra options to supply to gtkdoc-fixref
 FIXXREF_OPTIONS=
 
 # Used for dependencies
-HFILE_GLOB=$(top_srcdir)/exo/*.h
-CFILE_GLOB=$(top_srcdir)/exo/*.c
+HFILE_GLOB=
+CFILE_GLOB=
 
 # Header files to ignore when scanning
 IGNORE_HFILES=
@@ -32,14 +32,10 @@ IGNORE_HFILES=
 EXTRA_HFILES=
 
 # Images to copy into HTML directory
-HTML_IMAGES =								\
-	$(srcdir)/images/exo-gtk-file-chooser-add-thumbnail-preview.png	\
-	$(srcdir)/images/exo-icon-chooser-dialog.png
+HTML_IMAGES =
 
 # Extra SGML files that are included by DOC_MAIN_SGML_FILE
-content_files = 							\
-	version.xml							\
-	visual-index.xml
+content_files =
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 # if $(DOC_MODULE).types is non-empty.
@@ -55,21 +51,4 @@ GTKDOC_LIBS =  								\
 
 include $(top_srcdir)/gtk-doc.make
 
-# Other files to distribute
-EXTRA_DIST += 								\
-	exo-open.1							\
-	version.xml.in
-
-# manual pages
-man_MANS =								\
-	exo-open.1
-
-if MAINTAINER_MODE
-%.1: %.xml
-	xsltproc -nonet http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
-endif
-
-# required for gtk-doc
-dist-hook: all
-
 # vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
diff --git a/docs/reference/exo-docs.xml b/docs/reference/exo-docs.xml
index 4c57652..fb6c3d5 100644
--- a/docs/reference/exo-docs.xml
+++ b/docs/reference/exo-docs.xml
@@ -3,82 +3,34 @@
                       "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 % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+  %gtkdocentities;
 ]>
 
-<book id="index" lang="en">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
-    <title>Exo Reference Manual</title>
-    <releaseinfo>Version <xi:include href="version.xml" parse="text"/></releaseinfo>
-    <pubdate>December 2019</pubdate>
-
+    <title>&package_name; Reference Manual</title>
+    <releaseinfo>
+      For &package_string;.
+      The latest version of this documentation can be found on-line at
+      <ulink role="online-location" url="https://developer.xfce.org/&package_name;/index.html">https://developer.xfce.org/&package_name;/</ulink>.
+    </releaseinfo>
     <copyright>
-      <year>2004</year>
-      <year>2005</year>
-      <year>2006</year>
-      <year>2007</year>
+      <year>2004-2007</year>
       <holder>os-cillation e.K.</holder>
     </copyright>
 
     <copyright>
-      <year>2009</year>
-      <year>2010</year>
-      <year>2011</year>
-      <year>2012</year>
-      <year>2013</year>
-      <year>2014</year>
-      <year>2015</year>
-      <year>2016</year>
-      <year>2017</year>
-      <year>2018</year>
-      <year>2019</year>
+      <year>2009-2021</year>
       <holder>Xfce Development Team</holder>
     </copyright>
-
-    <legalnotice id="legalnotice">
-      <para>
-        Permission is granted to copy, distribute and/or modify this document
-        under the terms of the GNU Free Documentation License, Version 1.1 or
-        any later version published by the Free Software Foundation; with no
-        Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
-        Texts. The complete license text is available from the <ulink
-        type="http" url="http://www.gnu.org/">Free Software Foundation</ulink>.
-      </para>
-    </legalnotice>
-
-    <authorgroup>
-      <author>
-        <firstname>Benedikt</firstname>
-        <surname>Meurer</surname>
-        <affiliation>
-          <address><email>benny@xfce.org</email></address>
-          <orgname>os-cillation</orgname>
-          <orgdiv>System development</orgdiv>
-          <jobtitle>Software developer</jobtitle>
-        </affiliation>
-      </author>
-      <author>
-        <firstname>Jannis</firstname>
-        <surname>Pohlmann</surname>
-        <affiliation>
-          <address><email>jannis@xfce.org</email></address>
-        </affiliation>
-      </author>
-      <author>
-        <firstname>Sean</firstname>
-        <surname>Davis</surname>
-        <affiliation>
-          <address><email>bluesabre@xfce.org</email></address>
-        </affiliation>
-      </author>
-    </authorgroup>
   </bookinfo>
 
   <part id="exo-overview">
     <title>Overview</title>
     <para>
-      <ulink type="http" url="http://libexo.os-cillation.com/">libexo</ulink> is an extension
-      library for <ulink url="https://xfce.org/" type="http">Xfce</ulink>,
-      developed by <ulink url="http://www.os-cillation.com/" type="http">os-cillation</ulink>.
+      exo is an extension library for <ulink url="https://xfce.org/" type="http">Xfce</ulink>,
+      originally developed by <ulink url="https://www.os-cillation.com/" type="http">os-cillation</ulink>.
       While Xfce comes with quite a few libraries that are targeted at desktop development,
       libexo is targeted at application developement - in particular, developing applications for
       the Xfce Desktop Environment.
@@ -262,62 +214,54 @@
 
     <index id="api-index-full">
       <title>All symbols</title>
-      <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.3.1">
       <title>Added in 0.3.1</title>
-      <xi:include href="xml/api-index-0.3.1.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.3.1.1">
       <title>Added in 0.3.1.1</title>
-      <xi:include href="xml/api-index-0.3.1.1.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.3.1.3">
       <title>Added in 0.3.1.3</title>
-      <xi:include href="xml/api-index-0.3.1.3.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.3.1.5">
       <title>Added in 0.3.1.5</title>
-      <xi:include href="xml/api-index-0.3.1.5.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.3.1.9">
       <title>Added in 0.3.1.9</title>
-      <xi:include href="xml/api-index-0.3.1.9.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.3.3">
       <title>Added in 0.3.3</title>
-      <xi:include href="xml/api-index-0.3.3.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.4.0">
       <title>Added in 0.4.0</title>
-      <xi:include href="xml/api-index-0.4.0.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.5.0">
       <title>Added in 0.5.0</title>
-      <xi:include href="xml/api-index-0.5.0.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.7.1">
       <title>Added in 0.7.1</title>
-      <xi:include href="xml/api-index-0.7.1.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.10.2">
       <title>Added in 0.10.2</title>
-      <xi:include href="xml/api-index-0.10.2.xml"><xi:fallback /></xi:include>
     </index>
 
     <index id="api-index-0.11.4">
       <title>Added in 0.11.4</title>
-      <xi:include href="xml/api-index-0.11.4.xml"><xi:fallback /></xi:include>
+    </index>
+
+    <index id="api-index-0.11.5">
+      <title>Added in 0.11.5</title>
     </index>
 
     <index id="api-index-deprecated">
@@ -326,15 +270,11 @@
     </index>
   </chapter>
 
-  <chapter>
-    <title>Visual Index</title>
-    <xi:include href="visual-index.xml"/>
-  </chapter>
-
   <index>
     <title>Index</title>
   </index>
 
+
 </book>
 
 <!--
diff --git a/docs/reference/images/exo-gtk-file-chooser-add-thumbnail-preview.png b/docs/reference/images/exo-gtk-file-chooser-add-thumbnail-preview.png
deleted file mode 100644
index 303e198..0000000
--- a/docs/reference/images/exo-gtk-file-chooser-add-thumbnail-preview.png
+++ /dev/null
diff --git a/docs/reference/images/exo-icon-chooser-dialog.png b/docs/reference/images/exo-icon-chooser-dialog.png
deleted file mode 100644
index e57ea47..0000000
--- a/docs/reference/images/exo-icon-chooser-dialog.png
+++ /dev/null
diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in
deleted file mode 100644
index d78bda9..0000000
--- a/docs/reference/version.xml.in
+++ /dev/null
@@ -1 +0,0 @@
-@VERSION@
diff --git a/docs/reference/visual-index.xml b/docs/reference/visual-index.xml
deleted file mode 100644
index 9d1772b..0000000
--- a/docs/reference/visual-index.xml
+++ /dev/null
@@ -1,9 +0,0 @@
-<para role="gallery">
-  <link linkend="exo-gtk-file-chooser-add-thumbnail-preview">
-    <inlinegraphic fileref="exo-gtk-file-chooser-add-thumbnail-preview.png" format="PNG" />
-  </link>
-
-  <link linkend="ExoIconChooserDialog">
-    <inlinegraphic fileref="exo-icon-chooser-dialog.png" format="PNG" />
-  </link>
-</para>