Revamp the documentation to modernize and uniformize accross components

2 files changed, 36 insertions, 81 deletions

diff --git a/docs/reference/thunarx/Makefile.am b/docs/reference/thunarx/Makefile.am
index 16f61426..8b9fea5e 100644
--- a/docs/reference/thunarx/Makefile.am
+++ b/docs/reference/thunarx/Makefile.am
@@ -1,5 +1,3 @@
-AUTOMAKE_OPTIONS = 1.8
-
 # The name of the module.
 DOC_MODULE=thunarx
 
@@ -9,21 +7,18 @@ DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
 # Extra options to supply to gtkdoc-scan
 SCAN_OPTIONS=--deprecated-guards="EXO_DISABLE_DEPRECATED"
 
-# Extra options to pass to gtkdoc-scangobj
-SCANGOBJ_OPTIONS=
-
 # The directory containing the source code. Relative to $(srcdir)
-DOC_SOURCE_DIR=../../../thunarx
+DOC_SOURCE_DIR=$(top_srcdir)/thunarx
 
 # Extra options to supply to gtkdoc-mkdb
-MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--xml-mode --output-format=xml
 
 # Extra options to supply to gtkdoc-fixref
 FIXXREF_OPTIONS=
 
 # Used for dependencies
-HFILE_GLOB=$(top_srcdir)/thunarx/*.h
-CFILE_GLOB=$(top_srcdir)/thunarx/*.c
+HFILE_GLOB=
+CFILE_GLOB=
 
 # Header files to ignore when scanning
 IGNORE_HFILES=thunarx-alias.h
@@ -39,12 +34,11 @@ HTML_IMAGES =								\
 	$(srcdir)/images/say-hello.png
 
 # Extra SGML files that are included by DOC_MAIN_SGML_FILE
-content_files = 							\
-	version.xml
+content_files =
 
 # CFLAGS and LDFLAGS for compiling scan program. Only needed
 # if $(DOC_MODULE).types is non-empty.
-AM_CPPFLAGS =	 							\
+GTKDOC_CFLAGS =	 							\
 	-I$(top_srcdir) 						\
 	-I$(top_builddir) 						\
 	$(GTK_CFLAGS)							\
@@ -56,11 +50,4 @@ GTKDOC_LIBS =  								\
 
 include $(top_srcdir)/gtk-doc.make
 
-# Other files to distribute
-EXTRA_DIST +=								\
-	version.xml.in
-
-# required for gtk-doc
-dist-hook: all
-
 # vi:set ts=8 sw=8 noet ai nocindent syntax=automake:
diff --git a/docs/reference/thunarx/thunarx-docs.xml b/docs/reference/thunarx/thunarx-docs.xml
index 4a1f2cbe..131639d9 100644
--- a/docs/reference/thunarx/thunarx-docs.xml
+++ b/docs/reference/thunarx/thunarx-docs.xml
@@ -1,7 +1,7 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
-               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-
+<?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"
+[
 <!ENTITY ThunarxFileInfo SYSTEM "xml/thunarx-file-info.xml">
 <!ENTITY ThunarxMenu SYSTEM "xml/thunarx-menu.xml">
 <!ENTITY ThunarxMenuItem SYSTEM "xml/thunarx-menu-item.xml">
@@ -13,58 +13,24 @@
 <!ENTITY ThunarxProviderPlugin SYSTEM "xml/thunarx-provider-plugin.xml">
 <!ENTITY ThunarxRenamer SYSTEM "xml/thunarx-renamer.xml">
 <!ENTITY ThunarxRenamerProvider SYSTEM "xml/thunarx-renamer-provider.xml">
-<!ENTITY thunarx-version-information SYSTEM "xml/thunarx-version-information.xml">
 
-<!ENTITY version SYSTEM "version.xml">
-<!ENTITY date "2017">
+  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
+  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
+  %gtkdocentities;
 ]>
 
-<book id="index">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   <bookinfo>
-    <title>Thunar Extensions Reference Manual</title>
-    <releaseinfo>Version &version;</releaseinfo>
-    <pubdate>&date;</pubdate>
-
-    <copyright>
-      <year>2005</year>
-      <holder>Benedikt Meurer</holder>
-    </copyright>
-
+    <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>2010</year>
-      <holder>Jannis Pohlmann</holder>
+      <year>2021</year>
+      <holder>The 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="https://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>
-    </authorgroup>
   </bookinfo>
 
   <part id="thunarx-overview">
@@ -420,7 +386,7 @@ thunar_extension_initialize (ThunarxProviderPlugin *plugin)
   <part id="thunarx-fundamentals">
     <title>Fundamentals</title>
 
-    &thunarx-version-information;
+    <xi:include href="xml/thunarx-version-information.xml"/>
   </part>
 
   <part id="thunarx-abstraction-layer">
@@ -451,12 +417,12 @@ thunar_extension_initialize (ThunarxProviderPlugin *plugin)
       dialog provided by Thunar to rename multiple files at once.
     </para>
 
-    &ThunarxFileInfo;
-    &ThunarxMenu;
-    &ThunarxMenuItem;
-    &ThunarxPropertyPage;
-    &ThunarxProviderPlugin;
-    &ThunarxRenamer;
+    <xi:include href="xml/thunarx-file-info.xml"/>
+    <xi:include href="xml/thunarx-menu.xml"/>
+    <xi:include href="xml/thunarx-menu-item.xml"/>
+    <xi:include href="xml/thunarx-property-page.xml"/>
+    <xi:include href="xml/thunarx-provider-plugin.xml"/>
+    <xi:include href="xml/thunarx-renamer.xml"/>
   </part>
 
   <part id="thunarx-providers">
@@ -480,21 +446,23 @@ thunar_extension_initialize (ThunarxProviderPlugin *plugin)
       <inlinegraphic fileref="menu-provider.png" format="PNG" />
     </para>
 
-    &ThunarxMenuProvider;
-    &ThunarxPropertyPageProvider;
-    &ThunarxPreferencesProvider;
-    &ThunarxRenamerProvider;
+    <xi:include href="xml/thunarx-menu-provider.xml"/>
+    <xi:include href="xml/thunarx-property-page-provider.xml"/>
+    <xi:include href="xml/thunarx-preferences-provider.xml"/>
+    <xi:include href="xml/thunarx-renamer-provider.xml"/>
   </part>
 
   <part id="thunarx-using-extensions">
     <title>Using Thunar extensions in applications</title>
 
-    &ThunarxProviderFactory;
+    <xi:include href="xml/thunarx-provider-factory.xml"/>
   </part>
 
   <index>
     <title>Index</title>
   </index>
+    <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
+
 </book>
 
 <!--