Browse Source

updates to docs with build target for understanding and alt.design

Submitted by:	"Peter B. West" <pbwest@powerup.com.au>
Reviewed by:	Keiron


git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@194707 13f79535-47bb-0310-9956-ffa450edef68
tags/fop-0_20_4-doc
Keiron Liddle 22 years ago
parent
commit
68384a39b8
3 changed files with 40 additions and 3 deletions
  1. 28
    3
      build.xml
  2. 5
    0
      docs/design/book.xml
  3. 7
    0
      docs/xml-docs/fop/output.xml

+ 28
- 3
build.xml View File

@@ -84,8 +84,9 @@ These are the meaningful targets for this build file:
- package [default] -> creates ./build/fop.jar
- usage -> shows a help screen
- codegen -> generates needed java sources from xml resources
- docs -> generates the HTML documentation in ./build/docs
- htmldoc -> generates the HTML documentation in ./build/docs/html-docs
- javadocs -> generates the API documentation in ./build/javadocs
- pdfdoc -> generates the PDF documentation in ./build/docs/xml-docs
- dist -> generates the Fop distribution
- clean -> restores the distribution to its original and clean state
(excepting dist files)
@@ -308,8 +309,9 @@ Sometimes ant gives out this warnings, but the build is finished without any pro
<echo message=" package --> generates the ${name}.jar file (default)"/>
<echo message=" codegen --> generates the java files from the xml resources"/>
<echo message=" compile --> compiles the source code"/>
<echo message=" docs --> generates the HTML documentation"/>
<echo message=" htmldoc --> generates the HTML documentation"/>
<echo message=" javadocs --> generates the API documentation (java 1.2 only)"/>
<echo message=" pdfdoc --> generates the PDF documentation"/>
<echo message=" dist --> generates the ${Name} distribution as .tar.gz and .zip"/>
<echo message=" clean --> cleans up the directory (except for the dist files)"/>
<echo message=" distclean --> cleans up the directory"/>
@@ -537,7 +539,10 @@ Sometimes ant gives out this warnings, but the build is finished without any pro
</target>

<target name="html" depends="javadocs, htmldoc"/>
<target name="htmldoc" depends="prepare-src">
<target name="htmldoc" depends= "html-fop, html-design"/>

<target name="html-fop" depends="prepare-src">
<copy file="${xdocs}/fop.xml"
tofile="${xdocs}/book.xml"
filtering="on"/>
@@ -545,12 +550,32 @@ Sometimes ant gives out this warnings, but the build is finished without any pro
<classpath refid="libs-build-classpath"/>
<arg line="targetDirectory=${docs} ${xdocs}/book.xml ${skins}"/>
</java>
</target>

<target name="html-design" depends="prepare-src, html-newdesign,
html-altdesign, html-understanding"/>

<target name="html-newdesign" depends="prepare-src">
<java classname="${doc.generator}" fork="yes">
<classpath refid="libs-build-classpath"/>
<arg line="targetDirectory=${docs}/design/ docs/design/book.xml ${skins}"/>
</java>
</target>

<target name="html-altdesign" depends="prepare-src">
<java classname="${doc.generator}" fork="yes">
<classpath refid="libs-build-classpath"/>
<arg line="targetDirectory=${docs}/design/alt.design/ docs/design/alt.design/book.xml ${skins}"/>
</java>
</target>

<target name="html-understanding" depends="prepare-src">
<java classname="${doc.generator}" fork="yes">
<classpath refid="libs-build-classpath"/>
<arg line="targetDirectory=${docs}/design/understanding docs/design/understanding/book.xml ${skins}"/>
</java>
</target>

<target name="pdfdoc" depends="package">
<copy file="${xdocs}/fop.xml"
tofile="${xdocs}/book.xml"

+ 5
- 0
docs/design/book.xml View File

@@ -3,6 +3,8 @@
<book title="FOP Design" copyright="1999-2002 The Apache Software Foundation">
<external href="http://xml.apache.org/fop/" label="About FOP"/>
<separator/>
<external href="understanding/index.html" label="Understanding" />
<separator/>
<page id="index" label="Design" source="intro.xml"/>
<page id="architecture" label="Architecture" source="architecture.xml" />
<page id="properties" label="Properties" source="properties.xml" />
@@ -19,4 +21,7 @@
<page id="extending" label="Extending" source="extending.xml" />
<separator/>
<page id="status" label="Status" source="status.xml" />
<separator/>
<external href="alt.design/index.html" label="ALT DESIGN" />
<separator/>
</book>

+ 7
- 0
docs/xml-docs/fop/output.xml View File

@@ -54,6 +54,13 @@ able to send the output stream directly to a printer. If your printer
supports postscript you could send the postscript to the printer. If
you have a printer that supports PCL you could stream the PCL document
to your printer.
On Windows:
<source><![CDATA[fop ... -ps \\computername\printer or fop ... -pcl \\computername\printer]]></source>
On UNIX:
<source><![CDATA[proc = Runtime.getRuntime().exec("lp -d" + print_queue + " -o -dp -");
out = proc.getOutputStream();]]></source>
And give the OutputStream (out) to the PCLRenderer and it happily sends the
PCL to the AIX print queue.
</p>
</s2>
<s2 title="PDF">

Loading…
Cancel
Save