From: fotis Date: Sun, 26 Nov 2000 00:00:34 +0000 (+0000) Subject: documentation update for release 0.15 X-Git-Tag: pre-columns~48 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=4425a830bafce1e79bb5d7bad992380f07d6f2ed;p=xmlgraphics-fop.git documentation update for release 0.15 git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@193838 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/STATUS b/STATUS index e084796c7..76f4c400a 100644 --- a/STATUS +++ b/STATUS @@ -45,6 +45,7 @@ Done since 0.14 release - redesign of properties handling, support for computed, compound and shorthand properties, supporting docs [Karen Lease] - redesign of font handling for AWTRenderer [Dorothea Wiarda] +- added: support for leader-alignment, leader-pattern-width, leader-pattern (dots,space) [Fotis Jannidis] - fixed: unnecessary dependence on jdk 1.2 features [Christian Geisert] - fixed: unicode problem in UserMessage [Ross Golder] - fixed: broken buildFOTree [Marcus Holmberg] @@ -53,6 +54,9 @@ Done since 0.14 release - fixed: renamed: inline-sequence -> inline, simple-link -> basic-link, white-space-treatment -> white-space-collapse [Fotis Jannidis] - fixed: images were rendered only half size (Mikko Honkala) +- fixed: pdf file in XalanCommandFile explicitly closed [Dharamveer Salecha] +- fixed: lists containing list do not keep their indentation correctly + over a page boundary [Dorothea Wiarda] Done since 0.13 release - pagination updated to 03/27/2000 XSL WD [Arved Sandstrom] @@ -100,19 +104,21 @@ image support [Eric Schaeffer, Pankaj Narula, Andreas Rueckert] SVG support [Keiron Liddle][Torsten Friebe] smooth shading in PDF [Steven Coffman] tables [Karen Lease] +hyphenation [Carlos Villegas] docs [Fotis Jannidis] **** THINGS TO DO **** -Support XSL Working Draft 18 October 2000 +Support XSL Candidate Release + +first target is basic conformance 1.One category of tasks will be to implement missing formatting objects. basic fo:character fo:declarations - fo:leader [at the moment only partially] fo:multi-case fo:table-and-caption fo:table-header @@ -138,67 +144,75 @@ extended fo:table-footer fo:title -2. done -3. done -4.A fourth, and not insignificant, category of tasks is to decide upon and +2. A not insignificant, category of tasks is to decide upon and implement all reasonable properties required by the specification. This also means that at this point, until further review, no FO can be considered to be compliant. + This are the properties which must be implemented to reach basic conformance a) CHANGED space-after.optimum (Incomplete) space-before.optimum (Incomplete) - white-space-treatment has to be renamed to white-space-collapse and adjusted keep-with-next (Changed) b) NEW - 1.alignment-adjust 26.min-width - 2.baseline-identifier 27.number-columns-repeated - 3.baseline-shift 28.number-columns-spanned - 4.block-progression-dimension 29.number-rows-spanned - 5.character 30.orphans - 6.clip 31.overflow - 7.column-number 32.page-break-after - 8.content-type 33.page-break-before - 9.direction 34.precedence - 10.display-align 35.ref-id - 11.dominant-baseline 36.reference-orientation - 12.font-variant 37.region-name - 13.format 38.relative-align - 14.grouping-separator 39.role - 15.grouping-size 40.rule-style - 16.inline-progression-dimension 41.source-document - 17.keep-with-previous 42.space-after - 18.leader-length 43.space-before - 19.leader-pattern 44.space-end - 20.letter-value 45.space-start - 21.line-stacking-strategy - 22.master-name 47.visibility - 23.max-height 48.widows - 24.max-width 49.writing-mode - 25.min-height 50.z-index - -5.A fifth category of tasks is the ongoing effort to promote maintainability, -write - more and better documentation, and to refine the build process. - a) Add the property files to the source code (how is the vote on this?) - b) add examples so that all the FOs supported are used in some example - -6. Redo or work on the classes/properties which have been fixed only in a superficial way - to conform to the latest working draft - - leader is just a renamed display-rule and must be rewritten: - it is now (wd 3.2000) generating inline-areas and not block areas - and has a more complex function - - inline is just a renamed inline-sequence and must be worked on: - it is now (wd 3.2000) generating an inline-area itself + alignment-adjust + alignment-baseline + azimuth + baseline-shift + block-progression-dimension + border-after-precedence + border-before-precedence + border-end-precedence + border-start-precedence + character + clip + column-number + content-type + cue-after + cue-before + direction + display-align + dominant-baseline + font-variant + format + grouping-separator + grouping-size + inline-progression-dimension + keep-with-next + keep-with-previous + letter-value + line-stacking-strategy + number-columns-repeated + number-columns-spanned + number-rows-spanned + orphans + overflow + reference-orientation + relative-align + role + rule-style + source-document + space-after (full) + space-before (full) + space-end + space-start + visibility + widows + writing-mode + z-index + +3. A third category of tasks is the ongoing effort to promote maintainability, + write more and better documentation, and to refine the build process. + a) add examples. In examples/fo there should be at least one file for each + supported flow object showing the use of all properties applying to it. **** Bugs **** - colour not continued onto subsequent pages if coloured block goes over page - keep-next doesn't work and doubles the text lines which should be moved to the next page -- lists containing list do not keep their indentation correctly over a page boundary - border width in fo:table is added to the start position of the next block or table (see page 6 in table.fo for a test case) diff --git a/docs/html-docs/architecture.html b/docs/html-docs/architecture.html index e3a37f8df..25d77cd45 100644 --- a/docs/html-docs/architecture.html +++ b/docs/html-docs/architecture.html @@ -30,6 +30,8 @@ this class, a typical sequence is:

