From 6d06f132d36a531885ae5fbe38be30c08ba4360c Mon Sep 17 00:00:00 2001
From: Glynn Foster <glynn.foster@sun.com>
Date: Sat, 18 Jan 2003 19:19:20 +0000
Subject: [PATCH] Enable help documentation in the build.

2003-01-18  Glynn Foster  <glynn.foster@sun.com>

	* Makefile.am, configure.in, omf.make, xmldocs.make: Enable
	help documentation in the build.

	* help/C/zenity-C.omf, help/C/zenity.xml: Fix up silly errors.
---
 ChangeLog           |  7 ++++
 Makefile.am         |  5 ++-
 configure.in        | 14 ++++---
 help/C/zenity-C.omf |  4 +-
 help/C/zenity.xml   |  8 ++--
 omf.make            | 53 +++++++++++++++++++++++++
 xmldocs.make        | 95 +++++++++++++++++++++++++++++++++++++++++++++
 7 files changed, 173 insertions(+), 13 deletions(-)
 create mode 100644 omf.make
 create mode 100644 xmldocs.make

diff --git a/ChangeLog b/ChangeLog
index f192d4a..0f28701 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,10 @@
+2003-01-18  Glynn Foster  <glynn.foster@sun.com>
+
+	* Makefile.am, configure.in, omf.make, xmldocs.make: Enable
+	help documentation in the build.
+
+	* help/C/zenity-C.omf, help/C/zenity.xml: Fix up silly errors.
+
 2003-01-18  Glynn Foster  <glynn.foster@sun.com>
 
 	* help/C/zenity.xml: Add in references to the screenshots.
diff --git a/Makefile.am b/Makefile.am
index 2cb5ad7..f339c66 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -1,12 +1,15 @@
 SUBDIRS = \
 	src	\
 	po	\
-	data
+	data	\
+	help
 
 EXTRA_DIST = \
 	intltool-extract.in	\
 	intltool-merge.in	\
 	intltool-update.in	\
+	omf.make		\
+	xmldocs.make		\
 	COPYING			\
 	HACKING			\
 	ChangeLog		\
diff --git a/configure.in b/configure.in
index 52668c5..6bffeab 100644
--- a/configure.in
+++ b/configure.in
@@ -30,13 +30,13 @@ AC_SUBST(ZENITY_LIBS)
 AC_CHECK_LIB(popt, poptHelpOptions,, AC_MSG_ERROR([popt is required to build script.]))
 
 dnl ***********************************************
-dnl scrollkeeper checks - don't use these currently
+dnl scrollkeeper checks
 dnl ***********************************************
-dnl
-dnl AC_PATH_PROG(SCROLLKEEPER_CONFIG, scrollkeeper-config,no)
-dnl if test x$SCROLLKEEPER_CONFIG = xno; then
-dnl   AC_MSG_ERROR(Couldn't find scrollkeeper-config. Please install the scrollkeeper package)
-dnl fi
+
+AC_PATH_PROG(SCROLLKEEPER_CONFIG, scrollkeeper-config,no)
+if test x$SCROLLKEEPER_CONFIG = xno; then
+	AC_MSG_ERROR(Couldn't find scrollkeeper-config. Please install the scrollkeeper package)
+fi
 
 dnl *******************************
 dnl Internationalization
@@ -68,4 +68,6 @@ Makefile
 po/Makefile.in
 src/Makefile
 data/Makefile
+help/Makefile
+help/C/Makefile
 ])
diff --git a/help/C/zenity-C.omf b/help/C/zenity-C.omf
index ecc2882..a36c518 100644
--- a/help/C/zenity-C.omf
+++ b/help/C/zenity-C.omf
@@ -2,11 +2,11 @@
 <omf>
   <resource>
      <creator>
-       Glynn Foster <glynn.foster@sun.com>
+       Glynn Foster &lt;glynn.foster@sun.com&gt;
      </creator>
      
      <maintainer>
-       Glynn Foster <glynn.foster@sun.com>
+       Glynn Foster &lt;glynn.foster@sun.com&gt;
      </maintainer>
 
      <!--
