xmlbeans-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ra...@apache.org
Subject svn commit: r151242 - in xmlbeans/trunk: README.txt build.xml xkit/README.txt
Date Thu, 03 Feb 2005 22:06:56 GMT
Author: radup
Date: Thu Feb  3 14:06:55 2005
New Revision: 151242

URL: http://svn.apache.org/viewcvs?view=rev&rev=151242
Log:
More brushup of mundane things, like readme and ant task doc.

Modified:
    xmlbeans/trunk/README.txt
    xmlbeans/trunk/build.xml
    xmlbeans/trunk/xkit/README.txt

Modified: xmlbeans/trunk/README.txt
URL: http://svn.apache.org/viewcvs/xmlbeans/trunk/README.txt?view=diff&r1=151241&r2=151242
==============================================================================
--- xmlbeans/trunk/README.txt (original)
+++ xmlbeans/trunk/README.txt Thu Feb  3 14:06:55 2005
@@ -1,18 +1,42 @@
-This directory will contain preliminary code being investigated that
-eventually will become the next major revision of XMLBeans.
+Welcome to XmlBeans Version 2.
 
-Since v2 will likely break some fundamental assumptions of that are
-made by v1, v2 will be done as a new codeline here.
+Layout of the tree:
+- README.txt    this file
+- build.xml     ant build file for building XmlBeans code and utilities
+- testbuild.xml ant build file for building and running tests
+- STATUS        essential info about the project
+- xbeanenv.cmd  sets the XMLBEANS_HOME environment variable on Windows
+- xbeanenv.sh   sets the XMLBEANS_HOME environment variable on Unix
+- bin           contains useful command-line scripts for Win and Unix
+- docs          contains several documentation files
+- external      contains external jars upon which XmlBeans depends
+- samples       contains ... samples
+- src           the source code for XmlBeans, organized by area
+- test          contains test cases and infrastructure
+- xkit          contains the README file for the binary distribution
 
-The code today (2003-09-24) is in a very preliminary state (actually
-as of today, nothing is checked in here), so should be seen as
-very early work.  As v2 progresses, this notice will be updated.
+To quickly get started run:
+"ant" to build XmlBeans or
+"ant usage" to see the most useful build targets or
+"cd bin" and then "<tool_name> -help" for a description of what the
+     tool does and what parameters it accepts
 
-Minor bugfixes and small features should be made in the v1 directory; as
-the v2 project ramps up, we all will need to make sure that fixes that
-are applicable to both v1 and v2 are merged into both trees.
+For further information check out:
+http://xmlbeans.apache.org
+http://wiki.apache.org/xmlbeans
+./samples/<sample_name>/README.txt  for running samples
+./test/docs/*                       for running tests
 
-The test folder under v2 has a bunch of tests checked in whose aim is to
-test the xbean product. The test folder has a readme.txt on how to run
-the tests and what tests needs to be run before checkining in code.
+XmlBeans depends on the following external libraries:
+- jsr173_api.jar
+- jam-0.1.0-src.jar [http://annogen.codehaus.org/JAM] for the extension
+  feature using plain .java files
+- tools.jar (O) from the JDK, dependency of jam-0.1.0-src
+- resolver.jar (O) [http://xml.apache.org/commons/components/resolver/]
+  for apache-commons catalog files that are used in entity resolving
+- saxon8.1.1 (O) [http://sourceforge.net/projects/saxon/]
+  for XPath/XQuery in XmlBeans
+(O) means that the library is optional
 
+For licensing information, see ./src/license/LICENSE.txt
+Updated: 02/03/05.

Modified: xmlbeans/trunk/build.xml
URL: http://svn.apache.org/viewcvs/xmlbeans/trunk/build.xml?view=diff&r1=151241&r2=151242
==============================================================================
--- xmlbeans/trunk/build.xml (original)
+++ xmlbeans/trunk/build.xml Thu Feb  3 14:06:55 2005
@@ -19,6 +19,9 @@
         <echo message="usage       - this help text"/>
         <echo message="deploy      - builds our implementation jar (xbean.jar)"/>
         <echo message="clean       - cleans out the xbeans directories"/>
+        <echo message="docs        - builds the JavaDoc documentation in ./build/docs"/>
+        <echo message="xmlpublic.jar-builds xmlpublic.jar, containing just the public
code"/>
+        <echo message="sources     - zips up the XmlBeans source code"/>
         <echo/>
         <echo message="testbuild   - builds, but does not run, the xbean drt"/>
         <echo message="checkintest - runs the xbean tests"/>
@@ -254,6 +257,7 @@
         <copy todir="build/private/xmlbeans-${product.version}">
             <fileset dir="xkit"/>
             <fileset dir="." includes="bin/**"/>
+            <fileset file="src/license/LICENSE.txt"/>
         </copy>
         <copy todir="build/private/xmlbeans-${product.version}/schemas/s4s">
             <fileset dir="src/xsdschema/schema" includes="XMLSchema.xsd"/>

Modified: xmlbeans/trunk/xkit/README.txt
URL: http://svn.apache.org/viewcvs/xmlbeans/trunk/xkit/README.txt?view=diff&r1=151241&r2=151242
==============================================================================
--- xmlbeans/trunk/xkit/README.txt (original)
+++ xmlbeans/trunk/xkit/README.txt Thu Feb  3 14:06:55 2005
@@ -11,7 +11,7 @@
     ./lib/xbean.jar
 
 (2) License information for XML Beans and included libraries
-    ./license.txt ???????????????
+    ./LICENSE.txt
 
 (3) One folder full of command-line scripts, pointing to the
     useful main() functions in the JAR.
@@ -33,9 +33,6 @@
     your way to becoming an XmlBeans expert
     ./samples
 
-(8) Tests ??????
-    ./tests
-
 Where to start?
 
 (1) Setup.
@@ -135,7 +132,8 @@
     1. "xpretty instance.xml" pretty-prints an XML instance
        document.
 
-       The code is in xml.apache.org.tool.PrettyPrinter and is
+       The code is in (available via source SVN access)
+       org.apache.xmlbeans.impl.tool.PrettyPrinter and is
        a reasonable example of how to load and save out an
        arbitrary XML document.  XmlOptions are used to produce
        the pretty-printing.
@@ -144,7 +142,8 @@
        instance against the schema.  XMLBeans is intended to
        be a very accurate XML schema validator.
 
-       The code is in xml.apache.org.tool.InstanceValidator.
+       The code is in (available via source SVN access)
+       org.apache.xmlbeans.impl.tool.InstanceValidator.
        It is an excellent example of how to load a schema
        type system dynamically at runtime, load and validate
        an instance within that type system, and how to obtain
@@ -164,6 +163,17 @@
        of a type system.  They are analogous to .class files
        for .java.
 
-    5. "inst2xsd"
-
-    6. "xsd2inst"
+    5. "inst2xsd mydoc.xml" will generate a [set of] XmlSchema
+       file based on the instance document provided. This is
+       useful as a starting point in authoring an XmlSchema
+       document. 
+
+    6. "xsd2inst schema.xsd -name root" will generate a
+       sample xml document with root "root", based on the
+       schema definitions from the provided file.
+
+       The code is in (available via source SVN access)
+       org.apache.xmlbeans.impl.xsd2inst.SampleXmlUtil and is
+       a great example of how to combine the XmlCursor and
+       SchemaType APIs to create a full [sub]document
+       that includes required children, default values etc.



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@xmlbeans.apache.org
For additional commands, e-mail: commits-help@xmlbeans.apache.org


Mime
View raw message