aboutsummaryrefslogtreecommitdiffstats
path: root/src/documentation/content/xdocs/index.xml
diff options
context:
space:
mode:
authorKeiron Liddle <keiron@apache.org>2002-11-04 16:20:53 +0000
committerKeiron Liddle <keiron@apache.org>2002-11-04 16:20:53 +0000
commit3a02751a91cb55ce220757456c98ae91db1a8935 (patch)
treed6ee40fbc576979ac4e877e7823222353aaf6085 /src/documentation/content/xdocs/index.xml
parent18d95ced827abe67cec9f0ea0cb372eb83350c4c (diff)
downloadxmlgraphics-fop-3a02751a91cb55ce220757456c98ae91db1a8935.tar.gz
xmlgraphics-fop-3a02751a91cb55ce220757456c98ae91db1a8935.zip
updated docs for forrest
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@195413 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/documentation/content/xdocs/index.xml')
-rw-r--r--src/documentation/content/xdocs/index.xml72
1 files changed, 69 insertions, 3 deletions
diff --git a/src/documentation/content/xdocs/index.xml b/src/documentation/content/xdocs/index.xml
index 4c10c9510..6e2a6f72d 100644
--- a/src/documentation/content/xdocs/index.xml
+++ b/src/documentation/content/xdocs/index.xml
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
- <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<document>
<header>
<title>FOP</title>
@@ -7,8 +7,74 @@
<body>
<section>
<title>Introduction</title>
- <p>
- </p>
+ <p>FOP (Formatting Objects Processor) is the world's first print formatter driven by XSL formatting
+ objects and the world's first output independent formatter. It is a
+ Java application that reads a formatting object tree and then
+ renders the resulting pages to a specified output. <link href="output.html">Output formats</link>
+ currently supported are PDF, PCL, PS, SVG, XML (area tree representation),
+ Print, AWT, MIF and TXT.
+ The primary output target is PDF.
+ </p>
+ <figure width="480" height="260" src="images/document.jpg" alt="Render Diagram" />
+ <p>The latest version of Fop is 0.20.4 and it supports the
+ <link href="http://www.w3.org/TR/2001/REC-xsl-20011015/">XSL-FO Version 1.0
+ W3C Recommendation</link>.
+ You can <link href="download.html">download</link>
+ Fop including a precompiled version, the source code and many example files to
+ get you started. Pointers to introductions into xsl:fo can be found in the
+ <link href="resources.html">resources</link> section. Please be aware, that
+ Fop is at the moment not a full implementation of the basic conformance level
+ of the xsl:fo standard. You can find a list of supported flow objects and properties
+ in the section <link href="implemented.html">Features</link> and in section
+ <link href="limitations.html">Limitations</link> in what way this support is
+ limited.
+ </p>
+ <p>FOP is part of Apache's XML project. The homepage of FOP is
+ <link href="http://xml.apache.org/fop">http://xml.apache.org/fop</link>.
+ Here you can find information about using and developing with FOP.
+ </p>
+ <p>Users can subscribe to fop-user@xml.apache.org by sending an email
+ to <link href="mailto:fop-user-subscribe@xml.apache.org">fop-user-subscribe@xml.apache.org</link>
+ this is where user specific topics are discussed.
+ </p>
</section>
+
+ <section>
+ <title>Formatting</title>
+ <figure width="480" height="260" src="images/layout.jpg" alt="Formatting Diagram" />
+<p>
+This image is a demonstration of a two page document. The xml data on the left
+is formatted into the two pages on the right. The document contains static areasthat appear on every page, an external graphic in this case an svg document.
+There is a footnote on the first page and a table that goes across both pages.
+</p>
+<p>
+The advantage of XSL is the ability to take an XML document and to format
+the information into a page layout. The XML document can be generated
+in any way, the most common would be to use XSLT. FOP takes the XML
+and formats the data into pages. The pages are then rendered to the
+requested output.
+</p>
+<p>
+This is a real document. The image was created by rendering the document
+to the svg renderer then putting the rendered pages into an svg document
+along with the xml.
+</p>
+ </section>
+ <section>
+ <title>FOP Objectives</title>
+ <p>The goals of the Apache XML FOP Project are to deliver an XSL FO->PDF formatter that is compliant to at least the Basic
+ conformance level described in the W3C Recommendation from 15 October 2001, and that complies with the 11 March 1999 Portable Document
+ Format Specification (Version 1.3) from Adobe Systems.
+ </p>
+
+ <p>Conformance to the XML 1.0 Recommendation, XSLT 1.0 Recommendation and the XML Namespaces Recommendation is
+ understood. Other relevant documents, such as the XPath and XLink Working Drafts, are referenced as necessary. The FOP
+ Project will attempt to use the latest version of evolving specifications.
+ </p>
+
+ <p>To reach this aim currently the layout system is being redesigned to
+better handle the formatting of all different types of formatting objects.
+ </p>
+ </section>
</body>
</document>