[gimp-help-2] [make] Minor changes for building HTML packages

[Ulf-D. Ehlert <ulfehlert src gnome org>]

commit 3f34892f431a937e0d0b14e3ee8be8d2f810020c
Author: Ulf-D. Ehlert <ulfehlert svn gnome org>
Date:   Mon Jun 28 19:00:17 2010 +0200

    [make] Minor changes for building HTML packages
    
    * Add missing option in INSTALL example (copy folder recursively).
    * Additional info in README and INSTALL.
    * Move current INSTALL to make.d subdirectory: this file does not
      make any sense outside an HTML package.
    * Minor changes in HTML package Makefile.

 Makefile.GNU                           |    1 +
 Makefile.am                            |    3 ++-
 README                                 |    9 ++++++++-
 INSTALL => make.d/INSTALL.html-package |   18 +++++++++++++++++-
 make.d/Makefile.html-package           |    7 ++++---
 5 files changed, 32 insertions(+), 6 deletions(-)
---
diff --git a/Makefile.GNU b/Makefile.GNU
index b323cb3..28f17f5 100644
--- a/Makefile.GNU
+++ b/Makefile.GNU
@@ -809,6 +809,7 @@ $(tarball_prefix)-%.tar: html/%/index.html html/%/gimp-help.xml \
 	$(cmd) $(mkdir_p) $(tarball_dir)/html
 	$(cmd) cd $(tarball_dir)/html && $(ln_s) ../../html/$* .
 	$(cmd) cp $(HTMLMETAFILES) $(tarball_dir)/
+	$(cmd) cp make.d/INSTALL.html-package $(tarball_dir)/INSTALL
 	$(cmd) $(SED) -e '/LANGUAGE *=/s/en/$*/' \
 		make.d/Makefile.html-package > $(tarball_dir)/Makefile
 	$(cmd) tar -chf $@ $(tarball_dir)/
diff --git a/Makefile.am b/Makefile.am
index b32d556..7b83db1 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -859,7 +859,7 @@ endif
 
 tarball_prefix = gimp-help-2-html
 tarball_dir    = gimp-help-2
-HTMLMETAFILES  = README AUTHORS COPYING MAINTAINERS HACKING INSTALL
+HTMLMETAFILES  = README AUTHORS COPYING MAINTAINERS
 
 $(tarball_prefix)-%.tar: html/%/index.html html/%/gimp-help.xml \
 		$(HTMLMETAFILES) make.d/Makefile.html-package
@@ -868,6 +868,7 @@ $(tarball_prefix)-%.tar: html/%/index.html html/%/gimp-help.xml \
 	$(cmd) $(MKDIR_P) $(tarball_dir)/html
 	$(cmd) cd $(tarball_dir)/html && $(LN_S) ../../html/$* .
 	$(cmd) cp $(HTMLMETAFILES) $(tarball_dir)/
+	$(cmd) cp make.d/INSTALL.html-package $(tarball_dir)/INSTALL
 	$(cmd) $(SED) -e '/LANGUAGE *=/s/en/$*/' \
 		make.d/Makefile.html-package > $(tarball_dir)/Makefile
 	$(cmd) tar -chf $@ $(tarball_dir)/
diff --git a/README b/README
index 405c03b..c63f356 100644
--- a/README
+++ b/README
@@ -56,7 +56,14 @@ to date information of the current GIMP development.
     make src/of/the/xml-file.draft
 
   where the target is the path name with extension ".draft" instead
-  of ".xml".
+  of ".xml", or with
+
+    make preview-src/of/the/xml-file.xml
+
+  where the path name is preceded with "preview-".
+
+  The name of the HMTL draft file depends on its id (not on the name
+  of the XML source file!) and is displayed when the file is created.
 
 
   Hints for making good screenshots
diff --git a/INSTALL b/make.d/INSTALL.html-package
similarity index 65%
rename from INSTALL
rename to make.d/INSTALL.html-package
index 4037e90..1f67ea0 100644
--- a/INSTALL
+++ b/make.d/INSTALL.html-package
@@ -18,7 +18,7 @@ structure:
 Depending for which language you downloaded the installation package,
 you need to copy the html folder to the shared GIMP directory:
 
-    $ cp html/en $prefix/share/gimp/2.0/help/
+    $ cp -R html/en $prefix/share/gimp/2.0/help/
     $ ls $prefix/share/gimp/2.0/help
     en
     $ ls $prefix/share/gimp/2.0/help/en
@@ -29,5 +29,21 @@ you need to copy the html folder to the shared GIMP directory:
 If the help directory in $prefix/share/gimp/2.0/ doesn't exist, create
 it.
 
+Tip:
+
+There is a basic (special-purpose) Makefile shipped with this HTML
+package for simplifying the installation procedure, e.g.:
+
+    $ make install    # copy the html folder to the correct location
+or
+    $ make install DESTDIR=$RPM_BUILD_ROOT    # for packagers
+or
+    $ make install GIMPDATADIR=/opt/myprogs/gimp/2.0
+
+A short help text is displayed with
+
+    $ make help
+
+
 -- The GIMP-Help team.
 
diff --git a/make.d/Makefile.html-package b/make.d/Makefile.html-package
index ba076f3..9e19f77 100644
--- a/make.d/Makefile.html-package
+++ b/make.d/Makefile.html-package
@@ -10,10 +10,11 @@ remove      = rm -rf
 
 .PHONY: help
 help:
-	@echo "Type 'make install' to install the HTML files for "
-	@echo "language '$(LANGUAGE)' to \$$DESTDIR$(GIMPDATADIR)/help/$(LANGUAGE))."
+	@echo "Type 'make install [DESTDIR=path] [GIMPDATADIR=path]'"
+	@echo "to install the HTML files for language '$(LANGUAGE)' to"
+	@echo "    \$$DESTDIR$(GIMPDATADIR)/help/$(LANGUAGE)."
 	@echo
-	@echo "Controlling (environment) variables:"
+	@echo "Controlling variables:"
 	@echo "    GIMPDATADIR:  $(GIMPDATADIR)"
 	@echo "    DESTDIR:      $(DESTDIR)"
 	@test -d $(GIMPDATADIR) || \