diff options
author | Keiron Liddle <keiron@apache.org> | 2001-11-01 11:33:52 +0000 |
---|---|---|
committer | Keiron Liddle <keiron@apache.org> | 2001-11-01 11:33:52 +0000 |
commit | ff1e921c8d093574053b8aa82b592c336ba6f5f5 (patch) | |
tree | f4b0b291e8c331c4c3080681688c569223b55462 | |
parent | 7b448c103499a65e6c315f3e0879de176231b0a4 (diff) | |
download | xmlgraphics-fop-ff1e921c8d093574053b8aa82b592c336ba6f5f5.tar.gz xmlgraphics-fop-ff1e921c8d093574053b8aa82b592c336ba6f5f5.zip |
some updates to links for xsl, svg and sax
updated faq to use faq dtd
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@194531 13f79535-47bb-0310-9956-ffa450edef68
-rw-r--r-- | docs/xml-docs/fop.xml | 2 | ||||
-rw-r--r-- | docs/xml-docs/fop/faq.xml | 115 | ||||
-rw-r--r-- | docs/xml-docs/fop/implemented.xml | 4 | ||||
-rw-r--r-- | docs/xml-docs/fop/readme.xml | 7 | ||||
-rw-r--r-- | docs/xml-docs/fop/resources.xml | 6 | ||||
-rwxr-xr-x | docs/xml-docs/makedoc.sh | 3 |
6 files changed, 87 insertions, 50 deletions
diff --git a/docs/xml-docs/fop.xml b/docs/xml-docs/fop.xml index bc484d152..bb18c6711 100644 --- a/docs/xml-docs/fop.xml +++ b/docs/xml-docs/fop.xml @@ -22,7 +22,7 @@ <page id="architecture" label="Architecture" source="fop/architecture.xml"/> <separator/> <page id="bugs" label="Bugs" source="fop/bugs.xml" /> - <page id="faq" label="FAQ" source="fop/faq.xml" /> + <faqs id="faq" label="FAQ" source="fop/faq.xml"/> <page id="resources" label="Resources" source="fop/resources.xml" /> <page id="license" label="License" source="fop/license.xml" /> diff --git a/docs/xml-docs/fop/faq.xml b/docs/xml-docs/fop/faq.xml index f235c49cd..b9fa59aad 100644 --- a/docs/xml-docs/fop/faq.xml +++ b/docs/xml-docs/fop/faq.xml @@ -1,8 +1,9 @@ <?xml version="1.0"?> - - -<s1 title="Frequently Asked Questions"> - <s2 title="Introduction"> +<!DOCTYPE faqs SYSTEM "../dtd/faq-v10.dtd"> +<faqs title="Frequently Asked Questions"> +<faq> + <question>About the FAQ</question> + <answer> <p> Here we have some answers to common questions about FOP. This only covers general information about getting started with FOP and pointers to more @@ -13,21 +14,11 @@ The site uses Jyve to provide an interactive FAQ: <jump href="http://www.owal.co.uk:8090/asf/servlet/asf/screen/DisplayTopics/action/SetAll/project_id/18/faq_id/276">http://www.OWAL.co.uk:8090/</jump> </p> - </s2> - <s2 title="Questions"> - <ul> - <li><jump href="#q1">What is FOP?</jump></li> - <li><jump href="#q2">How does FOP interact with other Apache Projects?</jump></li> - <li><jump href="#q3">What is XSL (FO)?</jump></li> - <li><jump href="#q4">What can I do with FOP?</jump></li> - <li><jump href="#q5">How can I contribute?</jump></li> - <li><jump href="#q6">How do I author XSL documents?</jump></li> - <li><jump href="#q7">How can I see a demo?</jump></li> - </ul> - </s2> - <s2 title="Answers"> - <s3 title="What is FOP"> -<anchor name="q1"></anchor> + </answer> +</faq> +<faq> + <question>What is FOP?</question> + <answer> <p> FOP is a print formatter for XSL formatting objects. </p> @@ -36,9 +27,11 @@ into a page layout. The main target is PDF but other rendering targets are supported, such as AWT, PCL, text and direct printing. </p> - </s3> - <s3 title="How does FOP interact with other Apache Projects?"> -<anchor name="q2"></anchor> + </answer> +</faq> +<faq> + <question>How does FOP interact with other Apache Projects?</question> + <answer> <p> FOP is distributed with <jump href="http://xml.apache.org/cocoon">Cocoon</jump> as a PDF serializer for XSL (FO) documents. </p> @@ -46,34 +39,76 @@ <jump href="http://xml.apache.org/batik">Batik</jump> can be used with FOP to <jump href="http://xml.apache.org/batik/svgrasterizer.html">transcode an SVG image</jump> into a PDF document. The mime type for PDF is "application/pdf". </p> - </s3> - <s3 title="What is XSL (FO)"> -<anchor name="q3"></anchor> + </answer> +</faq> + +<faq> + <question>What is XSL (FO)?</question> + <answer> <p> +XSL is an XML format that is used to specify a pagination and other +styling for page layout output. XSL can be used in conjunction with +XSLT to convert from any XML format into a paginated layout ready for +printing or displaying. </p> - </s3> - <s3 title="What can I do with FOP"> -<anchor name="q4"></anchor> <p> +XSL defines a set of formatting objects in xml that describes the +way pages are set up. The contents of the pages are filled from +flows which. There can be static flows that appear on every page +and the main flow which fills the body of the page. </p> - </s3> - <s3 title="How can I contribute"> -<anchor name="q5"></anchor> + </answer> +</faq> + +<faq> + <question>What can I do with FOP?</question> + <answer> <p> +FOP is an application or library that converts an XSL FO document +into the paginated output. It is possible to render the output +to different targets, the main target is PDF. FOP can be run from +the command line or embedded into your Java application. </p> - </s3> - <s3 title="How do I author XSL documents"> -<anchor name="q6"></anchor> <p> +The XSL FO can be delivered to FOP with XML(XSL FO), XML+XSL or +SAX events. + </p> + </answer> +</faq> + +<faq> + <question>How can I contribute?</question> + <answer> + <p> +There is always plenty of things to do. </p> - </s3> - <s3 title="How can I see a demo"> -<anchor name="q7"></anchor> + </answer> +</faq> + +<faq> + <question>How do I author XSL documents?</question> + <answer> + <p> +Often XSL FO is created from XML and XSLT. There are some +standard XML markups such as Docbook that can be converted +into XSL FO and other XML formats. + </p> + <p> +There are some XSL authoring tools that may help you to +author XSL FO documents or the XML and XSLT documents. + </p> + </answer> +</faq> + +<faq> + <question>How can I see a demo?</question> + <answer> <p> There will be a Java Webstart demo sometime in the future. +This will use the AWT viewer to display FO documents. </p> - </s3> - </s2> + </answer> +</faq> -</s1> +</faqs> diff --git a/docs/xml-docs/fop/implemented.xml b/docs/xml-docs/fop/implemented.xml index 3de5b5233..2cf614707 100644 --- a/docs/xml-docs/fop/implemented.xml +++ b/docs/xml-docs/fop/implemented.xml @@ -39,8 +39,8 @@ <s3 title="B.2 Block Formatting Objects"> <ul> <li>block </li> + <li>block-container (limited)</li> </ul> - <p>Not implemented: block-container</p> </s3> <s3 title="B.3 Inline Formatting Objects"> @@ -97,8 +97,8 @@ <s3 title="B.8 Other Formatting Objects"> <ul> <li>wrapper</li> + <li>marker, retrieve marker</li> </ul> - <p>Not implemented: marker, retrieve-marker</p> </s3> </s2> diff --git a/docs/xml-docs/fop/readme.xml b/docs/xml-docs/fop/readme.xml index bc7cbc57d..7811795c8 100644 --- a/docs/xml-docs/fop/readme.xml +++ b/docs/xml-docs/fop/readme.xml @@ -16,8 +16,11 @@ <figure src="title.jpg" alt="FOP Title" /> </p> <p>FOP is the world's first print formatter driven by XSL formatting - objects. It is a Java application that reads a formatting object - tree and then renders the resulting pages to a specified output. + objects and the world's first output indepent formatter. It is a + Java application that reads a formatting object tree and then + renders the resulting pages to a specified output. Output formats + currently supported are PDF, PCL, SVG, XML (area tree representation), + Print, AWT and TXT. The primary output target is PDF. </p> <p> diff --git a/docs/xml-docs/fop/resources.xml b/docs/xml-docs/fop/resources.xml index 03214711c..ad9516a25 100644 --- a/docs/xml-docs/fop/resources.xml +++ b/docs/xml-docs/fop/resources.xml @@ -6,13 +6,13 @@ <s1 title="FOP Relevant Specifications and Links"> <s2 title="Specifications"> <ul> - <li><jump href="http://www.w3.org/TR/2000/CR-xsl-20001121/">XSL-FO Candidate Recommendation (21 November 2000)</jump></li> + <li><jump href="http://www.w3.org/TR/2001/REC-xsl-20011015/">XSL-FO Recommendation (15 October 2001)</jump></li> <li><jump href="http://www.renderx.com/Tests/validator/fo2000.dtd.html">A dtd for the XSL-FO CR from November provided by N. Grigoriev from RenderX</jump></li> - <li><jump href="http://www.w3.org/TR/2000/CR-SVG-20001102/">Supported SVG Candidate Recommendation (02 November 2000)</jump></li> + <li><jump href="http://www.w3.org/TR/SVG/">Supported SVG Recommendation (04 September 2001)</jump></li> <li><jump href="http://www.w3.org/TR/REC-xml">XML Recommendation</jump></li> <li><jump href="http://www.w3.org/TR/xslt">XSLT Recommendation</jump></li> <li><jump href="http://partners.adobe.com/asn/developer/acrosdk/DOCS/pdfspec.pdf">Portable Document Format (PDF) 1.3 Reference Manual </jump></li> - <li><jump href="http://www.megginson.com/SAX/">Simple API for XML (SAX)</jump></li> + <li><jump href="http://sax.sourceforge.net/">Simple API for XML (SAX)</jump></li> <li><jump href="http://www.w3.org/TR/REC-DOM-Level-1">Document Object Model (DOM)</jump></li> <li><jump href="http://www.w3.org/TR/REC-xml-names/">Namespaces in XML Recommendation</jump></li> <li><jump href="http://java.sun.com/products/jdk/1.1/docs/index.html">Java JDK 1.1 Documentation</jump></li> diff --git a/docs/xml-docs/makedoc.sh b/docs/xml-docs/makedoc.sh index 192a37bf3..a0ff6da34 100755 --- a/docs/xml-docs/makedoc.sh +++ b/docs/xml-docs/makedoc.sh @@ -1,7 +1,6 @@ #!/bin/sh #This file should be executable - echo echo "Converting Fop's xml documentation into a pdf file, creating html docs" echo "----------------" @@ -16,7 +15,7 @@ if [ "$JAVA_HOME" = "" ] ; then fi LIBDIR=../../lib -LOCALCLASSPATH=$JAVA_HOME/lib/tools.jar:$JAVA_HOME/lib/classes.zip:$LIBDIR/ant.jar:$LIBDIR/batik.jar:$LIBDIR/buildtools.jar:$LIBDIR/xerces-1.2.3.jar:$LIBDIR/xalan-2.0.0.jar:$LIBDIR/bsf.jar:$LIBDIR/avalon-framework-4.0.jar:$LIBDIR/logkit-1.0b4.jar:$LIBDIR/jimi-1.0.jar:$LIBDIR/stylebook.jar:$LIBDIR/../build/fop.jar +LOCALCLASSPATH=$JAVA_HOME/lib/tools.jar:$JAVA_HOME/lib/classes.zip:$LIBDIR/ant.jar:$LIBDIR/batik.jar:$LIBDIR/buildtools.jar:$LIBDIR/xerces-1.4.3.jar:$LIBDIR/xalan-2.2D11.jar:$LIBDIR/logkit-1.0.jar:$LIBDIR/jimi-1.0.jar:$LIBDIR/stylebook.jar:$LIBDIR/../build/fop.jar ANT_HOME=$LIBDIR echo Building with classpath $LOCALCLASSPATH:$CLASSPATH |