GNOME.org
 

[gnomemm-website] Convert from gnome-doc-utils to yelp-utils.

commit eb1e8300767d605fc19abb42f6d404f6977d9980
Author: Murray Cumming <murrayc murrayc com>
Date:   Thu Jan 30 10:42:18 2014 +0100

    Convert from gnome-doc-utils to yelp-utils.

 autogen.sh                                    |    1 -
 build/.gitignore                              |    2 -
 configure.ac                                  |    5 +-
 docs/C/{gnomemm-website.xml => index.docbook} |  226 ++++++++++++------------
 docs/C/{index.xml => main.xml}                |    3 +-
 docs/Makefile.am                              |   47 +++---
 6 files changed, 141 insertions(+), 143 deletions(-)
---
diff --git a/autogen.sh b/autogen.sh
index 988f2e2..664c07a 100755
--- a/autogen.sh
+++ b/autogen.sh
@@ -3,7 +3,6 @@ test -n "$srcdir" || srcdir=`dirname "$0"`
 test -n "$srcdir" || srcdir=.
 (
   cd "$srcdir" &&
-  gnome-doc-prepare --automake --copy --force &&
   autoreconf --force --install --verbose
 ) || exit
 test -n "$NOCONFIGURE" || "$srcdir/configure" --enable-maintainer-mode "$@"
diff --git a/build/.gitignore b/build/.gitignore
index 2d993ed..7b13ff1 100644
--- a/build/.gitignore
+++ b/build/.gitignore
@@ -4,8 +4,6 @@
 /dist-changelog.am
 /doc-reference.am
 /generate-binding.am
-/gnome-doc-utils.m4
-/gnome-doc-utils.make
 /install-sh
 /libtool.m4
 /lt*.m4
