Read Me

# $Id: README,v 1.23 2014/04/11 20:13:56 braml Exp $

The contents of this file is moving to the doc/xpt.xml file.

** State of the project
 The this is an initial version of the program to demonstrate it's more than
 just an idea. It is far from ideal but I'd like to get the code out and get
 some response.

 * can load a perl interpreter, load module, module functions can return
   undef, strings and XML::LIBXML::Node objects, arguments can be passed.
 * can load a python interpreter, load module, module functions can return
   nil and strings, arguments can passed. LIBXML node objects are not yet
   supported.
 * status
   * Freebsd 8.[02]
	perl		compile, problems passing LibXML2 nodes
	python		compile, pass LibXML2 nodes
	java		compile
	xslt		compile
	pcre		compile
	notes:
	+ need gmake
   	+ java: openjdk6
	***>> freebsd 8.2: pkg_add -vr autotools gmake python pcre libxslt libxml2
   * Ubuntu 10.10
	perl		compile, problems passing LibXML2 nodes
	python		compile, pass LibXML2 nodes
	java		
	xslt		compile
	pcre		compile
	notes:
   	+ java: openjdk6
   * Mac OS X 10.5
	perl		compile, problems passing LibXML2 nodes
	python		compile, pass LibXML2 nodes
	java		no support
	xslt		compile
	pcre		compile
	notes:
   	+ java: java 1.5
	+ pcre was build locally
   * Windows XP
	perl		compile, problems passing LibXML2 nodes
	python		compile, pass LibXML2 nodes
	java		no support
	xslt		compile
	pcre		compile
	notes:
	+ using CygWin
 * is in desperate need of documentation
   * functionality
   * build environment, build-time dependencies
	gmake (freebsd-8.2 >=3.81)
	sources for p5-XML-LibXML-1.70 (http://search.cpan.org/dist/XML-LibXML/)
		wget http://search.cpan.org/CPAN/authors/id/P/PA/PAJAS/XML-LibXML-1.70.tar.gz
		p5-XML-LibXML (>=1.70)
	libxml2 (freebsd-8.2 >=2.7.7)
	libxml2-dev (ubuntu-10.10 >=2.7.7)
	libxslt1-dev
	pcre (freebsd-8.2 >=8.10)
	perl (freebsd-8.2 >=5.10.1)
	libpcre3-dev
	libperl-dev (ubuntu >=5.10.1)
	python26 (freebsd-8.2 >=2.6.5_1)
	libxslt (freebsd-8.2 >=1.1.26_2)
	openjdk6 (freebsd-8.2 >=openjdk6-b20_7)
     build without certain interpreters, eg. without Python.
   * runtime environment, runtime dependencies
   * development
     - python debugging: use winpdb to
	import rpdb2
	rpdb2.start_embedded_debugger_interactive_password()
	rpdb2.start_embedded_debugger("aap123")
     - dependency checking:
	ubuntu/debian:
		dpkg-query -l | grep -i libxslt
		dpkg-query -L libxslt1.1
 * TODO's
   * extensive testset.
   * the testset could be used as part of the documentation: showcase
     of functionality.
   * documention.....
   * NOTE: some OSes need LD_LIBRARY_PATH to find the Java VM

** Any comment and ideas are welcome. Drop me an mail. My address can be found
 at http://sourceforge.net/projects/xml-xpt

** Pointers, things to remember

    xproc
	http://www.w3.org/TR/xproc/: XProc: An XML Pipeline Language
	W3C xproc: http://xproc.org/
	http://www.ibm.com/developerworks/library/x-xproc/
    docbook
    other
	http://www.ibm.com/developerworks/library/xml-perl/
		"XML and scripting languages - Manipulating XML documents with Perl and other scripting languages"
	XML::Parser - A perl module for parsing XML documents
    xmlstarlet

    AutoDOC (https://github.com/homalg-project/AutoDoc)
    GAPDoc (http://www.gap-system.org/Packages/gapdoc.html)
    build farms:
    * Ubuntu lauchpad, see https://launchpad.net/xml-xpt
    * OpenSuse Build Service: http://en.opensuse.org/Build_Service
    * FreeBSD PointyHat

###### Tips & Tricks
Fop: CALS tables with FOP: "SEVERE: Invalid property value encountered in column-width="proportional-column-width(1)": org.apache.fop.fo.expr.PropertyException"
	in .fo .xsl file: <xsl:param name="fop1.extensions" select="'1'"/>
	See: https://lists.oasis-open.org/archives/docbook-apps/201110/msg00080.html
	  (http://www.sagehill.net/docbookxsl/InstallingAnFO.html)

#		-=(O)=- End of File -=(O)=-