Author: clay
Date: Sun Mar 2 20:44:28 2008
New Revision: 632938
URL: http://svn.apache.org/viewvc?rev=632938&view=rev
Log:
Updated the Apache FOP Quick Start to include a 'Hello World' document and make
it more geared toward newbies (thanks Jeremias!).
Modified:
xmlgraphics/fop/trunk/src/documentation/content/xdocs/quickstartguide.xml
Modified:
xmlgraphics/fop/trunk/src/documentation/content/xdocs/quickstartguide.xml
URL:
http://svn.apache.org/viewvc/xmlgraphics/fop/trunk/src/documentation/content/xdocs/quickstartguide.xml?rev=632938&r1=632937&r2=632938&view=diff
==============================================================================
--- xmlgraphics/fop/trunk/src/documentation/content/xdocs/quickstartguide.xml
(original)
+++ xmlgraphics/fop/trunk/src/documentation/content/xdocs/quickstartguide.xml
Sun Mar 2 20:44:28 2008
@@ -24,34 +24,101 @@
<version>$Revision: 627324 $</version>
</header>
<body>
- <p>The goal of his <strong>Quick Start Guide</strong> is to help novice
users get Apache FOP up and running quickly. Typically, you'll need to:</p>
- <ol>
- <li><a href="download.html">Download FOP</a></li>
- <li><a href="0.95/compiling.html">Build FOP</a></li>
- <li><a href="0.95/configuration.html">Configure FOP</a></li>
- <li><a href="0.95/running.html">Run FOP</a></li>
- </ol>
- <p>Here are some links to help you find out what FOP can do, as well as
how and where to get help:</p>
- <ul>
- <li><a href="0.95/embedding.html">Embed FOP</a></li>
- <li><a href="0.95/servlets.html">Using FOP in Servlets</a></li>
- <li><a href="0.95/anttask.html">Create an FOP 'Ant' Task</a></li>
- <li><a href="compliance.html" title="FOP Compliance">Compliance</a></li>
- <li><a href="gethelp.html">Getting Help</a></li>
- <li><a href="faq.html">FAQs</a></li>
- <li><a href="maillist.html">Mailing Lists</a></li>
- </ul>
- <p>The following links will help you understand what FOP supports out of
the box, and how to extend FOP using your own Fonts and Hyphenation files, as
well as how to extend FOP with Extensions.</p>
- <ul>
- <li><a href="0.95/output.html">FOP's Output Targets</a></li>
- <li><a href="0.95/intermediate.html">FOP's Intermediate Format</a></li>
- <li><a href="0.95/pdfencryption.html">FOP's PDF Encryption
Support</a></li>
- <li><a href="0.95/pdfa.html">FOP's PDF/A Support</a></li>
- <li><a href="0.95/pdfx.html">FOP's PDF/X Support</a></li>
- <li><a href="0.95/graphics.html">FOP's Graphics Support</a></li>
- <li><a href="0.95/fonts.html">FOP's Fonts Support</a></li>
- <li><a href="0.95/hyphenation.html">FOP's Hyphenation Support</a></li>
- <li><a href="0.95/extensions.html">FOP's Extensions Support</a></li>
- </ul>
+ <section id="essentials">
+ <title>FOP Essentials</title>
+ <p>The goal of this <strong>Quick Start Guide</strong> is to help novice
users get Apache FOP up and running quickly. Typically, you'll need to:</p>
+ <ol>
+ <li><link href="download.html">Download FOP</link></li>
+ <li><link href="0.95/compiling.html">Build FOP</link> (you can skip
this step if you download the binary distribution!)</li>
+ <li><link href="0.95/configuration.html">Configure FOP</link></li>
+ <li><link href="0.95/running.html">Run FOP</link></li>
+ </ol>
+ <p>Here are some links to help you find out what FOP can do, as well as
how and where to get help:</p>
+ <ul>
+ <li><link href="0.95/embedding.html">Calling FOP from a Java
Application</link></li>
+ <li><link href="0.95/servlets.html">Using FOP in Servlets</link></li>
+ <li><link href="0.95/anttask.html">Using FOP in an 'Ant' Build
Script</link></li>
+ <li><link href="compliance.html" title="FOP Compliance">XSL-FO
Compliance</link> (what FOP supports and what it doesn't)</li>
+ <li><link href="faq.html">FAQs</link></li>
+ <li><link href="gethelp.html">Getting Help</link></li>
+ <li><link href="maillist.html">Mailing Lists</link></li>
+ </ul>
+ <p>
+ Once you've familiarized yourself with the basics, you can get more
detailed information,
+ in the detailed FOP <link href="0.95/index.html">product
documentation</link>.
+ </p>
+ </section>
+
+ <section id="hello-world">
+ <title>Hello World with FOP</title>
+ <p>
+ This section walks you through a "Hello World!" page with Apache FOP.
We're assuming you
+ download the binary distribution and that you have a Java Runtime
Environment (version 1.4
+ or later) installed.
+ </p>
+ <ol>
+ <li>
+ Unpack the downloaded binary distribution to a directory of your
choice (for example,
+ <code>C:\FOP</code> if you're on Windows). Let's call that
+ directory <fop-home>.
+ </li>
+ <li>
+ Get a command prompt in the <fop-home> directory and
write:<br/>
+ Windows: <code>fop -fo examples/fo/basic/readme.fo -awt</code><br/>
+ Unix: <code>./fop.sh -fo examples/fo/basic/readme.fo -awt</code><br/>
+ </li>
+ <li>
+ If all went well, this should open a window showing you a
"readme"-style document.
+ This is just to verify that FOP runs correctly.
+ </li>
+ <li>
+ Now, take your favorite XML editor and create a small XML file like
the following. Replace
+ "Frank" with your own first name to make it a bit more personal and
save it as
+ <code>name.xml</code>:<br/>
+ <source><![CDATA[<name>Frank</name>]]></source>
+ </li>
+ <li>
+ To produce a PDF file from this XML file, we need an XSLT stylesheet
that converts the
+ XML to XSL-FO. This is the first step in the processing chain. The
second step will be
+ done by FOP when it reads the generated XSL-FO document and formats
it to a PDF document.
+ You can copy the following minimal XSLT stylesheet, which takes your
first name and
+ produces a "Hello World!"-style document (save it as
<code>name2fo.xsl</code>):<br/>
+ <source><![CDATA[<?xml version="1.0" encoding="utf-8"?>
+<xsl:stylesheet version="1.0"
+ xmlns:xsl="http://www.w3.org/1999/XSL/Transform";
+ xmlns:fo="http://www.w3.org/1999/XSL/Format";>
+ <xsl:output method="xml" indent="yes"/>
+ <xsl:template match="/">
+ <fo:root>
+ <fo:layout-master-set>
+ <fo:simple-page-master master-name="A4-portrait"
+ page-height="29.7cm" page-width="21.0cm" margin="2cm">
+ <fo:region-body/>
+ </fo:simple-page-master>
+ </fo:layout-master-set>
+ <fo:page-sequence master-reference="A4-portrait">
+ <fo:flow flow-name="xsl-region-body">
+ <fo:block>
+ Hello, <xsl:value-of select="name"/>!
+ </fo:block>
+ </fo:flow>
+ </fo:page-sequence>
+ </fo:root>
+ </xsl:template>
+</xsl:stylesheet>]]></source>
+
+ </li>
+ <li>
+ Finally, let's put the previous two steps together: Go back to the
command prompt and
+ enter the following command:<br/>
+ Windows: <code>fop -xml name.xml -xsl name2fo.xsl -pdf
name.pdf</code><br/>
+ Unix: <code>./fop.sh -xml name.xml -xsl name2fo.xsl -pdf
name.pdf</code><br/>
+ </li>
+ <li>
+ You've produced your first PDF with Apache FOP! Please open
<code>name.pdf</code>
+ in your favorite PDF viewer.
+ </li>
+ </ol>
+ </section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
