crossley 02/05/19 01:43:29
Modified: src/documentation/xdocs Tag: cocoon_2_0_3_branch book.xml
src/documentation/xdocs/plan Tag: cocoon_2_0_3_branch
book.xml catalog.xml doc.xml index.xml release.xml
to-avalon.xml
Added: src/documentation/xdocs/plan Tag: cocoon_2_0_3_branch
changes-doc.xml linkalarm-broken.txt
linkalarm-readme.txt todo-doc.xml
Log:
Reviewed some of the planning documents to remove old stuff.
Tidy up in readiness for the Documentation Deluge.
Sync branch with HEAD.
Revision Changes Path
No revision
No revision
1.8.2.2 +2 -0 xml-cocoon2/src/documentation/xdocs/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/book.xml,v
retrieving revision 1.8.2.1
retrieving revision 1.8.2.2
diff -u -r1.8.2.1 -r1.8.2.2
--- book.xml 19 May 2002 08:16:24 -0000 1.8.2.1
+++ book.xml 19 May 2002 08:43:28 -0000 1.8.2.2
@@ -26,6 +26,8 @@
<menu label="Status">
<menu-item label="Changes" href="changes.html"/>
<menu-item label="Todo" href="todo.html"/>
+ <menu-item label="Planning notes" href="plan/index.html"/>
+ <external label="Patch queue"
href="http://nagoya.apache.org/bugzilla/buglist.cgi?bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&email1=&emailtype1=substring&emailassigned_to1=1&email2=&emailtype2=substring&emailreporter2=1&bugidtype=include&bug_id=&changedin=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&product=Cocoon+2&short_desc=%5BPATCH%5D&short_desc_type=allwordssubstr&long_desc=&long_desc_type=allwordssubstr&bug_file_loc=&bug_file_loc_type=allwordssubstr&keywords=&keywords_type=anywords&field0-0-0=noop&type0-0-0=noop&value0-0-0=&namedcmd=Cocoon+all&newqueryname=cocoon+patch+queue&tofooter=1&order=Reuse+same+sort+as+last+time"/>
</menu>
<menu label="Community">
No revision
No revision
1.1.2.1 +11 -4 xml-cocoon2/src/documentation/xdocs/plan/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/book.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- book.xml 3 Jan 2002 12:31:03 -0000 1.1
+++ book.xml 19 May 2002 08:43:28 -0000 1.1.2.1
@@ -9,12 +9,19 @@
<menu-item label="Main" href="../index.html"/>
</menu>
- <menu label="Planning Documents">
+ <menu label="Overview">
+ <menu-item label="Planning Overview" href="index.html"/>
+ </menu>
+
+ <menu label="Documentation">
+ <menu-item label="Doc Overview" href="doc.html"/>
+ <menu-item label="Doc Changes" href="changes-doc.html"/>
+ <menu-item label="Doc To Do" href="todo-doc.html"/>
+ </menu>
+
+ <menu label="Other Planning">
<menu-item label="Release Plan" href="release.html"/>
<menu-item label="To Avalon" href="to-avalon.html"/>
- <menu-item label="Documentation" href="doc.html"/>
<menu-item label="Entity Catalogs" href="catalog.html"/>
</menu>
</book>
-
-
1.1.2.1 +13 -0 xml-cocoon2/src/documentation/xdocs/plan/catalog.xml
Index: catalog.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/catalog.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- catalog.xml 3 Jan 2002 12:31:03 -0000 1.1
+++ catalog.xml 19 May 2002 08:43:28 -0000 1.1.2.1
@@ -89,6 +89,12 @@
<note>TODO: describe overview of issues.</note>
+ <p>
+ Evidently this has
+ <link href="to-avalon.html">already happened</link>.
+ We will need to investigate and see what changes need to be made to the
+ relevant Cocoon docs.
+ </p>
</s1>
<s1 title="Other Notes">
@@ -114,6 +120,13 @@
<ul>
<li>Cocoon distribution + Resolver Resolution ? (avalon-dev 2001-11-12)
discusses licencing issues and moving to Avalon</li>
+ <li><link
href="http://marc.theaimsgroup.com/?l=xml-apache-general&m=100703897109799&w=2";>[vote]
Accepting Entity Resolver Donation</link>
+ (apache-general 2001-11-29)</li>
+ <li>[excalibur] Catalog code
+ (avalon-dev, cocoon-dev 2001-09-23)</li>
+ <li>
+ <link
href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=100303902726035&w=2";>cvs
commit: xml-cocoon2 LISCENSE.resolver</link>
+ (cocoon-dev 2001-10-14)</li>
</ul>
</s1>
1.1.2.1 +28 -43 xml-cocoon2/src/documentation/xdocs/plan/doc.xml
Index: doc.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/doc.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- doc.xml 3 Jan 2002 12:31:03 -0000 1.1
+++ doc.xml 19 May 2002 08:43:28 -0000 1.1.2.1
@@ -3,7 +3,7 @@
<document>
<header>
- <title>Documentation revisions and additions</title>
+ <title>Documentation Revisions and Additions</title>
<subtitle>Overview</subtitle>
<authors>
<person name="David Crossley" email="[EMAIL PROTECTED]"/>
@@ -22,38 +22,34 @@
required additional documents. At the bottom is a list of general issues.
</p>
+ <p>Please also see the <link href="todo-doc.html">Documentation To Do
+ List</link> and the <link href="changes-doc.html">Documentation History of
+ Changes</link>.
+ </p>
</s1>
<s1 title="Revisions required">
- <ul>
- <li>Announcement (announcement.xml)
- <ul>
- <li>Needs to be more positive</li>
- <li>Needs a concise overview of Cocoon (which can be re-used on the home
page)</li>
- </ul>
- </li>
-
- <li>The home page (index.xml)
- <ul>
- <li>needs to be more positive</li>
- <li>Can now stop apologising for Cocoon 1</li>
- <li>Needs concise overiew at top - "What is It"</li>
- </ul>
- </li>
-
- <li>Frequently Asked Questions
- <ul>
- <li>Needs re-structure or we will have the same un-wieldy monster FAQ as
+ <s2 title="Frequently Asked Questions">
+ <ul>
+ <li>Needs re-structure or we will have the same un-wieldy monster FAQ as
for Cocoon 1.
- </li>
- </ul>
- </li>
+ </li>
+ </ul>
+ </s2>
+
+ <s2 title="XSP Internals">
+ <ul>
+ <li>This document (userdocs/xsp/xsp-internals.xml) had stacks of broken
+ links to old Javadocs. Perhaps this indicates that the whole document
+ needs revision.
+ </li>
+ </ul>
+ </s2>
- </ul>
</s1>
- <s1 title="Fix the placeholder documents">
+ <s1 title="Fix any placeholder documents">
<p>
These pages have a shell, but no content yet. They currently have the
@@ -63,15 +59,6 @@
<ul>
<li>Index pages for "Developing" and "Userdocs"</li>
<li>userdocs/actions/actions.xml</li>
-<!--
- <li>
- <ul>
- <li>
- </li>
- </ul>
- </li>
--->
-
</ul>
</s1>
@@ -79,15 +66,6 @@
<ul>
<li></li>
-<!--
- <li>
- <ul>
- <li>
- </li>
- </ul>
- </li>
--->
-
</ul>
</s1>
@@ -107,6 +85,13 @@
<li>All documentation needs to be continually revised. It cannot be written
and then never updated. It needs to keep in step with the code and
configuration changes.
+ </li>
+
+ <li>The excellent LinkAlarm service is used after each major public release
+ of Cocoon to help discover any broken internal or external links. Please
+ see the README file at
+ <link href="linkalarm-readme.txt">linkalarm-readme.txt</link>
+ and help to attend to any issues.
</li>
</ul>
1.1.2.1 +10 -5 xml-cocoon2/src/documentation/xdocs/plan/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/index.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- index.xml 3 Jan 2002 12:31:03 -0000 1.1
+++ index.xml 19 May 2002 08:43:28 -0000 1.1.2.1
@@ -3,7 +3,7 @@
<document>
<header>
- <title>Planning Documentation</title>
+ <title>Planning Notes</title>
<subtitle>Overview</subtitle>
<authors>
<person name="David Crossley" email="[EMAIL PROTECTED]"/>
@@ -17,7 +17,7 @@
development.
</p>
- <p>There is much discussion of issues and research topics (RT) threads on
+ <p>There is much discussion of issues and Random Thought (RT) threads on
the <code>cocoon-dev</code> mailing list (and elsewhere). However, details
get lost in the sheer volume. This is the place to document the summary of
discussions on some key topics. Some new and complex capabilities will take
@@ -44,11 +44,16 @@
<s1 title="Topics and Issues">
<ul>
- <li><link href="release.html">Release Plan</link>
- - major things to do before the 2.0 release</li>
- <li><link href="to-avalon.html">Moving some Components to Avalon</link></li>
<li><link href="doc.html">Documentation</link>
- revisions and additions are required</li>
+ <li><link href="changes-doc.html">Documentation History of Changes</link></li>
+ <li><link href="todo-doc.html">Documentation To Do List</link></li>
+ </ul>
+
+ <ul>
+ <li><link href="release.html">Release Plan</link>
+ - major things to do before the next release</li>
+ <li><link href="to-avalon.html">Moving some Components to Avalon</link></li>
<li><link href="catalog.html">Entity Catalogs</link>
- the entity resolver</li>
<li>See the general <link href="../todo.html">To Do</link> list
1.1.2.1 +2 -5 xml-cocoon2/src/documentation/xdocs/plan/release.xml
Index: release.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/release.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
--- release.xml 3 Jan 2002 12:31:03 -0000 1.1
+++ release.xml 19 May 2002 08:43:28 -0000 1.1.2.1
@@ -3,7 +3,7 @@
<document>
<header>
- <title>Release Plan 2.0</title>
+ <title>Release Plan</title>
<subtitle>Planning Documentation</subtitle>
<authors>
<person name="David Crossley" email="[EMAIL PROTECTED]"/>
@@ -11,10 +11,7 @@
</header>
<body>
- <s1 title="Preparation for release of Apache Cocoon 2.0">
-
- <p>The 2.0 final release is scheduled for the end of November 2001.
- </p>
+ <s1 title="Preparation for the next release of Apache Cocoon">
<p>
The following is extracted from the thread
1.1.2.2 +8 -8 xml-cocoon2/src/documentation/xdocs/plan/to-avalon.xml
Index: to-avalon.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/to-avalon.xml,v
retrieving revision 1.1.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- to-avalon.xml 9 Apr 2002 06:49:42 -0000 1.1.2.1
+++ to-avalon.xml 19 May 2002 08:43:28 -0000 1.1.2.2
@@ -30,7 +30,7 @@
<li>XMLFragment</li>
<li>Parser (done)</li>
<li>XMLSerializer/XMLDeserializer</li>
- <li>XSLTProcessor</li>
+ <li>XSLTProcessor (done)</li>
</ul>
<p>Everything dealing with Source objects. (This is the part
@@ -38,11 +38,11 @@
</p>
<ul>
- <li>SourceResolver</li>
- <li>SourceHandler</li>
- <li>SourceFactory</li>
- <li>Source</li>
- <li>ModifiableSource</li>
+ <li>SourceResolver (done)</li>
+ <li>SourceHandler (done)</li>
+ <li>SourceFactory (done)</li>
+ <li>Source (done)</li>
+ <li>ModifiableSource (done)</li>
</ul>
<p>List of Implementations:</p>
@@ -50,8 +50,8 @@
<li>AbstractXMLConsumer</li>
<li>JaxpParser, XercesParser (done)</li>
<li>XMLByteStreamCompiler/XMLByteStreamInterpreter</li>
- <li>Everything dealing with Source objects</li>
- <li>XSLTProcessorImpl</li>
+ <li>Everything dealing with Source objects (done)</li>
+ <li>XSLTProcessorImpl (done)</li>
<li><link href="catalog.html">Entity Catalogs </link>
- the entity resolver (done)</li>
</ul>
No revision
No revision
1.6.2.1 +1 -22 xml-cocoon2/src/documentation/xdocs/plan/changes-doc.xml
Index: changes-doc.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/changes-doc.xml,v
retrieving revision 1.6
retrieving revision 1.6.2.1
diff -u -r1.6 -r1.6.2.1
--- changes-doc.xml 17 May 2002 12:48:47 -0000 1.6
+++ changes-doc.xml 19 May 2002 08:43:28 -0000 1.6.2.1
@@ -4,7 +4,7 @@
<!--
History of Cocoon Documentation changes
- $Id: changes-doc.xml,v 1.6 2002/05/17 12:48:47 crossley Exp $
+ $Id: changes-doc.xml,v 1.6.2.1 2002/05/19 08:43:28 crossley Exp $
-->
<changes title="Documentation History of Changes">
@@ -16,27 +16,6 @@
</devs>
<release version="@version@" date="@date@">
-
- <action dev="DC" type="add">
- Added new draft
- <link href="../howto/howto-bugzilla.html">How to Contribute a Patch
- via Bugzilla</link>.
- </action>
-
- <action dev="DS" type="add">
- Added Tutorial section. Moved existing tutorial to new
- location. Added draft tutorial contribution
- </action>
-
- <action dev="DS" type="add">
- Added <link href="../howto/index.html">How-To section</link>.
- Added new How to author How-To and FAQ articles.
- </action>
-
- <action dev="DS" type="update">
- Added new <link href="../faq/index.html">FAQ categories</link>.
- Restructured FAQ content to facilitate user contributions via patches.
- </action>
<action dev="DC" type="update">
Reviewed the <link href="linkalarm-readme.txt">LinkAlarm report</link>
1.1.2.1 +0 -0 xml-cocoon2/src/documentation/xdocs/plan/linkalarm-broken.txt
Index: linkalarm-broken.txt
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/linkalarm-broken.txt,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.1.2.1 +0 -0 xml-cocoon2/src/documentation/xdocs/plan/linkalarm-readme.txt
Index: linkalarm-readme.txt
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/linkalarm-readme.txt,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
1.7.2.1 +1 -1 xml-cocoon2/src/documentation/xdocs/plan/todo-doc.xml
Index: todo-doc.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/todo-doc.xml,v
retrieving revision 1.7
retrieving revision 1.7.2.1
diff -u -r1.7 -r1.7.2.1
--- todo-doc.xml 19 May 2002 03:52:43 -0000 1.7
+++ todo-doc.xml 19 May 2002 08:43:28 -0000 1.7.2.1
@@ -3,7 +3,7 @@
<!DOCTYPE todo PUBLIC "-//APACHE//DTD Todo V1.0//EN" "../dtd/todo-v10.dtd">
<!--
- $Id: todo-doc.xml,v 1.7 2002/05/19 03:52:43 crossley Exp $
+ $Id: todo-doc.xml,v 1.7.2.1 2002/05/19 08:43:28 crossley Exp $
-->
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
