You are viewing a plain text version of this content. The canonical link for it is here.
Posted to fop-commits@xmlgraphics.apache.org by ke...@apache.org on 2001/11/01 12:33:53 UTC

cvs commit: xml-fop/docs/xml-docs/fop faq.xml implemented.xml readme.xml resources.xml

keiron      01/11/01 03:33:53

  Modified:    docs/xml-docs fop.xml makedoc.sh
               docs/xml-docs/fop faq.xml implemented.xml readme.xml
                        resources.xml
  Log:
  some updates to links for xsl, svg and sax
  updated faq to use faq dtd
  
  Revision  Changes    Path
  1.10      +1 -1      xml-fop/docs/xml-docs/fop.xml
  
  Index: fop.xml
  ===================================================================
  RCS file: /home/cvs/xml-fop/docs/xml-docs/fop.xml,v
  retrieving revision 1.9
  retrieving revision 1.10
  diff -u -r1.9 -r1.10
  --- fop.xml	2001/10/05 09:44:31	1.9
  +++ fop.xml	2001/11/01 11:33:52	1.10
  @@ -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"   />
   
  
  
  
  1.16      +1 -2      xml-fop/docs/xml-docs/makedoc.sh
  
  Index: makedoc.sh
  ===================================================================
  RCS file: /home/cvs/xml-fop/docs/xml-docs/makedoc.sh,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- makedoc.sh	2001/10/05 09:44:31	1.15
  +++ makedoc.sh	2001/11/01 11:33:52	1.16
  @@ -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 @@
   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
  
  
  
  1.5       +75 -40    xml-fop/docs/xml-docs/fop/faq.xml
  
  Index: faq.xml
  ===================================================================
  RCS file: /home/cvs/xml-fop/docs/xml-docs/fop/faq.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- faq.xml	2001/08/10 13:57:32	1.4
  +++ faq.xml	2001/11/01 11:33:52	1.5
  @@ -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,44 +27,88 @@
           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>
         <p>
           <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>
  +  </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>
  +      <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>
  +  </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="What is XSL (FO)">
  -<anchor name="q3"></anchor>
         <p>
  +The XSL FO can be delivered to FOP with XML(XSL FO), XML+XSL or
  +SAX events.
         </p>
  -    </s3>
  -    <s3 title="What can I do with FOP">
  -<anchor name="q4"></anchor>
  +  </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 contribute">
  -<anchor name="q5"></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>
  -    </s3>
  -    <s3 title="How do I author XSL documents">
  -<anchor name="q6"></anchor>
         <p>
  +There are some XSL authoring tools that may help you to
  +author XSL FO documents or the XML and XSLT documents.
         </p>
  -    </s3>
  -    <s3 title="How can I see a demo">
  -<anchor name="q7"></anchor>
  +  </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>
   
  
  
  
  1.16      +2 -2      xml-fop/docs/xml-docs/fop/implemented.xml
  
  Index: implemented.xml
  ===================================================================
  RCS file: /home/cvs/xml-fop/docs/xml-docs/fop/implemented.xml,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -r1.15 -r1.16
  --- implemented.xml	2001/06/06 12:34:04	1.15
  +++ implemented.xml	2001/11/01 11:33:52	1.16
  @@ -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>
   
  
  
  
  1.13      +5 -2      xml-fop/docs/xml-docs/fop/readme.xml
  
  Index: readme.xml
  ===================================================================
  RCS file: /home/cvs/xml-fop/docs/xml-docs/fop/readme.xml,v
  retrieving revision 1.12
  retrieving revision 1.13
  diff -u -r1.12 -r1.13
  --- readme.xml	2001/10/05 09:44:32	1.12
  +++ readme.xml	2001/11/01 11:33:52	1.13
  @@ -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>
  
  
  
  1.5       +3 -3      xml-fop/docs/xml-docs/fop/resources.xml
  
  Index: resources.xml
  ===================================================================
  RCS file: /home/cvs/xml-fop/docs/xml-docs/fop/resources.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- resources.xml	2001/08/16 11:38:58	1.4
  +++ resources.xml	2001/11/01 11:33:52	1.5
  @@ -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>
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: fop-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: fop-cvs-help@xml.apache.org