driver.setRenderer("org.apache.fop.render.pdf.PDFRenderer", version);

driver.addElementMapping("org.apache.fop.fo.StandardElementMapping");

driver.addElementMapping("org.apache.fop.svg.SVGElementMapping");

+

driver.addPropertyList("org.apache.fop.fo.StandardPropertyListMapping");

+

driver.addPropertyList("org.apache.fop.svg.SVGPropertyListMapping");

driver.setWriter(new PrintWriter(new FileWriter(args[1])));

driver.buildFOTree(parser, fileInputSource(args[0]));

@@ -111,8 +113,8 @@ constructing the FO tree. The key SAX events used are

Block

-

InlineSequence

-

SimpleLink

+

Inline

+

BasicLink


@@ -270,6 +272,31 @@ discusses some issues applicable to rendering.


+
SVG
  + +

+FOP supports some svg rendering. SVG is supported as an instream-foreign-object +embedded in an FO document. FOP also supports rendering of an external SVG image. +

+ +

+Since the intream object that contains the SVG returns a single fo area then +the construction of the SVG document is handled differently. The SVG is created +by calling the createGraphic() on each SVG element. The element is then +responsible for loading the necessary information and child elements and creating +the corresponding SVG DOM element. When the FO tree is being layed out the +SVG tree is turned into the SVG DOM document which is stored for later rendering. +

+ +

+The SVG document is then held as a DOM tree which is then rendered by going through +the elements of the tree and rendering then in turn. +

+ +

+For more information see the SVG documentation. +

+


Copyright © 1999 The Apache Software Foundation. All Rights Reserved. diff --git a/docs/html-docs/bugs.html b/docs/html-docs/bugs.html index 0591598da..4896707d1 100644 --- a/docs/html-docs/bugs.html +++ b/docs/html-docs/bugs.html @@ -29,14 +29,9 @@ file with your report, which just demonstrates the problem. Thanks for your help!


Known bugs
  -
    -
  • Colour not continued onto subsequent pages, if coloured block goes over page.
    • -
  • SVG linearGradients don't appear the same as in other SVG Viewers
    • -
  • colour not continued onto subsequent pages if coloured block goes over page
    • -
  • no SVG support in AWTCommandLine
    • -
  • keep-next doesn't work and doubles the text lines which should be moved to the next page
    • -
  • lists containing list do not keep their indentation correctly over a page boundary
    • -
+

A list of known bugs can be found at the end of the file + Status in the root + of the Fop distribution.



Copyright © 1999 The Apache Software Foundation. diff --git a/docs/html-docs/download.html b/docs/html-docs/download.html index f96930f51..c0ad4248f 100644 --- a/docs/html-docs/download.html +++ b/docs/html-docs/download.html @@ -22,6 +22,12 @@
 

You can download the latest release version from the distribution directory.

The file contains also the documentation (including some example fo files) and the source.

+

If you want to work with the latest and nicest code, you can use the cvs version. See the section + on AnonCVS in the xml.apache.org documentation for details. + Sometimes people have difficulties to access the cvs server; in this case you can download + a snapshot from the cvs files here. + In both cases you have to build Fop yourself - see Compiling Fop for details. +

To run FOP from the command line, see Running FOP. If you are interested in embedding FOP in a Java application of your own, see Embedding FOP. diff --git a/docs/html-docs/embedding.html b/docs/html-docs/embedding.html index 8ddf32710..5f145e2c9 100644 --- a/docs/html-docs/embedding.html +++ b/docs/html-docs/embedding.html @@ -46,6 +46,8 @@