diff --git a/help/C/zenity.xml b/help/C/zenity.xml
index f84b3bc..8a51363 100644
--- a/help/C/zenity.xml
+++ b/help/C/zenity.xml
@@ -54,7 +54,7 @@
     <revhistory>
 	    <revision>
 		    <revnumber>1.0</revnumber>
-		    <date>&date;</date>
+		    <date>18-01-2003</date>
 		    <revdescription>
 			    <para role="author">Glynn Foster</para>
 			    <para role="publisher">
@@ -176,21 +176,21 @@
     <variablelist>
 
       <varlistentry>
-        <term><varname>0</term>
+        <term><varname>0</varname></term>
 	<listitem>
 	  <para>The user has pressed either 'OK' or 'Close'.</para>
 	</listitem>
       </varlistentry>
      	
       <varlistentry>
-        <term><varname>1</term>
+        <term><varname>1</varname></term>
 	<listitem>
 	  <para>The user has pressed either 'Cancel' or closed the dialog through the window functions.</para>
 	</listitem>
       </varlistentry>
 
       <varlistentry>
-        <term><varname>-1</term>
+        <term><varname>-1</varname></term>
 	<listitem>
 	  <para>An unexpected error has occurred.</para>
 	</listitem>
diff --git a/omf.make b/omf.make
new file mode 100644
index 0000000..3261e00
--- /dev/null
+++ b/omf.make
@@ -0,0 +1,53 @@
+# 
+# No modifications of this Makefile should be necessary.
+#
+# This file contains the build instructions for installing OMF files.  It is
+# generally called from the makefiles for particular formats of documentation.
+#
+# Note that you must configure your package with --localstatedir=/var/lib
+# so that the scrollkeeper-update command below will update the database
+# in the standard scrollkeeper directory.
+#
+# If it is impossible to configure with --localstatedir=/var/lib, then
+# modify the definition of scrollkeeper_localstate_dir so that
+# it points to the correct location. Note that you must still use 
+# $(localstatedir) in this or when people build RPMs it will update
+# the real database on their system instead of the one under RPM_BUILD_ROOT.
+#
+# Note: This make file is not incorporated into xmldocs.make because, in
+#       general, there will be other documents install besides XML documents
+#       and the makefiles for these formats should also include this file.
+#
+# About this file:
+#	This file was taken from scrollkeeper_example2, a package illustrating
+#	how to install documentation and OMF files for use with ScrollKeeper
+#	0.3.x and 0.4.x.  For more information, see:
+#		http://scrollkeeper.sourceforge.net/	
+# 	Version: 0.1.2 (last updated: March 20, 2002)
+#
+
+omf_dest_dir=$(datadir)/omf/@PACKAGE@
+scrollkeeper_localstate_dir = $(localstatedir)/scrollkeeper
+
+omf: omf_timestamp
+
+omf_timestamp: $(omffile)
+	-for file in $(omffile); do \
+	  scrollkeeper-preinstall $(docdir)/$(docname).xml $(srcdir)/$$file $$file.out; \
+	done
+	touch omf_timestamp
+
+install-data-hook-omf:
+	$(mkinstalldirs) $(DESTDIR)$(omf_dest_dir)
+	for file in $(omffile); do \
+		$(INSTALL_DATA) $$file.out $(DESTDIR)$(omf_dest_dir)/$$file; \
+	done
+	-scrollkeeper-update -p $(scrollkeeper_localstate_dir) -o $(DESTDIR)$(omf_dest_dir)
+
+uninstall-local-omf:
+	-for file in $(srcdir)/*.omf; do \
+		basefile=`basename $$file`; \
+		rm -f $(omf_dest_dir)/$$basefile; \
+	done
+	-rmdir $(omf_dest_dir)
+	-scrollkeeper-update -p $(scrollkeeper_localstate_dir)
diff --git a/xmldocs.make b/xmldocs.make
new file mode 100644
index 0000000..9f78af7
--- /dev/null
+++ b/xmldocs.make
@@ -0,0 +1,95 @@
+#
+# No modifications of this Makefile should be necessary.
+#
+# To use this template:
+#     1) Define: figdir, docname, lang, omffile, and entities in
+#        your Makefile.am file for each document directory,
+#        although figdir, omffile, and entities may be empty
+#     2) Make sure the Makefile in (1) also includes 
+#	 "include $(top_srcdir)/xmldocs.make" and
+#	 "dist-hook: app-dist-hook".
+#     3) Optionally define 'entities' to hold xml entities which
+#        you would also like installed
+#     4) Figures must go under $(figdir)/ and be in PNG format
+#     5) You should only have one document per directory 
+#     6) Note that the figure directory, $(figdir)/, should not have its
+#        own Makefile since this Makefile installs those figures.
+#
+# example Makefile.am:
+#   figdir = figures
+#   docname = scrollkeeper-manual
+#   lang = C
+#   omffile=scrollkeeper-manual-C.omf
+#   entities = fdl.xml
+#   include $(top_srcdir)/xmldocs.make
+#   dist-hook: app-dist-hook
+#
+# About this file:
+#	This file was taken from scrollkeeper_example2, a package illustrating
+#	how to install documentation and OMF files for use with ScrollKeeper 
+#	0.3.x and 0.4.x.  For more information, see:
+#		http://scrollkeeper.sourceforge.net/
+#	Version: 0.1.2 (last updated: March 20, 2002)
+#
+
+
+# ************* Begin of section some packagers may need to modify  **************
+# This variable (docdir) specifies where the documents should be installed.
+# This default value should work for most packages.
+# docdir = $(datadir)/@PACKAGE@/doc/$(docname)/$(lang)
+docdir = $(datadir)/gnome/help/$(docname)/$(lang)
+
+# **************  You should not have to edit below this line  *******************
+xml_files = $(entities) $(docname).xml
+
+EXTRA_DIST = $(xml_files) $(omffile)
+CLEANFILES = omf_timestamp
+
+include $(top_srcdir)/omf.make
+
+all: omf
+
+$(docname).xml: $(entities)
+	-ourdir=`pwd`;  \
+	cd $(srcdir);   \
+	cp $(entities) $$ourdir
+
+app-dist-hook:
+	if test "$(figdir)"; then \
+	  $(mkinstalldirs) $(distdir)/$(figdir); \
+	  for file in $(srcdir)/$(figdir)/*.png; do \
+	    basefile=`echo $$file | sed -e  's,^.*/,,'`; \
+	    $(INSTALL_DATA) $$file $(distdir)/$(figdir)/$$basefile; \
+	  done \
+	fi
+
+install-data-local: omf
+	$(mkinstalldirs) $(DESTDIR)$(docdir)
+	for file in $(xml_files); do \
+	  cp $(srcdir)/$$file $(DESTDIR)$(docdir); \
+	done
+	if test "$(figdir)"; then \
+	  $(mkinstalldirs) $(DESTDIR)$(docdir)/$(figdir); \
+	  for file in $(srcdir)/$(figdir)/*.png; do \
+	    basefile=`echo $$file | sed -e  's,^.*/,,'`; \
+	    $(INSTALL_DATA) $$file $(DESTDIR)$(docdir)/$(figdir)/$$basefile; \
+	  done \
+	fi
+
+install-data-hook: install-data-hook-omf
+
+uninstall-local: uninstall-local-doc uninstall-local-omf
+
+uninstall-local-doc:
+	-if test "$(figdir)"; then \
+	  for file in $(srcdir)/$(figdir)/*.png; do \
+	    basefile=`echo $$file | sed -e  's,^.*/,,'`; \
+	    rm -f $(docdir)/$(figdir)/$$basefile; \
+	  done; \
+	  rmdir $(DESTDIR)$(docdir)/$(figdir); \
+	fi
+	-for file in $(xml_files); do \
+	  rm -f $(DESTDIR)$(docdir)/$$file; \
+	done
+	-rmdir $(DESTDIR)$(docdir)
+