aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorKeiron Liddle <keiron@apache.org>2001-09-24 08:51:17 +0000
committerKeiron Liddle <keiron@apache.org>2001-09-24 08:51:17 +0000
commit5a9662ed5c350df04d0089c0b9fbba5354b4c772 (patch)
tree81340f4c4ca8845daf0808fb7198a808dffd2e1a /docs
parentc035335895585f1aceb6ce01d05659d954c658b9 (diff)
downloadxmlgraphics-fop-5a9662ed5c350df04d0089c0b9fbba5354b4c772.tar.gz
xmlgraphics-fop-5a9662ed5c350df04d0089c0b9fbba5354b4c772.zip
this patch alters the fop ant task so that other render output
formats are supported output type can be specified by mime type and also handles file sets Submitted by: Jeremias Maerki <jeremias.maerki@outline.ch> git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@194479 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'docs')
-rw-r--r--docs/design/build.xml99
-rw-r--r--docs/examples/build.xml244
-rw-r--r--docs/xml-docs/build.xml96
3 files changed, 203 insertions, 236 deletions
diff --git a/docs/design/build.xml b/docs/design/build.xml
index ad17b53b9..e6e2ecdcd 100644
--- a/docs/design/build.xml
+++ b/docs/design/build.xml
@@ -1,73 +1,58 @@
<?xml version="1.0"?>
-
<!-- ======================================================================= -->
<!-- JBoss documentation build file -->
<!-- ======================================================================= -->
-
<project name="FOPDocs" default="docs" basedir="./">
- <target name="init">
+ <target name="init">
<property name="Name" value="FOPDocs"/>
<property name="name" value="fopdocs"/>
<property name="version" value="0.1"/>
-
<property name="lib.dir" value="${basedir}/lib"/>
-
- <taskdef name="xslt" classname="org.apache.fop.tools.anttasks.Xslt"/>
- <taskdef name="fop" classname="org.apache.fop.tools.anttasks.Fop"/>
- </target>
-
- <!-- =================================================================== -->
- <!-- Generate a help screen -->
- <!-- =================================================================== -->
- <target name="help" depends="init">
-
- <echo message="${name}-${version} build file, available targets:" />
- <echo message="------------------------------------------------------------" />
- <echo message="main : Compile and prepare deployment directory. " />
- <echo message="pdf : Compile and prepare pdf user docs. "/>
- <echo message="clean : Clean deployment and distribution. " />
- <echo message="------------------------------------------------------------" />
- <echo message=" USAGE: build &lt;target&gt; " />
-
- </target>
-
- <!-- =================================================================== -->
- <!-- Prepares the build directory -->
- <!-- =================================================================== -->
- <target name="prepare" depends="init">
- </target>
-
- <!-- =================================================================== -->
- <!-- Generates the pdf documentation -->
- <!-- =================================================================== -->
- <target name="pdf" depends="prepare">
- <echo message="Building pdf documentation. Please wait ..."/>
- <delete file="fop.fo"/>
- <xslt infile="fop.xml" xsltfile="docbook/fo/docbook.xsl"
- dependent="fop.xml"
- outfile="fop.fo" smart="yes"/>
-<!--
+ <taskdef name="xslt" classname="org.apache.fop.tools.anttasks.Xslt"/>
+ <taskdef name="fop" classname="org.apache.fop.tools.anttasks.Fop"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Generate a help screen -->
+ <!-- =================================================================== -->
+ <target name="help" depends="init">
+ <echo message="${name}-${version} build file, available targets:"/>
+ <echo message="------------------------------------------------------------"/>
+ <echo message="main : Compile and prepare deployment directory. "/>
+ <echo message="pdf : Compile and prepare pdf user docs. "/>
+ <echo message="clean : Clean deployment and distribution. "/>
+ <echo message="------------------------------------------------------------"/>
+ <echo message=" USAGE: build &lt;target&gt; "/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Prepares the build directory -->
+ <!-- =================================================================== -->
+ <target name="prepare" depends="init"/>
+ <!-- =================================================================== -->
+ <!-- Generates the pdf documentation -->
+ <!-- =================================================================== -->
+ <target name="pdf" depends="prepare">
+ <echo message="Building pdf documentation. Please wait ..."/>
+ <delete file="fop.fo"/>
+ <xslt infile="fop.xml" xsltfile="docbook/fo/docbook.xsl" dependent="fop.xml" outfile="fop.fo" smart="yes"/>
+ <!--
<style basedir="./"
destdir="./"
style="docbook/fo/docbook.xsl"
extension=".fo"
includes="fop.xml"/>
-->
- <fop fofile="fop.fo" pdffile="fop.pdf"/>
-<!-- <delete file="fop.fo"/>-->
- </target>
-
- <!-- =================================================================== -->
- <!-- Generates pdf and html documentation -->
- <!-- =================================================================== -->
- <target name="docs" depends="pdf"/>
-
- <!-- =================================================================== -->
- <!-- Cleans up generated stuff -->
- <!-- =================================================================== -->
- <target name="clean" depends="init">
- <delete file="fop.fo"/>
- <delete file="fop.pdf"/>
- </target>
+ <fop fofile="fop.fo" outfile="fop.pdf"/>
+ <!-- <delete file="fop.fo"/>-->
+ </target>
+ <!-- =================================================================== -->
+ <!-- Generates pdf and html documentation -->
+ <!-- =================================================================== -->
+ <target name="docs" depends="pdf"/>
+ <!-- =================================================================== -->
+ <!-- Cleans up generated stuff -->
+ <!-- =================================================================== -->
+ <target name="clean" depends="init">
+ <delete file="fop.fo"/>
+ <delete file="fop.pdf"/>
+ </target>
</project>
-
diff --git a/docs/examples/build.xml b/docs/examples/build.xml
index 0d60e65a5..e59f953ce 100644
--- a/docs/examples/build.xml
+++ b/docs/examples/build.xml
@@ -1,126 +1,126 @@
<?xml version="1.0"?>
-
<!-- =========================================================================== -->
-
-<project default="creating new test pdf files" basedir=".">
-
- <!-- =================================================================== -->
- <!-- Initialization target -->
- <!-- =================================================================== -->
- <target name="init">
- <tstamp/>
- <mkdir dir="tests"/>
- <property name="referenceDir" value="reference"/>
- <property name="testDir" value="tests"/>
- <property name="foDir" value="fo"/>
- <taskdef name="fop" classname="org.apache.fop.tools.anttasks.Fop"/>
- <taskdef name="compare" classname="org.apache.fop.tools.anttasks.Compare"/>
-
-
- </target>
-
- <!-- =================================================================== -->
- <!-- Help on usage -->
- <!-- =================================================================== -->
- <target name="usage">
- <echo message=""/>
- <echo message=""/>
- <echo message="USAGE of runtests"/>
- <echo message="-------------------------------------------------------------"/>
- <echo message=""/>
- <echo message=" available targets are:"/>
- <echo message=""/>
- <echo message=" compare --> generates new pdf test files and compares them to reference files (default)"/>
- <echo message=" reference --> generates new reference pdf files"/>
- <echo message=" See the comments inside the build.xml file for more details."/>
- <echo message="-------------------------------------------------------------"/>
- <echo message=""/>
- <echo message=""/>
- </target>
-
- <!-- =================================================================== -->
- <!-- Produces new test pdf files -->
- <!-- =================================================================== -->
- <target name="creating new test pdf files" depends="init">
- <fop fofile="${foDir}/normal.fo" pdffile="${testDir}/normal.pdf"/>
- <fop fofile="${foDir}/table.fo" pdffile="${testDir}/table.pdf"/>
- <fop fofile="${foDir}/list.fo" pdffile="${testDir}/list.pdf"/>
- <fop fofile="${foDir}/link.fo" pdffile="${testDir}/link.pdf"/>
- <fop fofile="${foDir}/newlinktest.fo" pdffile="${testDir}/newlinktest.pdf"/>
- <fop fofile="${foDir}/border.fo" pdffile="${testDir}/border.pdf"/>
- <fop fofile="${foDir}/extensive.fo" pdffile="${testDir}/extensive.pdf"/>
- <fop fofile="${foDir}/images.fo" pdffile="${testDir}/images.pdf"/>
- <fop fofile="${foDir}/readme.fo" pdffile="${testDir}/readme.pdf"/>
- <fop fofile="${foDir}/fonts.fo" pdffile="${testDir}/fonts.pdf"/>
- <fop fofile="${foDir}/leader.fo" pdffile="${testDir}/leader.pdf"/>
- <fop fofile="${foDir}/textdeko.fo" pdffile="${testDir}/textdeko.pdf"/>
- <fop fofile="${foDir}/inhprop.fo" pdffile="${testDir}/inhprop.pdf"/>
- <fop fofile="${foDir}/normalex.fo" pdffile="${testDir}/normalex.pdf"/>
- <fop fofile="${foDir}/simple.fo" pdffile="${testDir}/simple.pdf"/>
- <!-- <fop fofile="${foDir}/hyphen.fo" pdffile="${testDir}/hyphen.pdf"/> -->
- <fop fofile="${foDir}/character.fo" pdffile="${testDir}/character.pdf"/>
- <fop fofile="${foDir}/pdfoutline.fo" pdffile="${testDir}/pdfoutline.pdf"/>
- <fop fofile="${foDir}/corresprop.fo" pdffile="${testDir}/corresprop.pdf"/>
- <fop fofile="${foDir}/bordershorthand.fo" pdffile="${testDir}/bordershorthand.pdf"/>
- </target>
-
-
- <target name="image" depends="init">
- <fop fofile="${foDir}/images.fo" pdffile="${testDir}/images.pdf"/>
- </target>
-
- <!-- =================================================================== -->
- <!-- Compares new test pdf files to reference pdf files -->
- <!-- =================================================================== -->
- <target name="compare" depends ="creating new test pdf files">
- <compare referenceDirectory = "${referenceDir}"
- testDirectory = "${testDir}"
- filenames = "normal.pdf,table.pdf,list.pdf,link.pdf,border.pdf,images.pdf,extensive.pdf,readme.pdf,fonts.pdf,list2.pdf"/>
- </target>
-
- <!-- =================================================================== -->
- <!-- Produces new reference pdf files -->
- <!-- =================================================================== -->
- <target name="reference">
- <fop fofile="${foDir}/normal.fo" pdffile="${referenceDir}/normal.pdf"/>
- <fop fofile="${foDir}/table.fo" pdffile="${referenceDir}/table.pdf"/>
- <fop fofile="${foDir}/list.fo" pdffile="${referenceDir}/list.pdf"/>
- <fop fofile="${foDir}/link.fo" pdffile="${referenceDir}/link.pdf"/>
- <fop fofile="${foDir}/newlinktest.fo" pdffile="${referenceDir}/newlinktest.pdf"/>
- <fop fofile="${foDir}/border.fo" pdffile="${referenceDir}/border.pdf"/>
- <fop fofile="${foDir}/extensive.fo" pdffile="${referenceDir}/extensive.pdf"/>
- <fop fofile="${foDir}/images.fo" pdffile="${referenceDir}/images.pdf"/>
- <fop fofile="${foDir}/readme.fo" pdffile="${referenceDir}/readme.pdf"/>
- <fop fofile="${foDir}/fonts.fo" pdffile="${referenceDir}/fonts.pdf"/>
- <fop fofile="${foDir}/leader.fo" pdffile="${referenceDir}/leader.pdf"/>
- <fop fofile="${foDir}/textdeko.fo" pdffile="${referenceDir}/textdeko.pdf"/>
- <fop fofile="${foDir}/inhprop.fo" pdffile="${referenceDir}/inhprop.pdf"/>
- <fop fofile="${foDir}/normalex.fo" pdffile="${referenceDir}/normalex.pdf"/>
- <fop fofile="${foDir}/simple.fo" pdffile="${referenceDir}/simple.pdf"/>
- <!-- <fop fofile="${foDir}/hyphen.fo" pdffile="${referenceDir}/hyphen.pdf"/> -->
- <fop fofile="${foDir}/character.fo" pdffile="${referenceDir}/character.pdf"/>
-
- </target>
-
-
-
-
- <!-- =================================================================== -->
- <!-- Starts the test -->
- <!-- =================================================================== -->
- <target name="runtest" depends="compare">
- <echo message="Running Fop tests"/>
- </target>
-
- <!-- =================================================================== -->
- <!-- Clean targets -->
- <!-- =================================================================== -->
- <target name="clean" depends="init">
- <delete dir="${testDir}"/>
-
- </target>
-
-
+<project default="newPDF" basedir=".">
+ <!-- =================================================================== -->
+ <!-- Initialization target -->
+ <!-- =================================================================== -->
+ <target name="init">
+ <tstamp/>
+ <mkdir dir="tests"/>
+ <property name="referenceDir" value="reference"/>
+ <property name="testDir" value="tests"/>
+ <property name="foDir" value="fo"/>
+ <taskdef name="fop" classname="org.apache.fop.tools.anttasks.Fop"/>
+ <taskdef name="compare" classname="org.apache.fop.tools.anttasks.Compare"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Help on usage -->
+ <!-- =================================================================== -->
+ <target name="usage">
+ <echo message=""/>
+ <echo message=""/>
+ <echo message="USAGE of runtests"/>
+ <echo message="-------------------------------------------------------------"/>
+ <echo message=""/>
+ <echo message=" available targets are:"/>
+ <echo message=""/>
+ <echo message=" newPDF --> generates new PDF test files (default)"/>
+ <echo message=" newPS --> generates new PostScript test files"/>
+ <echo message=" newAT --> generates new AreaTree (XML) test files"/>
+ <echo message=" comparePDF --> generates new PDF test files and compares them to reference files"/>
+ <echo message=" referencePDF --> generates new reference PDF files"/>
+ <echo message=" See the comments inside the build.xml file for more details."/>
+ <echo message="-------------------------------------------------------------"/>
+ <echo message=""/>
+ <echo message=""/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Produces new test pdf files -->
+ <!-- =================================================================== -->
+ <target name="newPDF" depends="init">
+ <fop fofile="${foDir}/normal.fo" outfile="${testDir}/normal.pdf"/>
+ <fop fofile="${foDir}/table.fo" outfile="${testDir}/table.pdf"/>
+ <fop fofile="${foDir}/list.fo" outfile="${testDir}/list.pdf"/>
+ <fop fofile="${foDir}/link.fo" outfile="${testDir}/link.pdf"/>
+ <fop fofile="${foDir}/newlinktest.fo" outfile="${testDir}/newlinktest.pdf"/>
+ <fop fofile="${foDir}/border.fo" outfile="${testDir}/border.pdf"/>
+ <fop fofile="${foDir}/extensive.fo" outfile="${testDir}/extensive.pdf"/>
+ <fop fofile="${foDir}/images.fo" outfile="${testDir}/images.pdf"/>
+ <fop fofile="${foDir}/readme.fo" outfile="${testDir}/readme.pdf"/>
+ <fop fofile="${foDir}/fonts.fo" outfile="${testDir}/fonts.pdf"/>
+ <fop fofile="${foDir}/leader.fo" outfile="${testDir}/leader.pdf"/>
+ <fop fofile="${foDir}/textdeko.fo" outfile="${testDir}/textdeko.pdf"/>
+ <fop fofile="${foDir}/inhprop.fo" outfile="${testDir}/inhprop.pdf"/>
+ <fop fofile="${foDir}/normalex.fo" outfile="${testDir}/normalex.pdf"/>
+ <fop fofile="${foDir}/simple.fo" outfile="${testDir}/simple.pdf"/>
+ <!-- <fop fofile="${foDir}/hyphen.fo" outfile="${testDir}/hyphen.pdf"/> -->
+ <fop fofile="${foDir}/character.fo" outfile="${testDir}/character.pdf"/>
+ <fop fofile="${foDir}/pdfoutline.fo" outfile="${testDir}/pdfoutline.pdf"/>
+ <fop fofile="${foDir}/corresprop.fo" outfile="${testDir}/corresprop.pdf"/>
+ <fop fofile="${foDir}/bordershorthand.fo" outfile="${testDir}/bordershorthand.pdf"/>
+ </target>
+ <target name="image" depends="init">
+ <fop fofile="${foDir}/images.fo" outfile="${testDir}/images.pdf"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Produces new test ps files -->
+ <!-- =================================================================== -->
+ <target name="newPS" depends="init">
+ <fop format="application/postscript" outdir="${testDir}">
+ <fileset dir="${foDir}">
+ <include name="**/*.fo"/>
+ </fileset>
+ </fop>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Produces new test areatree files -->
+ <!-- =================================================================== -->
+ <target name="newAT" depends="init">
+ <fop format="text/xml" outdir="${testDir}">
+ <fileset dir="${foDir}">
+ <include name="**/*.fo"/>
+ </fileset>
+ </fop>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Compares new test pdf files to reference pdf files -->
+ <!-- =================================================================== -->
+ <target name="comparePDF" depends="newPDF">
+ <compare referenceDirectory="${referenceDir}" testDirectory="${testDir}" filenames="normal.pdf,table.pdf,list.pdf,link.pdf,border.pdf,images.pdf,extensive.pdf,readme.pdf,fonts.pdf,list2.pdf"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Produces new reference pdf files -->
+ <!-- =================================================================== -->
+ <target name="referencePDF">
+ <fop fofile="${foDir}/normal.fo" outfile="${referenceDir}/normal.pdf"/>
+ <fop fofile="${foDir}/table.fo" outfile="${referenceDir}/table.pdf"/>
+ <fop fofile="${foDir}/list.fo" outfile="${referenceDir}/list.pdf"/>
+ <fop fofile="${foDir}/link.fo" outfile="${referenceDir}/link.pdf"/>
+ <fop fofile="${foDir}/newlinktest.fo" outfile="${referenceDir}/newlinktest.pdf"/>
+ <fop fofile="${foDir}/border.fo" outfile="${referenceDir}/border.pdf"/>
+ <fop fofile="${foDir}/extensive.fo" outfile="${referenceDir}/extensive.pdf"/>
+ <fop fofile="${foDir}/images.fo" outfile="${referenceDir}/images.pdf"/>
+ <fop fofile="${foDir}/readme.fo" outfile="${referenceDir}/readme.pdf"/>
+ <fop fofile="${foDir}/fonts.fo" outfile="${referenceDir}/fonts.pdf"/>
+ <fop fofile="${foDir}/leader.fo" outfile="${referenceDir}/leader.pdf"/>
+ <fop fofile="${foDir}/textdeko.fo" outfile="${referenceDir}/textdeko.pdf"/>
+ <fop fofile="${foDir}/inhprop.fo" outfile="${referenceDir}/inhprop.pdf"/>
+ <fop fofile="${foDir}/normalex.fo" outfile="${referenceDir}/normalex.pdf"/>
+ <fop fofile="${foDir}/simple.fo" outfile="${referenceDir}/simple.pdf"/>
+ <!-- <fop fofile="${foDir}/hyphen.fo" outfile="${referenceDir}/hyphen.pdf"/> -->
+ <fop fofile="${foDir}/character.fo" outfile="${referenceDir}/character.pdf"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Starts the test -->
+ <!-- =================================================================== -->
+ <target name="runtest" depends="comparePDF">
+ <echo message="Running Fop tests"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Clean targets -->
+ <!-- =================================================================== -->
+ <target name="clean" depends="init">
+ <delete dir="${testDir}"/>
+ </target>
</project>
-
<!-- End of file -->
diff --git a/docs/xml-docs/build.xml b/docs/xml-docs/build.xml
index b66a9310f..a5baec012 100644
--- a/docs/xml-docs/build.xml
+++ b/docs/xml-docs/build.xml
@@ -1,5 +1,4 @@
<?xml version="1.0"?>
-
<!-- ===========================================================================
@@ -12,62 +11,45 @@ These are the meaningful targets for this build file:
- clean -> deletes all files produced by this script
-->
-
-
<project default="pdf" basedir=".">
-
- <!-- =================================================================== -->
- <!-- Initialization target -->
- <!-- =================================================================== -->
- <target name="init">
- <tstamp/>
-
- <property name="src.dir" value="./fop"/>
- <property name="allfiles.xml" value="fop-doc.xml"/>
- <property name="outfile.fo" value="fop.fo"/>
- <property name="outfile.pdf" value="fop.pdf"/>
-
- <taskdef name="fop" classname="org.apache.fop.tools.anttasks.Fop"/>
- <taskdef name="xslt" classname="org.apache.fop.tools.anttasks.Xslt"/>
-
- </target>
-
- <!-- =================================================================== -->
- <!-- copies all xml files into one. the infile is a dummy, because the -->
- <!-- source files are defined in the stylesheet -->
- <!-- =================================================================== -->
- <target name="prepare-files" depends="init">
- <xslt infile="fop.xml" xsltfile="xml2xml.xsl"
- outfile="${allfiles.xml}" smart="yes"/>
- </target>
-
- <!-- =================================================================== -->
- <!-- Generates the fo file -->
- <!-- =================================================================== -->
- <target name="fo" depends="prepare-files">
- <xslt infile="${allfiles.xml}" xsltfile="xml2pdf.xsl"
- outfile="${outfile.fo}" smart="yes"/>
- </target>
-
-
- <!-- =================================================================== -->
- <!-- Generates the pdf file -->
- <!-- =================================================================== -->
- <target name="pdf" depends="fo">
- <fop fofile="${outfile.fo}" pdffile="${outfile.pdf}"/>
- </target>
-
-
-
- <!-- =================================================================== -->
- <!-- Clean targets -->
- <!-- =================================================================== -->
- <target name="clean">
- <delete file="${allfiles.xml}"/>
- <delete file="${outfile.fo}"/>
- <delete file="${outfile.pdf}"/>
- </target>
-
+ <!-- =================================================================== -->
+ <!-- Initialization target -->
+ <!-- =================================================================== -->
+ <target name="init">
+ <tstamp/>
+ <property name="src.dir" value="./fop"/>
+ <property name="allfiles.xml" value="fop-doc.xml"/>
+ <property name="outfile.fo" value="fop.fo"/>
+ <property name="outfile.pdf" value="fop.pdf"/>
+ <taskdef name="fop" classname="org.apache.fop.tools.anttasks.Fop"/>
+ <taskdef name="xslt" classname="org.apache.fop.tools.anttasks.Xslt"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- copies all xml files into one. the infile is a dummy, because the -->
+ <!-- source files are defined in the stylesheet -->
+ <!-- =================================================================== -->
+ <target name="prepare-files" depends="init">
+ <xslt infile="fop.xml" xsltfile="xml2xml.xsl" outfile="${allfiles.xml}" smart="yes"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Generates the fo file -->
+ <!-- =================================================================== -->
+ <target name="fo" depends="prepare-files">
+ <xslt infile="${allfiles.xml}" xsltfile="xml2pdf.xsl" outfile="${outfile.fo}" smart="yes"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Generates the pdf file -->
+ <!-- =================================================================== -->
+ <target name="pdf" depends="fo">
+ <fop fofile="${outfile.fo}" outfile="${outfile.pdf}"/>
+ </target>
+ <!-- =================================================================== -->
+ <!-- Clean targets -->
+ <!-- =================================================================== -->
+ <target name="clean">
+ <delete file="${allfiles.xml}"/>
+ <delete file="${outfile.fo}"/>
+ <delete file="${outfile.pdf}"/>
+ </target>
</project>
-
<!-- End of file -->