Corrections to properly install GNOME2 docs

svn: r1404

gramps2/Makefile.am

@@ -1,13 +1,12 @@
 # copyright (C) 2000 Sun Microsystems, Inc.
 
-SUBDIRS = src doc omf-install
+SUBDIRS = src doc
 
-EXTRA_DIST =  autogen.sh gramps.spec.in 
+EXTRA_DIST = autogen.sh gramps.spec.in COPYING-DOCS
 
 bin_SCRIPTS = gramps
 
 grampsdocdir = $(datadir)/doc/gramps-$(VERSION)
-scrollkeeper_localstate_dir = $(localstatedir)/lib/scrollkeeper
 
 gramps: gramps.sh
 	cp gramps.sh gramps
@@ -17,10 +16,7 @@ dist-hook: gramps.spec
 
 # Build/rebuild the catalog
 install-data-hook:
-	rm -rf $(DESTDIR)$(scrollkeeper_localstate_dir)
-	$(mkinstalldirs) $(DESTDIR)$(scrollkeeper_localstate_dir)
 	$(mkinstalldirs) $(DESTDIR)$(localstatedir)/log
-#	scrollkeeper-rebuilddb -p $(DESTDIR)$(scrollkeeper_localstate_dir)
 
 # Remove generated files
 uninstall-local:

gramps2/configure.in

@@ -218,40 +218,25 @@ fi
 
 AC_MSG_RESULT(ok)
 
-dnl ======================================================
+dnl ====================================
-dnl == Modern documentation tools (scrollkeeper) checks
+dnl = Begin tests for scrollkeeper
-dnl == We may need a more recent version (GNOME2 will use
+dnl ====================================
-dnl == scrollkeeper > 0.3) but basic scrollkeeper instructions
+AC_PATH_PROG(SK_CONFIG,scrollkeeper-config,no)
-dnl == use 0.1.4 example so we'll just check for that
+if test x$SK_CONFIG = xno; then
-dnl ======================================================
+  AC_MSG_ERROR(Couldn't find scrollkeeper-config. Please install the scrollkeeper package: http://scrollkeeper.sourceforge.net)
-SCROLLKEEPER_REQUIRED=0.1.4
-AC_SUBST(SCROLLKEEPER_REQUIRED)
-
-dnl First see that *some* version of scrollkeeper is installed
-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  DISABLE_SCROLLKEEPER=1
-dnl  AC_SUBST(DISABLE_SCROLLKEEPER)
-dnl fi
-
-DISABLE_SCROLLKEEPER=1
-AC_SUBST(DISABLE_SCROLLKEEPER)
-
-dnl ======================================================
-dnl == GNOME modified DTD's need jw, not db2html
-dnl ======================================================
-AC_PATH_PROG(JW, jw, no) 
-if test x$JW = xno; then
-  HAVE_JW="no"
-else
-  HAVE_JW="yes"
 fi
-AC_SUBST(HAVE_JW)
+dnl ====================================
+dnl = End tests for scrollkeeper
+dnl ====================================
 
-dnl ======================================================
+dnl ===================================
-dnl == end of modern doc tests
+dnl Set localstatedir to /var/lib -- this is apparently not used 
-dnl ======================================================
+dnl     by anything besides scrollkeeper in our setup
+dnl ==================================
+localstatedir=/var/lib
+
+SCROLLKEEPER_BUILD_REQUIRED=0.3.5
+AC_SUBST(SCROLLKEEPER_BUILD_REQUIRED)
 
 AC_SUBST(BINSH)
 AC_SUBST(SWIG)
@@ -283,8 +268,5 @@ src/po/Makefile
 doc/Makefile
 doc/gramps-manual/Makefile
 doc/gramps-manual/C/Makefile	
-doc/extending-gramps/Makefile
-doc/extending-gramps/C/Makefile
-omf-install/Makefile
 gramps.spec
 gramps.sh])

gramps2/doc/Makefile.am

@@ -1,11 +1,11 @@
 # Process this file with automake to produce Makefile.in
 
-SUBDIRS = gramps-manual extending-gramps
+SUBDIRS = gramps-manual
 
 man_IN_FILES = gramps.1.in
 man_MANS = ${man_IN_FILES:.1.in=.1}
 
-EXTRA_DIST = $(man_MANS) $(man_IN_FILES) sgmldocs.make
+EXTRA_DIST = $(man_MANS) $(man_IN_FILES) xmldocs.make omf.make
 
 gramps.1: $(top_builddir)/config.status gramps.1.in
 	cd $(top_builddir) && CONFIG_FILES=doc/$@ $(SHELL) ./config.status

gramps2/doc/gramps-manual/C/Makefile.am

