[Po4a-commits] "po4a/share ChangeLog, 1.1, 1.2 README, NONE, 1.1 po4a-build, 1.1, 1.2 po4a-build.conf, NONE, 1.1 po4a-build.conf.example, NONE, 1.1"

Neil Williams codehelp at alioth.debian.org
Fri Nov 6 22:37:41 UTC 2009 

Update of /cvsroot/po4a/po4a/share
In directory alioth:/tmp/cvs-serv28295

Modified Files:
	ChangeLog po4a-build 
Added Files:
	README po4a-build.conf po4a-build.conf.example 
Log Message:
	* README: trying to describe what I'm seeking here.
	* doc/po4a-build.xml: Prototype manpage for po4a-build
	* doc/po4a.config: po4a-build config file for it's own
	manpage translation, in due course.
	* po/.cvsignore: Ignore the POT
	* po4a-build: Switch to po4a-build as the script name and
	po4a-build.conf as the config file name. Comment out
	"debianism" of looking for debian/changelog.
	* po4a-build.conf: Internal conf file for eventual manpage
	generation and translation.
	* po4a-build.conf.example: SCRIPTS= unsupported - better done
	using the Makefile snippets, see README.



--- NEW FILE: po4a-build.conf.example ---
# po4a-build.conf configuration file
# Any empty values can be omitted.
#
# name and location of the config file
CONFIG="doc/po4a.config"
# PODIR po directory for manpages/docs
PODIR="doc/po"
# POTFILE path
POTFILE="doc/po/package.pot"
# base directory for generated files, e.g. doc
BASEDIR="doc"
# the binary packages that will contain generated manpages
BINARIES="package"
# the binary packages with manpages in Section 3.
HASMAN3=""
# the binary packages using DocBook XML & xsltproc
XMLPACKAGES="package"
# the DocBook XML files (TODO: let this take paths)
XMLFILE="overview.xml HOWTO.xml"
# the pattern to find the XML files
XMLDIR="doc"
# the pattern to find the .docbook files
DOCBOOKDIR=""
# the POD files (TODO: let this take paths)
PODFILE=""
# the binary packages using POD
PODPACKAGES=""
# html output (subdirectory of BASEDIR)
HTMLDIR="html"
# html DocBook file
HTMLFILE="HOWTO.xml"

--- NEW FILE: po4a-build.conf ---
# po4a-build.conf configuration file
# Any empty values can be omitted.
#
# name and location of the config file
CONFIG="doc/po4a.config"
# PODIR po directory for manpages/docs
PODIR="doc/po"
# POTFILE path
POTFILE="doc/po/po4a-build.pot"
# base directory for generated files, e.g. doc
BASEDIR="doc"
# the binary packages that will contain generated manpages
BINARIES="po4a"
# the binary packages with manpages in Section 3.
HASMAN3=""
# the binary packages using DocBook XML & xsltproc
XMLPACKAGES="po4a"
# the DocBook XML files (TODO: let this take paths)
XMLFILE="po4a-build.xml"
# the pattern to find the XML files
XMLDIR="doc"
# the pattern to find the .docbook files
DOCBOOKDIR=""
# the POD files (TODO: let this take paths)
PODFILE=""
# the binary packages using POD
PODPACKAGES=""
# html output (subdirectory of BASEDIR)
HTMLDIR=""
# html DocBook file
HTMLFILE=""

Index: ChangeLog
===================================================================
RCS file: /cvsroot/po4a/po4a/share/ChangeLog,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- ChangeLog	6 Nov 2009 22:07:08 -0000	1.1
+++ ChangeLog	6 Nov 2009 22:37:39 -0000	1.2
@@ -1,5 +1,20 @@
 2009-11-06  Neil Williams  <linux at codehelp.co.uk>
 