diff --git a/configure.ac b/configure.ac
index 49afd73..9809a02 100644
--- a/configure.ac
+++ b/configure.ac
@@ -3,7 +3,7 @@ AC_INIT([gnomemm-website], [2.91.4],
         [http://bugzilla.gnome.org/enter_bug.cgi?product=gtkmm],
         [gnomemm-website], [http://www.gtkmm.org/])
 
-AC_CONFIG_SRCDIR([docs/C/gnomemm-website.xml])
+AC_CONFIG_SRCDIR([docs/C/index.docbook])
 AC_CONFIG_AUX_DIR([build])
 AC_CONFIG_MACRO_DIR([build])
 
@@ -14,8 +14,7 @@ AC_ARG_VAR([ACLOCAL_FLAGS], [aclocal flags, e.g. -I <macro dir>])
 
 AC_LANG([C++])
 
-GNOME_DOC_INIT([0.9.0],,
-  [AC_MSG_WARN([[gnome-doc-utils not found: tutorial will not be built.]])])
+YELP_HELP_INIT
 
 AC_CONFIG_FILES([Makefile
                  docs/Makefile])
diff --git a/docs/C/gnomemm-website.xml b/docs/C/index.docbook
similarity index 93%
rename from docs/C/gnomemm-website.xml
rename to docs/C/index.docbook
index 1651194..50a185e 100644
--- a/docs/C/gnomemm-website.xml
+++ b/docs/C/index.docbook
@@ -1,113 +1,113 @@
-<?xml version='1.0' encoding='UTF-8'?>
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
-               "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
-]>
-
-<!-- The header menu, sidebar menu, and footer. -->
-<book>
-  <bookinfo>
-    <title>gtkmm</title>
-    <subtitle>C++ Interfaces for GTK+ and GNOME</subtitle>
-    <abstract>
-      <para id="banner"><itemizedlist>
-          <listitem>
-            <para><ulink url="index.html">Home</ulink></para>
-          </listitem>
-          <listitem>
-            <para><ulink url="license.html">License</ulink></para>
-          </listitem>
-          <listitem>
-            <para><ulink url="download.html">Download</ulink></para>
-          </listitem>
-          <listitem>
-            <para><ulink url="documentation.html">Documentation</ulink></para>
-          </listitem>
-          <listitem>
-            <para><ulink url="developers.html">Development</ulink></para>
-          </listitem>
-        </itemizedlist></para>
-      <formalpara id="resource-menu">
-        <title>Other Resources</title>
-        <para><itemizedlist>
-            <listitem>
-              <para><ulink url="news.html">News</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="http://live.gnome.org/gtkmm/FAQ";>FAQ</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="http://live.gnome.org/gtkmm";>Wiki</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="mailinglist.html">Mailing Lists</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="git.html">Git</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="bugs.html">Bugs</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="books.html">Books</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="commercial_support.html">Commercial Support</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="extra.html">Additional Resources</ulink></para>
-            </listitem>
-          </itemizedlist></para>
-      </formalpara>
-      <formalpara id="language-menu">
-        <title>Language</title>
-        <para><itemizedlist>
-            <listitem>
-              <para><ulink url="../de/index.html">Deutsch</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="../en/index.html">English</ulink></para>
-            </listitem>
-            <listitem>
-              <para><ulink url="../es/index.html">Español</ulink></para>
-            </listitem>
-               <listitem>
-                 <para><ulink url="../pt_BR/index.html">Português (Brasil)</ulink></para>
-               </listitem>
-            <listitem>
-              <para><ulink url="../zh_CN/index.html">中文</ulink></para>
-            </listitem>
-          </itemizedlist></para>
-      </formalpara>
-      <para id="sidebar-credits"><informalfigure>
-          <mediaobject>
-            <imageobject>
-              <imagedata fileref="../images/gtk-logo.png"/>
-            </imageobject>
-          </mediaobject>
-          <ulink url="http://www.gtk.org"/>
-        </informalfigure><informalfigure>
-          <mediaobject>
-            <imageobject>
-              <imagedata fileref="../images/GNOME-logo.png"/>
-            </imageobject>
-          </mediaobject>
-          <ulink url="http://www.gnome.org"/>
-        </informalfigure></para>
-      <para id="footer"><ulink url="mailto:gtkmm-list gnome org">Contact Us</ulink></para>
-    </abstract>
-  </bookinfo>
-
-  <xi:include href="index.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="books.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="bugs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="commercial_support.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="developers.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="download.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="extra.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="git.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="license.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="mailinglist.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-  <xi:include href="news.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-
-</book>
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+               "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
+]>
+
+<!-- The header menu, sidebar menu, and footer. -->
+<book>
+  <bookinfo>
+    <title>gtkmm</title>
+    <subtitle>C++ Interfaces for GTK+ and GNOME</subtitle>
+    <abstract>
+      <para id="banner"><itemizedlist>
+          <listitem>
+            <para><ulink url="index.html">Home</ulink></para>
+          </listitem>
+          <listitem>
+            <para><ulink url="license.html">License</ulink></para>
+          </listitem>
+          <listitem>
+            <para><ulink url="download.html">Download</ulink></para>
+          </listitem>
+          <listitem>
+            <para><ulink url="documentation.html">Documentation</ulink></para>
+          </listitem>
+          <listitem>
+            <para><ulink url="developers.html">Development</ulink></para>
+          </listitem>
+        </itemizedlist></para>
+      <formalpara id="resource-menu">
+        <title>Other Resources</title>
+        <para><itemizedlist>
+            <listitem>
+              <para><ulink url="news.html">News</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="http://live.gnome.org/gtkmm/FAQ";>FAQ</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="http://live.gnome.org/gtkmm";>Wiki</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="mailinglist.html">Mailing Lists</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="git.html">Git</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="bugs.html">Bugs</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="books.html">Books</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="commercial_support.html">Commercial Support</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="extra.html">Additional Resources</ulink></para>
+            </listitem>
+          </itemizedlist></para>
+      </formalpara>
+      <formalpara id="language-menu">
+        <title>Language</title>
+        <para><itemizedlist>
+            <listitem>
+              <para><ulink url="../de/index.html">Deutsch</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="../el/index.html">Greek</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="../en/index.html">English</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="../es/index.html">Español</ulink></para>
+            </listitem>
+            <listitem>
+              <para><ulink url="../zh_CN/index.html">中文</ulink></para>
+            </listitem>
+          </itemizedlist></para>
+      </formalpara>
+      <para id="sidebar-credits"><informalfigure>
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="../images/gtk-logo.png"/>
+            </imageobject>
+          </mediaobject>
+          <ulink url="http://www.gtk.org"/>
+        </informalfigure><informalfigure>
+          <mediaobject>
+            <imageobject>
+              <imagedata fileref="../images/GNOME-logo.png"/>
+            </imageobject>
+          </mediaobject>
+          <ulink url="http://www.gnome.org"/>
+        </informalfigure></para>
+      <para id="footer"><ulink url="mailto:gtkmm-list gnome org">Contact Us</ulink></para>
+    </abstract>
+  </bookinfo>
+
+  <xi:include href="main.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="books.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="bugs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="commercial_support.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="developers.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="download.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="extra.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="git.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="license.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="mailinglist.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  <xi:include href="news.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+</book>
diff --git a/docs/C/index.xml b/docs/C/main.xml
similarity index 99%
rename from docs/C/index.xml
rename to docs/C/main.xml
index 440bb70..f35f13c 100644
--- a/docs/C/index.xml
+++ b/docs/C/main.xml
@@ -1,4 +1,4 @@
-<?xml version='1.0' encoding='UTF-8'?>
+<?xml version='1.0' encoding='UTF-8'?>
 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
                "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [
   <!ENTITY gtkmm "<application>gtkmm</application>">
@@ -106,3 +106,4 @@
       </sect2>
     </sect1>
   </article>
+
diff --git a/docs/Makefile.am b/docs/Makefile.am
index cf95649..b5d5a8a 100644
--- a/docs/Makefile.am
+++ b/docs/Makefile.am
@@ -10,13 +10,16 @@ vpath_listall = $(sort $(wildcard $(1)) $(if $(srcdir:.=),$(vpath_srclist)))
 XMLLINT = xmllint
 XSLTPROC = xsltproc
 
-DOC_MODULE = gnomemm-website
-doc_module_with_ext = $(DOC_MODULE).xml
-DOC_ENTITIES =
-DOC_FIGURES =
+ YELP_HELP_RULES@
+
+HELP_ID = gnomemm-website
+help_index_file = index.docbook
+HELP_MEDIA =
 
 # The names of any files included by xinclude (preferred):
-DOC_INCLUDES = \
+HELP_FILES = \
+        index.docbook \
+        main.xml \
        books.xml \
        bugs.xml \
        commercial_support.xml \
@@ -25,15 +28,15 @@ DOC_INCLUDES = \
        download.xml \
        extra.xml \
        git.xml \
-       index.xml \
        license.xml \
        mailinglist.xml \
        news.xml
 
-DOC_LINGUAS = de el es fr pt_BR sl zh_CN
 
-MAINTAINERCLEANFILES =  $(foreach lang,en $(DOC_LINGUAS),html/$(lang)/*.html) \
-                       $(foreach lang,en $(DOC_LINGUAS),$(srcdir)/html/$(lang)/*.html)
+HELP_LINGUAS = de el es fr pt_BR sl zh_CN
+
+MAINTAINERCLEANFILES =  $(foreach lang,en $(HELP_LINGUAS),html/$(lang)/*.html) \
+                       $(foreach lang,en $(HELP_LINGUAS),$(srcdir)/html/$(lang)/*.html)
 
 tutorialdir         = $(gnomemmwebsite_docdir)/tutorial
 tutorial_htmldir    = $(tutorialdir)/html
@@ -44,42 +47,40 @@ tutorial_html_files = $(call vpath_listall,html/en/*.html) html/style/style.css
 tutorial_html_inst  = $(foreach\
        file,$(tutorial_html_files),$(or $(wildcard $(file)),$(srcdir)/$(file)))
 
-tutorial_xml_files  = $(addsuffix /gnomemm-website.xml,C $(DOC_LINGUAS))
-tutorial_po_files   = $(foreach lang, $(DOC_LINGUAS), $(lang)/$(lang).po)
-website_indexes            = $(foreach lang,$(DOC_LINGUAS),html/$(lang)/index.html)
+tutorial_xml_files  = $(addsuffix /index.docbook,C $(HELP_LINGUAS))
+tutorial_po_files   = $(foreach lang, $(HELP_LINGUAS), $(lang)/$(lang).po)
+website_indexes            = $(foreach lang,$(HELP_LINGUAS),html/$(lang)/index.html)
 
 dist_noinst_DATA =             \
-       C/gnomemm-website.xml   \
+       C/index.docbook \
        $(tutorial_po_files)    \
        $(tutorial_xml_files)   \
        $(tutorial_html_files)
 
-dist_tutorial_figures_DATA = $(addprefix C/,$(DOC_FIGURES))
+dist_tutorial_figures_DATA = $(addprefix C/,$(HELP_MEDIA))
 
 dist_tutorial_icons_DATA =
 
-include $(top_srcdir)/build/gnome-doc-utils.make
-
-$(DOC_LINGUAS): %: 
+$(HELP_LINGUAS): %: 
        @$(MKDIR_P) $@
 
-all-local: $(DOC_LINGUAS) html/en/index.html $(website_indexes)
+all-local: $(HELP_LINGUAS) html/en/index.html $(website_indexes)
 
-$(website_indexes): html/%/index.html:$(addprefix %/,$(doc_module_with_ext) $(DOC_INCLUDES))
+$(website_indexes): html/%/index.html:$(addprefix %/,$(HELP_FILES))
   lang=$(subst html/,,$(subst /index.html,,$@))
        $(AM_V_at)rm -rf html/$(lang)
        $(AM_V_at)$(MKDIR_P) html/$(lang)
-       $(AM_V_GEN)$(XSLTPROC) -o html/$(lang)/ --xinclude param.xsl $(srcdir)/$(lang)/$(doc_module_with_ext)
+       $(AM_V_GEN)$(XSLTPROC) -o html/$(lang)/ --xinclude param.xsl $(srcdir)/$(lang)/$(help_index_file)
        $(AM_V_at)rm -f html/$(lang)/root.html
 
 # Create a html generation of the C locale's version of the DocBook,
 # using our custom stylesheet and graphics:
-html/en/index.html: $(addprefix $(srcdir)/C/,$(doc_module_with_ext) $(DOC_INCLUDES))
+html/en/index.html: $(addprefix $(srcdir)/C/,$(HELP_FILES))
        $(AM_V_at)rm -fr html/en
        $(AM_V_at)$(MKDIR_P) html/en
-       $(AM_V_GEN)$(XSLTPROC) -o html/en/ --xinclude param.xsl $(srcdir)/C/$(doc_module_with_ext)
+       $(AM_V_GEN)$(XSLTPROC) -o html/en/ --xinclude param.xsl $(srcdir)/C/$(help_index_file)
        
-validate: $(addprefix $(srcdir)/C/,$(doc_module_with_ext) $(DOC_INCLUDES))
+validate: $(addprefix $(srcdir)/C/,$(HELP_FILES))
        $(XMLLINT) --xinclude --postvalid --noout $<
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]