Update of /cvsroot/rubydoc/rubydoc
In directory usw-pr-cvs1:/tmp/cvs-serv12889
Modified Files:
VISION
Log Message:
*) Might as well update this given that I'm getting closer to actually diving
into code
*) Updated VISION to include explicit mention of the use of DocBook in
rubydoc
*) Explain that a rubydoc file will be a distribution package that can be
untar'ed and extracted into runtime components upon installation.
*) XML is the wrapper for distribution. MIME64 encoded binary files (gzipped
sources, images, sources, or otherwise) included in the XML will be the
distribution mechanisms.
Index: VISION
===================================================================
RCS file: /cvsroot/rubydoc/rubydoc/VISION,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- VISION 29 Aug 2001 19:03:33 -0000 1.1
+++ VISION 18 May 2002 04:54:28 -0000 1.2
@@ -9,7 +9,8 @@
3) A compolation tool used to dump the collected from the online forum
into a distributable medium so that comments are available from the
- CLI (data probably stored in rd or XML).
+ CLI (data probably stored in DocBook XML: need to vamp up Ruby's
+ support for DocBook).
4) A CLI that will let you, if you have a net connection, browse the
online rubydoc comments (probably SOAP).
@@ -25,6 +26,16 @@
8) The online forum will have user accounts and watches to allow
people to track comments and/or official documentation changes.
+
+9) rubydoc should contain the actual scripts, C files (source and
+ headers), external data such as images (MIME64 encoded) and the
+ documentation in one big goo file. Many files into one rubydoc
+ file. A rubydoc file gets distributed and is the package. A
+ rubypkg or rubygem (Ruby's equiv of a JAR file) is built from a
+ rubydoc package. rubydoc will be based on DocBook 4.1 or later
+ with customized Ruby extensions.
+
+10) rubydoc will support converting to and from rdoc.
If you have any questions/comments, please send them to:
<rub...@li...>
|
