shannon 2002/07/03 18:41:09
Modified: src/documentation/xdocs/plan Tag: cocoon_2_0_3_branch
book.xml changes-doc.xml doc.xml index.xml
release.xml todo-doc.xml
Added: src/documentation/xdocs/plan Tag: cocoon_2_0_3_branch
issues-doc.xml proposed-toc.xml
Log:
sync with HEAD
Revision Changes Path
No revision
No revision
1.1.2.4 +5 -3 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.2.3
retrieving revision 1.1.2.4
diff -u -r1.1.2.3 -r1.1.2.4
--- book.xml 1 Jul 2002 10:07:24 -0000 1.1.2.3
+++ book.xml 4 Jul 2002 01:41:08 -0000 1.1.2.4
@@ -14,14 +14,16 @@
</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-item label="Overview" href="doc.html"/>
+ <menu-item label="Changes" href="changes-doc.html"/>
+ <menu-item label="To Do" href="todo-doc.html"/>
+ <menu-item label="Issues" href="issues-doc.html"/>
</menu>
<menu label="Other Planning">
<menu-item label="Release Plan" href="release.html"/>
<menu-item label="Cocoon Samples" href="samples.html"/>
<menu-item label="Entity Catalogs" href="catalog.html"/>
+ <menu-item label="Proposed TOC" href="proposed-toc.html"/>
</menu>
</book>
1.6.2.5 +29 -3 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.2.4
retrieving revision 1.6.2.5
diff -u -r1.6.2.4 -r1.6.2.5
--- changes-doc.xml 1 Jul 2002 10:10:28 -0000 1.6.2.4
+++ changes-doc.xml 4 Jul 2002 01:41:08 -0000 1.6.2.5
@@ -12,14 +12,41 @@
<devs>
<!-- in strict alphabetical order -->
<person name="David Crossley" email="[EMAIL PROTECTED]" id="DC"/>
+ <person name="Bernhard Huber" email="[EMAIL PROTECTED]" id="BH"/>
<person name="Ivelin Ivanov" email="[EMAIL PROTECTED]" id="II"/>
<person name="Diana Shannon" email="[EMAIL PROTECTED]" id="DS"/>
</devs>
<release version="@version@" date="@date@">
+ <action dev="DS" type="update">
+ Updated and refactored some planning docs.
+ </action>
+
+ <action dev="DS" type="add" due-to="Betrand Delacretaz"
due-to-email="[EMAIL PROTECTED]">
+ Added new How-To for HTML-PDF Publishing.
+ </action>
+
+ <action dev="DS" type="add">
+ Added new How-To for Authoring Core Docs.
+ </action>
+
+ <action dev="DS" type="add">
+ Added new How-To for PaginatorTransformer.
+ </action>
+
+ <action dev="BH" type="add">
+ Added simple user documentation of LinkStatus Generator.
+ </action>
+
+ <action dev="DC" type="add">
+ Encourage people to help with the refactoring of Cocoon samples.
+ Provide a
+ <link href="samples.html">refactoring guidelines</link> document.
+ </action>
+
<action dev="DC" type="add" due-to="Andrew Savory" due-to-email="[EMAIL
PROTECTED]">
- Added overview documentation for
+ Added overview documentation for
<link href="../userdocs/concepts/xmlform.html">XMLForm Handling</link>.
</action>
@@ -27,7 +54,6 @@
New <link href="../snippet/index.html">Snippet</link> section added, along
with first <link
href="../snippet/snippet-internal-pipeline.html">Snippet</link> and <link
href="../howto/howto-author-snippet.html">Snippet How-To</link>.
</action>
-
<action dev="DS" type="add">
Added additional FAQs pages: <link
href="../faq/faq-actions.html">Actions</link>,
1.1.2.2 +25 -73 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.2.1
retrieving revision 1.1.2.2
diff -u -r1.1.2.1 -r1.1.2.2
--- doc.xml 19 May 2002 08:43:28 -0000 1.1.2.1
+++ doc.xml 4 Jul 2002 01:41:08 -0000 1.1.2.2
@@ -3,99 +3,51 @@
<document>
<header>
- <title>Documentation Revisions and Additions</title>
+ <title>About the Cocoon Documentation Effort</title>
<subtitle>Overview</subtitle>
<authors>
<person name="David Crossley" email="[EMAIL PROTECTED]"/>
+ <person name="Diana Shannon" email="[EMAIL PROTECTED]"/>
</authors>
</header>
<body>
<s1 title="Overview">
- <p>Of course, the Cocoon documentation is always undergoing evolution.
- These notes remind us of some things that have been discussed and not
- yet implemented.
- </p>
-
- <p>The following sections list some documents that need revision and some
- required additional documents. At the bottom is a list of general issues.
+ <p>
+There is a concerted effort underway at this time to improve Cocoon's
documentation. This effort is based on the belief that open source documents
can be as first-rate as the software on which they are based. However, such an
endeavor is entirely dependent upon vital and timely forms of contributions
from developers and users alike. Make no mistake about it; everyone is needed
and invited to participate in this effort!
</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>
+While we have a lot to do, there are evolving structures in place to
facilitate and enhance your efforts. We have numerous guidelines for authoring
documents, a document-specific email list, and a complementary documentation
architectural project at <link
href="http://xml.apache.org/forrest/";>Forrest</link>. If you choose to become
involved, you will discover many like-minded developers and users who care
about Cocoon documentation and will support your effort. Here are a few ideas
to help you get started.
</p>
- </s1>
-
- <s1 title="Revisions required">
-
- <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>
+
+ <s2 title="Cocoon Docs List">
+<p>
+Find out what documentation efforts are already in process among other users
and committers. First and foremost, join the Cocoon <link href="mailto:[EMAIL
PROTECTED]">docs list</link>.
+</p>
</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 title="Forms of Document Contributions">
+ <p>
+Check out Cocoon's How-To guidelines to learn about the variety of ways to
contribute or improve Cocoon documents.
+ </p>
+ <ul>
+<li><link href="../howto/howto-author-faq.html">How to Author an
FAQ</link></li>
+<li><link href="../howto/howto-author-howto.html">How to Author a
How-To</link></li>
+<li><link href="../howto/howto-author-snippet.html">How to Author a Code
Snippet</link></li>
+<li><link href="../howto/howto-author-core-docs.html">How to Author Core
Documentation</link></li>
+ </ul>
</s2>
-
- </s1>
-
- <s1 title="Fix any placeholder documents">
-
+
+ <s2 title="Other Information">
<p>
- These pages have a shell, but no content yet. They currently have the
- embarrassing "Under Construction" type of notice.
+If you're interested in reviewing recent documentation additions or
substantive modifications, see the documentation <link href="changes-doc.html">
History of Changes</link>. You may also want to check out the
documentation-specific <link href="todo-doc.html">To-Do List</link>. You can
also take an advance look at a proposed <link href="proposed-toc.html">table of
contents</link> for a revised Cocoon guide. You may also be interested in
reviewing some <link href="issues-doc.html">general and specific issues</link>
related to Cocoon documentation. Your comments and feedback on any of the above
are welcome on the cocoon-docs list.
</p>
-
- <ul>
- <li>Index pages for "Developing" and "Userdocs"</li>
- <li>userdocs/actions/actions.xml</li>
- </ul>
- </s1>
-
- <s1 title="Additional documents required">
-
- <ul>
- <li></li>
- </ul>
+ </s2>
</s1>
- <s1 title="General Issues">
-
- <p>Certain issues need to be addressed for all current and future
- documentation.
- </p>
- <ul>
- <li>Many pages use source elements to list code or configuration
information.
- Wide pre-formatted text lines do not word-wrap in HTML output and so the
- user would need to painfully scroll left-and-right to read the page.
- </li>
-
- <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>
-
- </s1>
</body>
</document>
1.1.2.5 +2 -0 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.2.4
retrieving revision 1.1.2.5
diff -u -r1.1.2.4 -r1.1.2.5
--- index.xml 1 Jul 2002 10:07:24 -0000 1.1.2.4
+++ index.xml 4 Jul 2002 01:41:08 -0000 1.1.2.5
@@ -53,6 +53,7 @@
- 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>
+ <li><link href="issues-doc.html">Documentation Issues</link></li>
</ul>
<ul>
@@ -62,6 +63,7 @@
<li><link href="catalog.html">Entity Catalogs</link>
- stuff that needs to happen the to entity resolver after the move to
Avalon of Source resolving</li>
+ <li><link href="proposed-toc.html">Proposed TOC, Cocoon Guide</link></li>
<li>See the general <link href="../todo.html">To Do</link> list
and the <code>cocoon-dev</code> email archives for other issues</li>
</ul>
1.1.2.7 +1 -1 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.2.6
retrieving revision 1.1.2.7
diff -u -r1.1.2.6 -r1.1.2.7
--- release.xml 2 Jul 2002 10:33:02 -0000 1.1.2.6
+++ release.xml 4 Jul 2002 01:41:08 -0000 1.1.2.7
@@ -16,7 +16,7 @@
<p>This is the current time frame for the next releases:</p>
<ul>
<li>July/August 2002 : Release date for 2.0.3 (bug fix release)</li>
- <li>August/Semptember 2002 : Release date for 2.1 Alpha 1</li>
+ <li>August/September 2002 : Release date for 2.1 Alpha 1</li>
</ul>
</s1>
1.7.2.3 +5 -25 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.2.2
retrieving revision 1.7.2.3
diff -u -r1.7.2.2 -r1.7.2.3
--- todo-doc.xml 7 Jun 2002 19:57:02 -0000 1.7.2.2
+++ todo-doc.xml 4 Jul 2002 01:41:08 -0000 1.7.2.3
@@ -48,8 +48,8 @@
<link
href="http://marc.theaimsgroup.com/?l=xml-cocoon-dev&m=102056702426129";>Javadocs:
need basic package information</link>
</action>
- <action context="docs" assigned-to="DS">
- Develop how-to author FAQ, How-To, Tutorial, and Snippet documents.
+ <action context="docs" assigned-to="open">
+ Develop how-to author Tutorial and Recipe documents.
</action>
<action context="docs" assigned-to="open">
@@ -67,15 +67,7 @@
<action context="docs" assigned-to="DS">
Develop basic editing conventions for project.
</action>
-
- <action context="docs" assigned-to="open">
- Develop how-to contribute to documentation effort document.
- </action>
-
- <action context="docs" assigned-to="open">
- Develop dtds, templates, and stylesheets for all how-to author documents.
- </action>
-
+
<action context="docs" assigned-to="open">
Develop status page of in-process documents and topics.
</action>
@@ -108,11 +100,7 @@
<action context="docs" assigned-to="open">
Provide technical review of draft tutorial: "Developing Your Own
Generator."
</action>
-
- <action context="docs" assigned-to="open">
- Provide technical review of draft tutorial/how-to: "Developing Your
Own Source."
- </action>
-
+
<action context="docs" assigned-to="open">
Expand documentation infrastructure (XSLT, indexing, etc.) to provide
efficient user
access to multiple FAQs, How-Tos, Snippets, Tutorials, etc.
@@ -120,14 +108,6 @@
<action context="docs" assigned-to="open">
Revise web site navigation/hierarchy to make all documentation more
accessible.
- </action>
-
- <action context="docs" assigned-to="open">
- Add documentation effort-related website pages to documentation build and
sitemap to increase visibility and coordinate efforts. This includes planning
docs and contributor how-tos.
- </action>
-
- <action context="docs" assigned-to="open">
- Update and add category headings to Cocoon Links page.
</action>
</actions>
No revision
No revision
1.1.2.1 +0 -0 xml-cocoon2/src/documentation/xdocs/plan/issues-doc.xml
Index: issues-doc.xml
===================================================================
RCS file: /home/cvs/xml-cocoon2/src/documentation/xdocs/plan/issues-doc.xml,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/proposed-toc.xml
Index: proposed-toc.xml
===================================================================
RCS file:
/home/cvs/xml-cocoon2/src/documentation/xdocs/plan/proposed-toc.xml,v
retrieving revision 1.1
retrieving revision 1.1.2.1
diff -u -r1.1 -r1.1.2.1
----------------------------------------------------------------------
In case of troubles, e-mail: [EMAIL PROTECTED]
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
