From: Egon W. <eg...@us...> - 2002-08-22 11:52:30
|
Update of /cvsroot/cdk/cdk/doc/devel-guide In directory usw-pr-cvs1:/tmp/cvs-serv23144/devel-guide Modified Files: check-xml docs.xml guide.xml library-development.xml Log Message: Made a user guide from web content. It uses the same DocBook XML source. Index: check-xml =================================================================== RCS file: /cvsroot/cdk/cdk/doc/devel-guide/check-xml,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -r1.1 -r1.2 *** check-xml 4 Mar 2002 21:35:05 -0000 1.1 --- check-xml 22 Aug 2002 11:52:26 -0000 1.2 *************** *** 1,2 **** #! /bin/sh ! nsgmls -s /usr/lib/sgml/declaration/xml.dcl guide.xml --- 1,2 ---- #! /bin/sh ! xmllint --valid --noout guide.xml Index: docs.xml =================================================================== RCS file: /cvsroot/cdk/cdk/doc/devel-guide/docs.xml,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -r1.3 -r1.4 *** docs.xml 9 Aug 2002 12:54:43 -0000 1.3 --- docs.xml 22 Aug 2002 11:52:27 -0000 1.4 *************** *** 29,33 **** <para> Java classes should have the JavaDoc tags ! @copyright and @author. </para> </section> --- 29,34 ---- <para> Java classes should have the JavaDoc tags ! @copyright and @author. In addition, they may have ! @keyword tags. </para> </section> *************** *** 43,47 **** If the procedure performs a method found in literature, it should mention the reference. No format for the reference has been determined, ! but the BibTex format should do fine. </para> </section> --- 44,49 ---- If the procedure performs a method found in literature, it should mention the reference. No format for the reference has been determined, ! but the BibTex format, or a link to ! http://cdk.sf.net/biblio.html#ARTID should do fine. </para> </section> Index: guide.xml =================================================================== RCS file: /cvsroot/cdk/cdk/doc/devel-guide/guide.xml,v retrieving revision 1.7 retrieving revision 1.8 diff -C2 -r1.7 -r1.8 *** guide.xml 17 Mar 2002 10:10:31 -0000 1.7 --- guide.xml 22 Aug 2002 11:52:27 -0000 1.8 *************** *** 2,6 **** <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" ! "../lib/dtd/docbookx.dtd" [ <!ENTITY packages SYSTEM "packages.xml"> <!ENTITY preface SYSTEM "preface.xml"> --- 2,6 ---- <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" ! "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [ <!ENTITY packages SYSTEM "packages.xml"> <!ENTITY preface SYSTEM "preface.xml"> Index: library-development.xml =================================================================== RCS file: /cvsroot/cdk/cdk/doc/devel-guide/library-development.xml,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -r1.1 -r1.2 *** library-development.xml 17 Mar 2002 10:10:31 -0000 1.1 --- library-development.xml 22 Aug 2002 11:52:27 -0000 1.2 *************** *** 11,16 **** <title>Class categories</title> <para> ! All CDK classes are categorized into four classes: ! core, standard, extra, and project. </para> <section> --- 11,16 ---- <title>Class categories</title> <para> ! All CDK classes are categorized into classes. Currently, these classes ! are defined: core, extra, and libio. </para> <section> *************** *** 23,27 **** --- 23,42 ---- </section> <section> + <title>LibIO classes</title> + <para> + These classes interface to other (Java) libraries, like JOELib and CMLDOM. + </para> + </section> + <section> + <title>Extra classes</title> + <para> + These are classes that do not belong to either of the other two categories. + </para> + </section> + + <!-- The next part has not been proposed yet. + section> <title>Standard classes</title> + <para> Standard classes are all classes that do not represent some entity, *************** *** 47,56 **** </section> <section> - <title>Extra classes</title> - <para> - Classes that are too specific for general use belong to the class Extra. - </para> - </section> - <section> <title>Project classes</title> <para> --- 62,65 ---- *************** *** 60,64 **** project statistics. </para> ! </section> </chapter> --- 69,73 ---- project statistics. </para> ! </section --> </chapter> |