aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorWilliam Victor Mote <vmote@apache.org>2003-04-30 18:54:41 +0000
committerWilliam Victor Mote <vmote@apache.org>2003-04-30 18:54:41 +0000
commit5e3d0cddc1d7c5f4778443beebc4c1ea25b41452 (patch)
tree4d656689a215508235a32257532e1de89d85f535 /src
parent61cfedc2aaf18096f8d123b9789e672975fc0ca5 (diff)
downloadxmlgraphics-fop-5e3d0cddc1d7c5f4778443beebc4c1ea25b41452.tar.gz
xmlgraphics-fop-5e3d0cddc1d7c5f4778443beebc4c1ea25b41452.zip
Move contents of design/status.xml (not currently published anywhere) to the various subsystem doc in a "status" section.
Add startup.xml document as a stub to contain config, control, and env status content. Remove design/status.xml. git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@196377 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src')
-rw-r--r--src/documentation/content/xdocs/design/areas.xml16
-rw-r--r--src/documentation/content/xdocs/design/book.xml1
-rw-r--r--src/documentation/content/xdocs/design/extending.xml22
-rw-r--r--src/documentation/content/xdocs/design/layout.xml18
-rw-r--r--src/documentation/content/xdocs/design/parsing.xml17
-rw-r--r--src/documentation/content/xdocs/design/renderers.xml17
-rw-r--r--src/documentation/content/xdocs/design/startup.xml39
-rw-r--r--src/documentation/content/xdocs/design/status.xml76
8 files changed, 129 insertions, 77 deletions
diff --git a/src/documentation/content/xdocs/design/areas.xml b/src/documentation/content/xdocs/design/areas.xml
index 577dd3c7e..a32ccb1c8 100644
--- a/src/documentation/content/xdocs/design/areas.xml
+++ b/src/documentation/content/xdocs/design/areas.xml
@@ -154,5 +154,21 @@ page as it is added.</p>
<p>The Area Tree retains the concept of page sequences (this is not in the area tree in the spec) so that this information can be passed to the renderer.
This is useful for setting the title and organising the groups of page sequences.</p>
</section>
+ <section id="status">
+ <title>Status</title>
+ <section id="status-todo">
+ <title>To Do</title>
+ </section>
+ <section id="status-wip">
+ <title>Work in Progress</title>
+ </section>
+ <section id="status-complete">
+ <title>Completed</title>
+ <ul>
+ <li>new area tree model</li>
+ <li>changed area tree xml format to match the area tree hierarchy</li>
+ </ul>
+ </section>
+ </section>
</body>
</document>
diff --git a/src/documentation/content/xdocs/design/book.xml b/src/documentation/content/xdocs/design/book.xml
index 4910374bb..3ce34fe7f 100644
--- a/src/documentation/content/xdocs/design/book.xml
+++ b/src/documentation/content/xdocs/design/book.xml
@@ -11,6 +11,7 @@
<menu-item label="Introduction" href="index.html"/>
</menu>
<menu label="Core Process">
+ <menu-item label="Startup" href="startup.html"/>
<menu-item label="XML Parsing" href="parsing.html"/>
<menu-item label="FO Tree" href="fotree.html"/>
<menu-item label="Properties" href="properties.html"/>
diff --git a/src/documentation/content/xdocs/design/extending.xml b/src/documentation/content/xdocs/design/extending.xml
index 469b1b4e0..92f390ca6 100644
--- a/src/documentation/content/xdocs/design/extending.xml
+++ b/src/documentation/content/xdocs/design/extending.xml
@@ -98,7 +98,27 @@ to result in a text box referencing the following PDF action:</p>
>>]]></source>
</section>
-
+ <section id="status">
+ <title>Status</title>
+ <section id="status-todo">
+ <title>To Do</title>
+ </section>
+ <section id="status-wip">
+ <title>Work In Progress</title>
+ <ul>
+ <li>mathml extension</li>
+ <li>another xml -> svg extension</li>
+ <li>svg text normal text if that can be handled otherwise stroked this is done automatically</li>
+ </ul>
+ </section>
+ <section id="status-complete">
+ <title>Completed</title>
+ <ul>
+ <li>svg now in an xml handler, FOP can be used without batik</li>
+ <li>bookmark extension improved a bit - changed bookmark extension, now requires a wrapping element bookmark</li>
+ </ul>
+ </section>
+ </section>
</body>
</document>
diff --git a/src/documentation/content/xdocs/design/layout.xml b/src/documentation/content/xdocs/design/layout.xml
index b09b8fd5f..f0aa106c3 100644
--- a/src/documentation/content/xdocs/design/layout.xml
+++ b/src/documentation/content/xdocs/design/layout.xml
@@ -280,5 +280,23 @@ This handles the situation where before floats or footnotes may have been remove
The areas are then placed on a last page.</p>
</section>
</section>
+ <section id="status">
+ <title>Status</title>
+ <section id="status-todo">
+ <title>To Do</title>
+ </section>
+ <section id="status-wip">
+ <title>Work in Progress</title>
+ <ul>
+ <li><strong>better layout design</strong> - that can handle keeps and spacing better</li>
+ <li><strong>better area tree handling</strong> - means it can run in less memory</li>
+ <li>new area tree model</li>
+ <li>changed area tree xml format to match the area tree hierarchy</li>
+ </ul>
+ </section>
+ <section id="status-complete">
+ <title>Completed</title>
+ </section>
+ </section>
</body>
</document>
diff --git a/src/documentation/content/xdocs/design/parsing.xml b/src/documentation/content/xdocs/design/parsing.xml
index d2e38d47a..361cc7778 100644
--- a/src/documentation/content/xdocs/design/parsing.xml
+++ b/src/documentation/content/xdocs/design/parsing.xml
@@ -38,5 +38,22 @@ Instead, FOP takes SAX events and builds its own tree-like structure. Why?</p>
<p>See <link href="../extensions.html">User Extensions</link> for a discussion of standard extensions shipped with FOP, and their related namespaces.</p>
<p>See <link href="../dev/extensions.html">Developer Extensions</link> for a discussion of the mechanisms in place to allow developers to add their own extensions, including how to tell FOP about the foreign namespace.</p>
</section>
+ <section id="status">
+ <title>Status</title>
+ <section id="status-todo">
+ <title>To Do</title>
+ </section>
+ <section id="status-wip">
+ <title>Work In Progress</title>
+ </section>
+ <section id="status-complete">
+ <title>Completed</title>
+ <ul>
+ <li>better handling of unknown xml and xml from an unknown namespace</li>
+ <li>Changed extensions to allow for external xml</li>
+ <li>Can have a default element mapping for extensions</li>
+ </ul>
+ </section>
+ </section>
</body>
</document>
diff --git a/src/documentation/content/xdocs/design/renderers.xml b/src/documentation/content/xdocs/design/renderers.xml
index 5d1831a19..643131b8c 100644
--- a/src/documentation/content/xdocs/design/renderers.xml
+++ b/src/documentation/content/xdocs/design/renderers.xml
@@ -191,5 +191,22 @@ AbstractRenderer's methods can easily be overridden to handle things in a differ
<p>The layout of the document depends mainly on the font being used.
If two renderers have the same font metrics then it is possible to use the same Area Tree to render both. This can be handled by the AreaTree Handler.</p>
</section>
+ <section id="status">
+ <title>Status</title>
+ <section id="status-todo">
+ <title>To Do</title>
+ </section>
+ <section id="status-wip">
+ <title>Work In Progress</title>
+ </section>
+ <section id="status-complete">
+ <title>Completed</title>
+ <ul>
+ <li>new renderer model</li>
+ <li>new interface for structured documents, rtf and mif</li>
+ <li>added handlers for xml in renderer</li>
+ </ul>
+ </section>
+ </section>
</body>
</document>
diff --git a/src/documentation/content/xdocs/design/startup.xml b/src/documentation/content/xdocs/design/startup.xml
new file mode 100644
index 000000000..b73d1544b
--- /dev/null
+++ b/src/documentation/content/xdocs/design/startup.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
+ "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">
+<document>
+ <header>
+ <title>FOP Design: Startup, Environment, Control</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p>Startup is the process of getting FOP bootstrapped and creating basic objects. Environment includes acquiring user options, instantiating any frameworks, setting up logging, etc. Control includes the basic logic for tieing the various subsystems together properly.</p>
+ </section>
+ <section id="status">
+ <title>Status</title>
+ <section id="status-todo">
+ <title>To Do</title>
+ <ul>
+ <li>avalon integration - logging, configuration, component management, caching, uri resolver</li>
+ <li>improved interfaces
+ <ul>
+ <li>no threading/static problems</li>
+ <li>simpler to use</li>
+ </ul>
+ </li>
+ <li>better commandline handling</li>
+ </ul>
+ </section>
+ <section id="status-wip">
+ <title>Work In Progress</title>
+ </section>
+ <section id="status-complete">
+ <title>Completed</title>
+ <ul>
+ <li><strong>better image handling</strong> - redone so it can use a cache and synchronizes properly only on the current image while loading</li>
+ </ul>
+ </section>
+ </section>
+ </body>
+</document>
diff --git a/src/documentation/content/xdocs/design/status.xml b/src/documentation/content/xdocs/design/status.xml
deleted file mode 100644
index fcc24db07..000000000
--- a/src/documentation/content/xdocs/design/status.xml
+++ /dev/null
@@ -1,76 +0,0 @@
-<?xml version="1.0" standalone="no"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN"
- "http://cvs.apache.org/viewcvs.cgi/*checkout*/xml-forrest/src/resources/schema/dtd/document-v11.dtd">
-
-<!-- Status of Design/Rewrite -->
-
-<document>
- <header>
- <title>Design Status</title>
- <subtitle>Current Status of FOP and Design</subtitle>
- <authors>
- <person name="Keiron Liddle" email="keiron@aftexsw.com"/>
- </authors>
- </header>
-
- <body>
-<section>
- <title>Status</title>
-<p>
-Currently some of FOP is being re-written so that the layout can be handled
-properly without the problems that have been encountered and to make
-it possible to handle keeps/breaks and spacing better.
- </p>
-<p>
-A number of issues have been dealt with in the redesigned code.
- </p>
- </section>
-<section>
- <title>Features TODO</title>
-<ul>
-<li>avalon integration - logging, configuration, component management, caching, uri resolver</li>
-<li>improved interfaces
-<ul>
- <li>no threading/static problems</li>
- <li>simpler to use</li>
-</ul>
-</li>
-<li>better commandline handling</li>
-</ul>
- </section>
-<section>
- <title>Done/Started Features</title>
-<p>
-Many of these changes will make FOP much better to use and develop.
-So if you help out with the development you can get to use these
-things sooner.
-</p>
-<ul>
-<li><strong>better layout design</strong> - that can handle keeps and
-spacing better</li>
-<li><strong>better area tree handling</strong> - means it can run in
-less memory</li>
-<li><strong>better image handling</strong> - redone so it can use a
-cache and synchronizes properly only on the current image while loading</li>
-<li>svg now in an xml handler, FOP can be used without batik</li>
-<li>bookmark extension improved a bit - changed bookmark extension,
-now requires a wrapping element bookmark</li>
-<li>new interface for structured documents, rtf and mif</li>
-<li>better handling of unknown xml and xml from an unknown namespace</li>
-<li>Changed extensions to allow for external xml</li>
-<li>Can have a default element mapping for extensions</li>
-<li>mathml extension</li>
-<li>another xml -> svg extension</li>
-<li>svg text normal text if that can be handled otherwise stroked
-this is done automatically</li>
-<li>new area tree model</li>
-<li>new renderer model</li>
-<li>added handlers for xml in renderer</li>
-<li>changed area tree xml format to match the area tree hierarchy</li>
-</ul>
-
- </section>
-
- </body>
-</document>
-