+	* README: trying to describe what I'm seeking here.
+	* doc/po4a-build.xml: Prototype manpage for po4a-build
+	* doc/po4a.config: po4a-build config file for it's own
+	manpage translation, in due course.
+	* po/.cvsignore: Ignore the POT
+	* po4a-build: Switch to po4a-build as the script name and
+	po4a-build.conf as the config file name. Comment out
+	"debianism" of looking for debian/changelog.
+	* po4a-build.conf: Internal conf file for eventual manpage
+	generation and translation.
+	* po4a-build.conf.example: SCRIPTS= unsupported - better done
+	using the Makefile snippets, see README.
+
+2009-11-06  Neil Williams  <linux at codehelp.co.uk>
+
 	* Makevars-perl.example: Example for perl packages.
 	* Makevars-shell.example: Example for shell packages.
 	* po/Makefile: Copy of po4a-build.make for our translations.

--- NEW FILE: README ---
			po4a-build - one-stop translation
			=================================

po4a allows translations to be merged into the source documents for
the generation of translated content but does not then go on to prepare
the translated output documents - typically the XML is translated but
no translated manpage is built.

The main reason is that the system to prepare that translated manpage
can be build-specific.

po4a-build is an attempt to provide a one-stop method for building both
translated and untranslated content *and* putting that content into the
final installation locations in a simple and flexible manner.

There is a lot to do to let po4a-build fit in with po4a itself more
easily. Currently, po4a-build is used as 'genmanpages' in two Debian
packages (svn-buildpackage and emdebian-rootfs) but some changes may
be needed to fit with a wider range of uses, particularly upstream rather
than native packages.

For now, the po4a-build manpage can be created just by running
po4a-build in this directory. The reliance on 'debian/changelog' is,
obviously, an inheritance from the 'genmanpages' script used in Debian
packages that formed the basis for po4a-build. In time, a better check
may be needed or po4a-build might become sufficiently intelligent that
it can work out what it needs to do.

Other files
===========

Packages wanting to use po4a-build often are not using autotools but
may be using just make. po4a-build has example files that can support
adding program output translation and these files can be made available
via po4a. Files include a Makefile suitable for use in the top level
po/ directory, to build, maintain and install translations of the
files described in po/POTFILES.in using variables defined in the
Makevars file, of which po4a-build provides two examples. (More to be
added, as necessary.)

Index: po4a-build
===================================================================
RCS file: /cvsroot/po4a/po4a/share/po4a-build,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- po4a-build	6 Nov 2009 22:07:08 -0000	1.1
+++ po4a-build	6 Nov 2009 22:37:39 -0000	1.2
@@ -67,8 +67,8 @@
 
 # below this point, no changes should be needed.
 
-# use a default manpages.cnf in the current directory.
-FILE="manpages.conf"
+# use a default po4a-build.cnf in the current directory.
+FILE="po4a-build.conf"
 
 wrap_langs () {
 	if [ -z "$LANGS" ]; then
@@ -81,17 +81,17 @@
 usagehelp () {
 	# print out help message
 	eval_gettext "
-genmanpages - po4a frontend
+po4a-build - po4a frontend
 
-Syntax: genmanpages
-        genmanpages --pot-only
+Syntax: po4a-build
+        po4a-build --pot-only
 
 Commands:
 -?|-h|--help|-version:      print this help message and exit
 --pot-only:                 only create the POT file
 
 Options:
--f|--file FILE:             manpages.conf config file path
+-f|--file FILE:             po4a-build.conf config file path
 
 "; echo
 }
@@ -119,10 +119,11 @@
 esac
 done
 
-if [ ! -f "debian/changelog" ]; then
-	eval_gettext "genmanpages started from the wrong directory."; echo
-	exit 2
-fi
+#if [ ! -f "debian/changelog" ]; then
+#	eval_gettext "po4a-build started from the wrong directory."; echo
+#	# FIXME: reinstate a test like this, once testing improves.
+#	exit 2
+#fi
 
 if [ ! -f "$FILE" ]; then
 	# without config, there's nothing to do.

More information about the Po4a-commits mailing list