[prev in list] [next in list] [prev in thread] [next in thread] 

List:       xmlbeans-dev
Subject:    [jira] [Created] (XMLBEANS-463) Improve the "First Steps with
From:       "Robert Liguori (JIRA)" <xmlbeans-dev () xml ! apache ! org>
Date:       2011-07-31 15:02:09
Message-ID: 437446662.21765.1312124529892.JavaMail.tomcat () hel ! zones ! apache ! org
[Download RAW message or body]

Improve the "First Steps with XMLBeans" tutorial
------------------------------------------------

                 Key: XMLBEANS-463
                 URL: https://issues.apache.org/jira/browse/XMLBEANS-463
             Project: XMLBeans
          Issue Type: Improvement
         Environment: Tutorial: First Steps with XMLBeans
http://xmlbeans.apache.org/documentation/tutorial_getstarted.html
            Reporter: Robert Liguori
            Priority: Minor


Tutorial: First Steps with XMLBeans
http://xmlbeans.apache.org/documentation/tutorial_getstarted.html


I have found several issues with the tutorial, as well as some functional issues.... \
below are my initial comments to the tutorial:

==============================================

The opening introduction states, "you'll get a hands on view of two of the three \
technologies that make up version 1 of XMLBeans:".  Rather than leaving the reader \
wondering what the third uncovered technology is, it would be nice to at least \
mention it.  Note: From the main page of the web site, "I believe it's Support for \
XML DOM".

Note: I just noticed that the third option is covered a little deeper into the \
tutorial... but it still may be beneficial to mention it upfront.

==============================================

The tutorial reads:

"To get started, you'll need the following:

    * JDK 1.4 for version 1 XMLBeans releases."

Observation: Java 2 Platform, Standard Edition, v 1.4.2 has been end-of-service life \
since 2008.  I believe 1.5 is also.  Since JDK 1.7 was just released and the industry \
standard up to now has been JDK 1.6, I think the documentation and testing and \
deployment of the product, in general, should reflect this.

==============================================

The tutorial reads:

"To get started, you'll need the following:

    ...
    * An XMLBeans version 1 installation. ..."

Observation: The target here should be a version 2 installation.  

==============================================

The tutorial states references, "xpretty schemas\easypo\easypo.xsd".

However, there is no "easypo" directory in version 2.5.0.

Therefore, the tutorial should reference, "xpretty schemas\easypo.xsd"

==============================================

The tutorial states:

"scomp -out tutorials\gettingstarted\lib\easypo.jar schemas\easypo\easypo.xsd"

However, there is no easy po directory in version 2.5.0 so it should read:

"scomp -out tutorials\gettingstarted\lib\easypo.jar schemas\easypo\easypo.xsd"

*** There's an error with this too, as it's trying to run the javac compiler from the \
xmlbeans-2.5.0 folder.

The fix for this is:

"scomp -compiler %JDK_HOME%\bin\javac.exe -out \
tutorials\gettingstarted\lib\easypo.jar schemas\easypo\easypo.xsd"

There's a problem here too, if Java is installed in a directory with a space (e.g., \
"C:\Program Files\Java\jdk1.6.0_26").  That is moving the install to "C:\jdk1.6.0_26" \
works fine.  This is a problem as the space should be handled.

Note: Double clicking on the generate JAR file (to see the contents) display a dialog \
box with the following message, "Invalid or corrupt jarfile".

==============================================================

Additional comments will be added to the JIRA issue, until the review is completed.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

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


[prev in list] [next in list] [prev in thread] [next in thread]