@@ -1,53 +1,7 @@
-SGML_FILES = gramps-manual.sgml
+figdir = figures
-
-figs = \
-     figures/addmedia.png \
-     figures/druidpg1.png \
-     figures/editbookmarks.png \
-     figures/ep-address.png \
-     figures/ep-altname.png \
-     figures/ep-attributes.png \
-     figures/ep-event.png \
-     figures/ep-gallery.png \
-     figures/ep-general.png \
-     figures/ep-internet.png \
-     figures/ep-lds.png \
-     figures/ep-notes.png \
-     figures/familyview.png \
-     figures/filter.png \
-     figures/globalmedia.png \
-     figures/gotobookmark.png \
-     figures/localmedia.png \
-     figures/mainwin.png \
-     figures/mediaview.png \
-     figures/opendb.png \
-     figures/pedegreesel.png \
-     figures/pedegreeview.png \
-     figures/peoplelist.png \
-     figures/placelist.png \
-     figures/prefs-bars.png \
-     figures/prefs-colors.png \
-     figures/prefs-dates.png \
-     figures/prefs-disp.png \
-     figures/prefs-find.png \
-     figures/prefs-gen.png \
-     figures/prefs-guess.png \
-     figures/prefs-ids.png \
-     figures/prefs-main.png \
-     figures/prefs-media.png \
-     figures/prefs-report.png \
-     figures/prefs-research.png \
-     figures/prefs-revision.png \
-     figures/reportsel.png \
-     figures/revcontrol.png \
-     figures/savecomment.png \
-     figures/sourcelist.png \
-     figures/sourcerefsel.png \
-     figures/toolsel.png
-
 docname = gramps-manual
 lang = C
 omffile = gramps-manual-C.omf
-sgml_ents = 
+entities = legal.xml 
-include $(top_srcdir)/doc/sgmldocs.make
+include $(top_srcdir)/doc/xmldocs.make
 dist-hook: app-dist-hook

gramps2/doc/gramps-manual/C/gramps-manual-C.omf

@@ -1,14 +1,18 @@
-<?xml version="1.0" standalone="no"?>
+<?xml version="1.0" encoding="UTF-8"?>
 <omf>
   <resource>
-    <title>
+    <creator>Alex Roitman shura@alex.neuro.umn.edu</creator>
-      GRAMPS User Manual
+    <title>GRAMPS Manual</title>
-    </title>
+    <date>2003-03-25</date>
-    <subject>
+    <version identifier="2.0" date="2003-03-25" description="GNOME2 Compliant GRAMPS Manual"/>
-      <category>GNOME|Applications</category>
+    <subject category="GNOME|Applications"/>
-    </subject>
+    <description>User Manual for GRAMPS.</description>
-    <format mime="text/sgml"/>
+    <type>User Manual</type>
-    <identifier url="gramps-manual.sgml"/>
+    <format mime="text/xml" dtd="-//OASIS//DTD DocBook XML V4.1.2//EN"/>
+    <identifier url=""/>
     <language code="C"/>
+    <relation seriesid="aa15a444-5ed9-11d7-8329-d7319c90009c"/>
+    <rights type="GNU FDL" license.version="1.1" license="http://www.gnu.org/licenses/fdl.html" holder="Alex Roitman"/>
   </resource>
 </omf>
+								  

gramps2/doc/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 $(srcdir)/$$file.out; \
+	done
+	touch omf_timestamp
+
+install-data-hook-omf:
+	$(mkinstalldirs) $(DESTDIR)$(omf_dest_dir)
+	for file in $(omffile); do \
+		$(INSTALL_DATA) $(srcdir)/$$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)

gramps2/doc/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)/doc/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)/help/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)
+
+# **************  You should not have to edit below this line  *******************
+xml_files = $(entities) $(docname).xml
+omf_dir=$(top_srcdir)/omf-install
+
+EXTRA_DIST = $(xml_files) $(omffile)
+CLEANFILES = omf_timestamp
+
+include $(top_srcdir)/doc/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)
+

gramps2/gramps.spec.in

@@ -20,7 +20,7 @@ Requires: gnome-python2-canvas >= 1.99
 Requires: pygtk2 >= 1.99
 Requires: pygtk2-libglade >= 1.99
 
-BuildRequires: scrollkeeper >= 0.1.4
+BuildRequires: scrollkeeper >= @SCROLLKEEPER_BUILD_REQUIRED@
 BuildRequires: automake >= 1.6
 BuildRequires: autoconf >= 2.52
 
@@ -53,12 +53,11 @@ rm -rf $RPM_BUILD_ROOT
 %files
 %defattr(-, root, root)
 
-%doc README COPYING TODO INSTALL
+%doc README COPYING TODO INSTALL COPYING-DOCS
 
 %{prefix}/bin/gramps
 
 %{_datadir}/gnome/help/gramps-manual/C/*
-%{_datadir}/gnome/help/extending-gramps/C/*
 
 %{_datadir}/gnome/apps/Applications/gramps.desktop
 %{_datadir}/pixmaps/gramps.png
@@ -87,6 +86,14 @@ rm -rf $RPM_BUILD_ROOT
 
 %{_datadir}/omf/gramps
 
+%post
+if which scrollkeeper-update>/dev/null 2>&1; then scrollkeeper-update -q -o %{_datadir}/omf/gramps; fi
+
+%postun
+if which scrollkeeper-update>/dev/null 2>&1; then scrollkeeper-update -q; fi
+ 
 %changelog
+* Mon Mar 24 2003 Alex Roitman <shura@alex.neuro.umn.edu>
+- update scrollkeeper dependencies and add post and postun to enable install on a machine without scrollkeeper
 * Fri Jun 14 2002 Donald Peterson <dpeterso@engr.ors.edu>
 - add scrollkeeper dependencies and some file cleanup