driver.setRenderer("org.apache.fop.render.pdf.PDFRenderer", version);

driver.addElementMapping("org.apache.fop.fo.StandardElementMapping");

driver.addElementMapping("org.apache.fop.svg.SVGElementMapping");

+

driver.addPropertyList("org.apache.fop.fo.StandardPropertyListMapping");

+

driver.addPropertyList("org.apache.fop.svg.SVGPropertyListMapping");

driver.setWriter(new PrintWriter(new FileWriter(args[1])));

driver.buildFOTree(parser, fileInputSource(args[0]));

driver.format();

diff --git a/docs/html-docs/examples.html b/docs/html-docs/examples.html index 8148c93c3..5e31f7146 100644 --- a/docs/html-docs/examples.html +++ b/docs/html-docs/examples.html @@ -30,11 +30,9 @@
  • normal.fo - a simple file showing the use of a 2 level of headings, normal text and a header.
    • -
  • table.fo - a simple table +
  • table.fo - some table examples
    • -
  • list.fo - a simple list -
    • -
  • list2.fo - some list examples +
  • list.fo - a short tutorial how to use list fo's and properties
  • images.fo - shows how to embed gif and jpg images into the xsl:fo file using external-graphic.
    • @@ -43,7 +41,7 @@
  • extensive.fo - a longer test file containing a lot of different flow objects and properties. A good candidate to test your bugfix or new Fop code.
    • -
  • leader.fo - a very simple example of a rule +
  • leader.fo - shows different uses of fo:leader, p.e. as rule or in a table of content
  • normalex.fo - shows the use of computed property values
    • @@ -51,10 +49,10 @@
  • instream.fo - shows the use of fo:instream-foreign-object together with svg
    • -
  • inhprop.fo - shows the use of inherited property values -
  • textdeko.fo - shows the use of the property textdecoration
    • +
  • readme.fo - uses an old version of Fop documentation for a longer example +
  • Look also into the directory examples/svg. There you find some very extensive svg examples. Just start makedoc. diff --git a/docs/html-docs/graphics/specs-header.jpg b/docs/html-docs/graphics/specs-header.jpg index aadb2ec1a..121d33984 100644 Binary files a/docs/html-docs/graphics/specs-header.jpg and b/docs/html-docs/graphics/specs-header.jpg differ diff --git a/docs/html-docs/implemented.html b/docs/html-docs/implemented.html index 7a99f330a..90fc8f4fe 100644 --- a/docs/html-docs/implemented.html +++ b/docs/html-docs/implemented.html @@ -21,7 +21,7 @@
    • What's Implemented?
     

    The following formatting objects and properties of the xsl-fo - working draft (12 October 2000) are implemented.Please have also a look at the + candidate recommendation are implemented.Please have also a look at the section on limitations


    @@ -61,7 +61,7 @@
  • external-graphic
  • inline
  • instream-foreign-object
    • -
  • leader, but see limitations
    • +
  • leader
  • page-number
  • page-number-citation, see limitations
    • @@ -160,6 +160,10 @@
  • initial-page-number
  • internal-destination
  • keep-with-next (broken)
    • +
  • leader-alignment (not value "page")
    • +
  • leader-length (no percentage values)
    • +
  • leader-pattern (not value "use-content")
    • +
  • leader-pattern-width
  • left
  • line-height
  • margin-bottom (only on pages and regions)
    • @@ -185,18 +189,19 @@
  • provisional-distance-between-starts
  • provisional-label-separation
  • ref-id
    • +
  • region-name
  • right
  • rule-thickness
  • space-after.optimum
  • space-before.optimum
  • src
  • start-indent
    • -
  • textdecoration (only value 'underline' is supported)
    • +
  • textdecoration (only value "underline")
  • text-align
  • text-align-last
  • text-indent
  • top
    • -
  • white-space-treatment (broken)
    • +
  • white-space-collapse
  • width
  • wrap-option
    • diff --git a/docs/html-docs/index.html b/docs/html-docs/index.html index f0e9360db..5f6b8bd18 100644 --- a/docs/html-docs/index.html +++ b/docs/html-docs/index.html @@ -27,10 +27,22 @@ like XT or Xalan) or can be passed in memory as a DOM Document or (in the case of XT) SAX events.

    +

    The latest version of Fop is 0.15 and it supports the xsl:fo candidate release. + You can download + 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 + section specifications. 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 Features and in section + Limitations in what way this support is + limited. +

    FOP is part of Apache's XML project. The homepage of FOP is http://xml.apache.org/fop. A list - of the committers to this project and the tasks they are working on can be found - in the file Status + of known bugs, the committers to this project and the tasks they are working on can be found + in the file Status in the + root of your Fop distribution.


    diff --git a/docs/html-docs/involved.html b/docs/html-docs/involved.html index 8b701fce1..cc89680d5 100644 --- a/docs/html-docs/involved.html +++ b/docs/html-docs/involved.html @@ -29,12 +29,12 @@ to fop-dev-subscribe@xml.apache.org

    Sending bug reports and feature requests to the list is a welcome and important contribution to developing Fop.

    -

    Read also the archive +

    Read also the archive of the discussion list fop-dev to get an idea of the issues being discussed.


    Look at the developer's code using cvs
     

    Between releases the newest code can be accessed via cvs. To do this you need to install a cvs - client on your computer if it is not already there. An explanation how to connect to the + client on your computer, if it is not already there. An explanation how to connect to the Fop source repository can be found at http://xml.apache.org/cvs.html. An introduction into cvs and the cvs manual can be found in the reference library.

    diff --git a/docs/html-docs/limitations.html b/docs/html-docs/limitations.html index f2f194b1c..f06f30429 100644 --- a/docs/html-docs/limitations.html +++ b/docs/html-docs/limitations.html @@ -23,13 +23,6 @@ in features, sometimes it does so only in a limited way.

    -
    leader
      -

    fo:leader is only supported in a very limited way: you can use it to draw simple rules. - Only the property value leader-pattern="rule" is supported. leader-length can be set, - but the value is not used. You should wrap leader into a block element. -

    -

    -
    page-number-citation
     

    Only works for table of contents without any problems. The case where the page number doesn't fit on a line isn't handled, and any text on the same line and after the page-number might not diff --git a/docs/html-docs/running.html b/docs/html-docs/running.html index f2e3b20d7..6d50d7292 100644 --- a/docs/html-docs/running.html +++ b/docs/html-docs/running.html @@ -28,10 +28,14 @@

    c) Fop supports SVG (see Features for further information) and needs the w3c.jar library. This library comes with Fop (xml-fop/lib) and must - be included in your classpath + be included in your classpath. The jar file w3c.jar contains the compiled classes for the + java svg bindings with some other DOM classes that are used by the SVG DOM bindings. + The source for the svg java binding classes can be found at - + SVG Java bindings, currently they correspond to the CR-SVG-20000802 specification document. + The other required files can be found at W3C DOM Java binding.

    d) Optional: Fop supports the jimi library for image processing, if it is in your classpath - when you build Fop. + when you build Fop. You can find it at java.sun.com


    Starting FOP as an standalone application
      diff --git a/docs/html-docs/specs.html b/docs/html-docs/specs.html index 54bfba28d..0dd6afbd1 100644 --- a/docs/html-docs/specs.html +++ b/docs/html-docs/specs.html @@ -19,12 +19,12 @@ License

    +
    Specifications
      +

    +
    Tutorials/Articles
      + +


    Copyright © 1999 The Apache Software Foundation. All Rights Reserved. diff --git a/docs/xml-docs/fop/architecture.xml b/docs/xml-docs/fop/architecture.xml index ac3d4d48d..bb4c00caa 100644 --- a/docs/xml-docs/fop/architecture.xml +++ b/docs/xml-docs/fop/architecture.xml @@ -98,7 +98,7 @@ constructing the FO tree. The key SAX events used are

    Block

    Inline

    -

    SimpleLink

    +

    BasicLink

    diff --git a/docs/xml-docs/fop/bugs.xml b/docs/xml-docs/fop/bugs.xml index 388996391..01de7ffa4 100644 --- a/docs/xml-docs/fop/bugs.xml +++ b/docs/xml-docs/fop/bugs.xml @@ -15,14 +15,9 @@ file with your report, which just demonstrates the problem. Thanks for your help!

    -
      -
    • Colour not continued onto subsequent pages, if coloured block goes over page.
      • -
    • SVG linearGradients don't appear the same as in other SVG Viewers
      • -
    • colour not continued onto subsequent pages if coloured block goes over page
      • -
    • no SVG support in AWTCommandLine
      • -
    • keep-next doesn't work and doubles the text lines which should be moved to the next page
      • -
    • lists containing list do not keep their indentation correctly over a page boundary
      • -
    +

    A list of known bugs can be found at the end of the file + Status in the root + of the Fop distribution.

     diff --git a/docs/xml-docs/fop/examples.xml b/docs/xml-docs/fop/examples.xml index 25fb4899c..c2019a6d7 100644 --- a/docs/xml-docs/fop/examples.xml +++ b/docs/xml-docs/fop/examples.xml @@ -15,11 +15,9 @@
  • normal.fo - a simple file showing the use of a 2 level of headings, normal text and a header.
    • -
  • table.fo - a simple table +
  • table.fo - some table examples
    • -
  • list.fo - a simple list -
    • -
  • list2.fo - some list examples +
  • list.fo - a short tutorial how to use list fo's and properties
  • images.fo - shows how to embed gif and jpg images into the xsl:fo file using external-graphic.
    • @@ -28,7 +26,7 @@
  • extensive.fo - a longer test file containing a lot of different flow objects and properties. A good candidate to test your bugfix or new Fop code.
    • -
  • leader.fo - a very simple example of a rule +
  • leader.fo - shows different uses of fo:leader, p.e. as rule or in a table of content
  • normalex.fo - shows the use of computed property values
    • @@ -36,10 +34,10 @@
  • instream.fo - shows the use of fo:instream-foreign-object together with svg
    • -
  • inhprop.fo - shows the use of inherited property values -
  • textdeko.fo - shows the use of the property textdecoration
    • +
  • readme.fo - uses an old version of Fop documentation for a longer example +
  • Look also into the directory examples/svg. There you find some very extensive svg examples. Just start makedoc. diff --git a/docs/xml-docs/fop/implemented.xml b/docs/xml-docs/fop/implemented.xml index 982611348..1773479b3 100644 --- a/docs/xml-docs/fop/implemented.xml +++ b/docs/xml-docs/fop/implemented.xml @@ -6,7 +6,7 @@

    The following formatting objects and properties of the xsl-fo - working draft (12 October 2000) are implemented.Please have also a look at the + candidate recommendation are implemented.Please have also a look at the section on limitations

    @@ -46,7 +46,7 @@
  • external-graphic
  • inline
  • instream-foreign-object
    • -
  • leader, but see limitations
    • +
  • leader
  • page-number
  • page-number-citation, see limitations
    • @@ -145,6 +145,10 @@
  • initial-page-number
  • internal-destination
  • keep-with-next (broken)
    • +
  • leader-alignment (not value "page")
    • +
  • leader-length (no percentage values)
    • +
  • leader-pattern (not value "use-content")
    • +
  • leader-pattern-width
  • left
  • line-height
  • margin-bottom (only on pages and regions)
    • @@ -170,18 +174,19 @@
  • provisional-distance-between-starts
  • provisional-label-separation
  • ref-id
    • +
  • region-name
  • right
  • rule-thickness
  • space-after.optimum
  • space-before.optimum
  • src
  • start-indent
    • -
  • textdecoration (only value 'underline' is supported)
    • +
  • textdecoration (only value "underline")
  • text-align
  • text-align-last
  • text-indent
  • top
    • -
  • white-space-treatment (broken)
    • +
  • white-space-collapse
  • width
  • wrap-option
    • diff --git a/docs/xml-docs/fop/involved.xml b/docs/xml-docs/fop/involved.xml index e80a55b62..68742cce9 100644 --- a/docs/xml-docs/fop/involved.xml +++ b/docs/xml-docs/fop/involved.xml @@ -22,7 +22,7 @@

    Between releases the newest code can be accessed via cvs. To do this you need to install a cvs - client on your computer if it is not already there. An explanation how to connect to the + client on your computer, if it is not already there. An explanation how to connect to the Fop source repository can be found at http://xml.apache.org/cvs.html. An introduction into cvs and the cvs manual can be found in the reference library.

    diff --git a/docs/xml-docs/fop/limitations.xml b/docs/xml-docs/fop/limitations.xml index d4a88e966..d293c824d 100644 --- a/docs/xml-docs/fop/limitations.xml +++ b/docs/xml-docs/fop/limitations.xml @@ -9,13 +9,6 @@ in features, sometimes it does so only in a limited way.

    - -

    fo:leader is only supported in a very limited way: you can use it to draw simple rules. - Only the property value leader-pattern="rule" is supported. leader-length can be set, - but the value is not used. You should wrap leader into a block element. -

    -     -

    Only works for table of contents without any problems. The case where the page number doesn't fit on a line isn't handled, and any text on the same line and after the page-number might not diff --git a/docs/xml-docs/fop/readme.xml b/docs/xml-docs/fop/readme.xml index 22c187e18..add186b17 100644 --- a/docs/xml-docs/fop/readme.xml +++ b/docs/xml-docs/fop/readme.xml @@ -1,7 +1,6 @@ -