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 vm...@apache.org on 2003/04/29 18:33:46 UTC
cvs commit: xml-fop/src/documentation/content/xdocs/design areas.xml breakpos.xml embedding.xml extending.xml images.xml optimise.xml pdf-library.xml renderers.xml svg.xml useragent.xml
vmote 2003/04/29 09:33:46
Modified: src/documentation/content/xdocs/design areas.xml
breakpos.xml embedding.xml extending.xml images.xml
optimise.xml pdf-library.xml renderers.xml svg.xml
useragent.xml
Log:
Minor changes for consistency with other design docs.
Revision Changes Path
1.11 +4 -2 xml-fop/src/documentation/content/xdocs/design/areas.xml
Index: areas.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/areas.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- areas.xml 22 Apr 2003 02:48:54 -0000 1.10
+++ areas.xml 29 Apr 2003 16:33:45 -0000 1.11
@@ -3,13 +3,14 @@
"http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">
<document>
<header>
- <title>Area Tree</title>
- <subtitle>Area Tree Design for FOP</subtitle>
+ <title>FO Design: Area Tree</title>
<authors>
<person name="Keiron Liddle" email="keiron@aftexsw.com"/>
</authors>
</header>
<body>
+ <section id="intro">
+ <title>Introduction</title>
<p>The Area Tree is an internal representation of the result document, representing pages and their contents.
To make the concepts clearer and easier to understand, the code to implement the area tree matches the areas defined in the XSL-FO specification.</p>
<p>The area tree is created by the layout managers once the layout is decided for a page.
@@ -18,6 +19,7 @@
The data in the area tree must be minimal and independant.
This means that the data uses less memory and can be serialized to an output stream if needed.</p>
<p>The Area Tree consists of a set of pages, which the actual implemenation places in a set of page sequences.</p>
+ </section>
<section id="structure">
<title>Structure</title>
<p>The area tree is a root element that has a list of page-viewport-areas.
1.4 +2 -2 xml-fop/src/documentation/content/xdocs/design/breakpos.xml
Index: breakpos.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/breakpos.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- breakpos.xml 29 Nov 2002 22:00:32 -0000 1.3
+++ breakpos.xml 29 Apr 2003 16:33:45 -0000 1.4
@@ -4,7 +4,7 @@
<document>
<header>
- <title>Layout Managers</title>
+ <title>FOP Design: Layout Managers</title>
<subtitle>Break Possibility Proposal</subtitle>
<authors>
<person name="Karen Lease" email="klease@club-internet.fr"/>
@@ -12,7 +12,7 @@
</header>
<body>
-<section>
+<section id="intro">
<title>Introduction</title>
<p>
As explained in <link href="layout.html">Layout</link>,
1.5 +2 -3 xml-fop/src/documentation/content/xdocs/design/embedding.xml
Index: embedding.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/embedding.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- embedding.xml 13 Apr 2003 17:50:14 -0000 1.4
+++ embedding.xml 29 Apr 2003 16:33:45 -0000 1.5
@@ -4,15 +4,14 @@
<document>
<header>
- <title>Embedding Design</title>
- <subtitle>Design Approach to FOP</subtitle>
+ <title>FOP Design: Embedding FOP in Other Applications</title>
<authors>
<person name="Keiron Liddle" email="keiron@aftexsw.com"/>
</authors>
</header>
<body>
-<section>
+<section id="intro">
<title>Introduction</title>
<p>
This is the design for the external interface when FOP is to be embedded
1.7 +4 -6 xml-fop/src/documentation/content/xdocs/design/extending.xml
Index: extending.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/extending.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- extending.xml 2 Jan 2003 12:59:30 -0000 1.6
+++ extending.xml 29 Apr 2003 16:33:45 -0000 1.7
@@ -4,21 +4,21 @@
<document>
<header>
- <title>FOP Extensions</title>
- <subtitle>Adding extensions to FOP</subtitle>
+ <title>FOP Design: Extensions</title>
<authors>
<person name="Keiron Liddle" email="keiron@aftexsw.com"/>
</authors>
</header>
<body>
-<section>
- <title>Extensions</title>
+<section id="intro">
+ <title>Introduction</title>
<p>
FOP provides an extension mechanism to add extra functionality. There
are a number of different types of extensions that apply to different
steps when converting FO into the rendered output.
</p>
+ </section>
<section>
<title>Extensions</title>
<p>
@@ -98,8 +98,6 @@
>>]]></source>
</section>
-
- </section>
</body>
</document>
1.2 +4 -4 xml-fop/src/documentation/content/xdocs/design/images.xml
Index: images.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/images.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- images.xml 23 Apr 2003 22:33:02 -0000 1.1
+++ images.xml 29 Apr 2003 16:33:45 -0000 1.2
@@ -4,12 +4,12 @@
<document>
<header>
- <title>Images</title>
+ <title>FOP Design: Images</title>
</header>
<body>
- <section>
- <title>Images in FOP</title>
+ <section id="intro">
+ <title>Introduction</title>
<p>Images may only be needed to be loaded when the image is rendered to the
output or to find the dimensions.<br/>
@@ -22,6 +22,7 @@
external graphic in the FO Tree and the image area in the Area Tree only
have the url as a reference.
The images are handled through a static interface in ImageFactory.</p>
+</section>
<section>
<title>Threading</title>
@@ -127,7 +128,6 @@
renderer can insert the image into the document and use that data for all
future references of the same image then it can cache the reference in the
renderer and the image can be released from the image cache.</p>
-</section>
</section>
</body>
1.3 +3 -4 xml-fop/src/documentation/content/xdocs/design/optimise.xml
Index: optimise.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/optimise.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- optimise.xml 19 Nov 2002 07:57:28 -0000 1.2
+++ optimise.xml 29 Apr 2003 16:33:45 -0000 1.3
@@ -4,16 +4,15 @@
<document>
<header>
- <title>FOP Optimisations</title>
- <subtitle>Notes for Optimising FOP</subtitle>
+ <title>FOP Design: Optimisations</title>
<authors>
<person name="Keiron Liddle" email="keiron@aftexsw.com"/>
</authors>
</header>
<body>
-<section>
- <title>Process Optimisations</title>
+<section id="intro">
+ <title>Introduction</title>
<p>
FOP should be able to handle very large documents. A document can be
supplied using SAX and the information should be passed entirely through
1.2 +4 -5 xml-fop/src/documentation/content/xdocs/design/pdf-library.xml
Index: pdf-library.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/pdf-library.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- pdf-library.xml 23 Apr 2003 22:33:02 -0000 1.1
+++ pdf-library.xml 29 Apr 2003 16:33:45 -0000 1.2
@@ -4,16 +4,17 @@
<document>
<header>
- <title>PDF Library</title>
+ <title>FOP Design: PDF Library</title>
</header>
<body>
-<section>
- <title>PDF Library</title>
+<section id="intro">
+ <title>Introduction</title>
<p>The PDF Library is an independant package of classes in FOP. These class
provide a simple way to construct documents and add the contents. The
classes are found in <code>org.apache.fop.pdf.*</code>.</p>
+</section>
<section>
<title>PDF Document</title>
@@ -68,8 +69,6 @@
<p>The are a number of other features for handling pdf markup relevent to creating PDF files for FOP.</p>
</section>
-
- </section>
</body>
</document>
1.9 +11 -9 xml-fop/src/documentation/content/xdocs/design/renderers.xml
Index: renderers.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/renderers.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- renderers.xml 24 Apr 2003 14:53:56 -0000 1.8
+++ renderers.xml 29 Apr 2003 16:33:45 -0000 1.9
@@ -3,20 +3,12 @@
"http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">
<document>
<header>
- <title>Renderers</title>
- <subtitle>Design of Renderers</subtitle>
+ <title>FO Design: Renderers</title>
<authors>
<person name="Keiron Liddle" email="keiron@aftexsw.com"/>
</authors>
</header>
<body>
- <section id="issue-renderers-responsible">
- <title>Renderers are Responsible</title>
- <p>Each renderer is totally responsible for its output format.</p>
- </section>
- <section id="issue-output-stream">
- <title>Send Output to a Stream</title>
- </section>
<section id="intro">
<title>Introduction</title>
<p>A renderer is primarily designed to convert a given area tree into the output
@@ -36,6 +28,16 @@
be rendered is setup by the renderer first so that it can reserve a space
or reference for when the page is ready to be rendered.The renderer is responsible for managing the
output format and associated data and flow.</p>
+ </section>
+ <section id="issues">
+ <title>Design Issues</title>
+ <section id="issue-renderers-responsible">
+ <title>Renderers are Responsible</title>
+ <p>Each renderer is totally responsible for its output format.</p>
+ </section>
+ <section id="issue-output-stream">
+ <title>Send Output to a Stream</title>
+ </section>
</section>
<section id="fonts">
<title>Fonts</title>
1.2 +4 -5 xml-fop/src/documentation/content/xdocs/design/svg.xml
Index: svg.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/svg.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- svg.xml 23 Apr 2003 22:33:02 -0000 1.1
+++ svg.xml 29 Apr 2003 16:33:45 -0000 1.2
@@ -4,11 +4,11 @@
<document>
<header>
- <title>SVG</title>
+ <title>FOP Design: SVG</title>
</header>
<body>
-<section>
- <title>SVG</title>
+<section id="intro">
+ <title>Introduction</title>
<p>SVG is rendered through Batik.</p><p>The XML from the XSL:FO document
is converted into an SVG DOM with batik. This DOM is then set as the Document
on the Foreign Object area in the Area Tree.</p><p>This DOM is then available to
@@ -19,6 +19,7 @@
create the SVG image in the PDF document.</p><p>Most of the work is done in the
PDFGraphics2D class. There are also a few bridges that are plugged into batik
to provide different behaviour for some SVG elements.</p>
+</section>
<section>
<title>Text Drawing</title>
<p>Normally batik converts text into a set of curved
@@ -65,8 +66,6 @@
awt canvas using batik.</p><p>The PS Renderer uses a similar technique as the
PDF Renderer.</p><p>The SVG Renderer simply embeds the SVG inside an svg
element.</p>
-</section>
-
</section>
</body>
1.3 +3 -4 xml-fop/src/documentation/content/xdocs/design/useragent.xml
Index: useragent.xml
===================================================================
RCS file: /home/cvs/xml-fop/src/documentation/content/xdocs/design/useragent.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- useragent.xml 19 Nov 2002 07:57:28 -0000 1.2
+++ useragent.xml 29 Apr 2003 16:33:45 -0000 1.3
@@ -4,16 +4,15 @@
<document>
<header>
- <title>FO User Agent</title>
- <subtitle>Design of FO User Agent</subtitle>
+ <title>FOP Design: User Agent</title>
<authors>
<person name="Keiron Liddle" email="keiron@aftexsw.com"/>
</authors>
</header>
<body>
-<section>
- <title>Purpose</title>
+<section id="intro">
+ <title>Introduction</title>
<p>
Technically the user agent is FOP in the role of determining the
output format and when resolving various attributes. The user
---------------------------------------------------------------------
To unsubscribe, e-mail: fop-cvs-unsubscribe@xml.apache.org
For additional commands, e-mail: fop-cvs-help@xml.apache.org