2004-06-10 Atsushi Enomoto <atsushi@ximian.com>

[mono.git] / web / classlib-doc

diff --git a/web/classlib-doc b/web/classlib-doc
index 19f92d6dfcfa0599586c0cf00223548a9eab4fda..d86969ed119a07fdfea700ee2ed059cf1a477d36 100644 (file)
--- a/web/classlib-doc
+++ b/web/classlib-doc
@@ -7,56 +7,43 @@
        the code, making the source quite difficult to read.  Furthermore,
        multilingual documentation makes for significant additional text.
        
        the code, making the source quite difficult to read.  Furthermore,
        multilingual documentation makes for significant additional text.
        

-       With these considerations in mind, Mono will use external XML files
-       for type documentation, rather than documenting the source inline.
-       
-       Several tools will be created for managing, verifying, generating,
-       and updating class library documentation, including:
-       
-       <ul>
-               <li><a href="#monodoc">MonoDoc - A graphical documentation editor and viewer.</a></li>
-               <li><a href="#mkmaster">MkMaster - A command line tool to feed stub information to MonoDoc.</a></li>
-               <li><a href="#aspnet">An ASP.NET documentation editor.</a></li>
-               <li><a href="#xsltool">An xsl tool to convert monodoc xml to html documentation.</a></li>
-       </ul>
+       With these considerations in mind, Mono is using external XML files
+       for class documentation, rather than documenting the source
+       inline.  The XML file format used is inspired by the XML format used
+       to document the ECMA APIs.  

 
 

-** XML Documentation Files and Formats
+       Several tools exist for managing, verifying, generating,
+       and updating class library documentation.

 
 

+       The documentation infrastructure is part of the `Monodoc'
+       module.  Monodoc includes a graphical GUI browser and tools to
+       generate the initial stubbed XML document out of an assembly.
+       
+       Download `monodoc' to start producing documentation for your
+       application. 

 
 

-*** Monodoc XML
-       This XML is Mono's documentation format. Documentation and a DTD/Schema
-       for Monodoc XML is located in cvs and can be found <a href="http://go-mono.org/monodoc.dtd">here</a>.
-
-       This XML could be generated by MonoDoc or the ASP.NET client.
+       For instructions, read the monodoc/README file.

 
 

-       More about the XML format <a href="http://go-mono.org/monodoc-xml.html">here</a>.

 ** Documentation Tools
 
 *** <a name="monodoc">MonoDoc</a>
 ** Documentation Tools
 
 *** <a name="monodoc">MonoDoc</a>

-        A graphical documentation editor and viewer.  Currently, MonoDoc
-        consists of a Qt# application and is in heavy development.

 
 

-*** <a name="mkmaster">MkMaster</a>
-       This tool creates the Master.xml file that MonoDoc uses as a reference
-       for documentation generation. This is a reflection engine that is used
-       to gather metadata from assemblies and create an xml representation.
+       The MonoDoc system offers both a GUI client as well as a <a
+       href="http://www.go-mono.com:8080">Web-based interface</a> to
+       the documentation.

 
 

-*** <a name="aspnet">ASP.NET</a>
-       This tool is planned.
+       The GUI edition uses <a
+       href="http://gtk-sharp.sf.net">Gtk#</a> and the Web edition
+       uses Mono's ASP.NET implementation. 

 
 

-*** <a name="xsltool">An XSL converter</a>
-       This tool is planned.  If someone wants to step forward and adopt this
-       project, it would be very helpful ;)
-
-** Status and Roadmap
-
-***  16, September 2002
-
-A preliminary version of MonoDoc is in Mono's cvs.  It is under heavy development.
-Once this is complete we will start documenting the API!
+       <img src="images/Screenshot-Monodoc.png">

 
 ** Get Involved
 
        Help us develop Mono's documentation tools!  Subscribe to
        <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>
        and wade right in.
 
 ** Get Involved
 
        Help us develop Mono's documentation tools!  Subscribe to
        <a href="http://lists.ximian.com/mailman/listinfo/mono-docs-list">mono-docs-list</a>
        and wade right in.

+
+       Monodoc today also supports a GUI-based collaborative editing
+       system.  You can now edit the documentation from the MonoDoc
+       Browser and upload your contributions directly to the Mono site.