db-derby-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Stanley Bradbury <Stan.Bradb...@gmail.com>
Subject [WWD] Chap 1 and 2 (v 1.1) submitted for review
Date Tue, 07 Mar 2006 01:56:04 GMT
I've submitted Chapters 1 and 2 of the Work With Derby [WWD] document 
for feedback.  These sections are based on the version 1.1 proposal 
submitted last week.  You can download the formatted PDF document for 
review and comment using the following URL.

http://issues.apache.org/jira/secure/attachment/12323814/workingwithderby0306.pdf

WWD v 1.1 has a document flow intended to get people creating a database 
without learning all the behind the scenes details - this document uses 
the newly created features introduced by the. Derby-1019 and Derby-1063  
enhancements (provides syntax that does not require CLASSPATH be set in 
order to run Derby with IJ). 

I am also asking for feed back in the following areas (support for or 
alternatives to) :

1) The basic organization of each activity (BASIC ACTIVITY FORMAT).  
INTENT: The organization separates explanations (body text) from the 
command examples and output.  This allows people that just want to 
execute the commands to jump to the 'Activity Sequence' and launch into 
using the product without reading any explanation at all.     BASIC 
ACTIVITY FORMAT:
Each activity begins with a  bulleted list that describe the commands 
that appear in the 'Activity sequence' that follows.  The 'Activity 
Sequence' shows the commands and output (for most a cut-N-paste from a 
command shell).  Occasionally a LABEL will appear in the 'Activity 
Sequence' where there is a difference between Windows and Unix syntax to 
identify the OS the example represents. 

2) Referencing the Derby installation file path.  I see setting and 
using the environment variable DERBY_HOME (currently called 
DERBY_INSTALL) to indicate the filesystem path to the DERBY installation 
as the best way to provide command syntax examples (e.g.   java -jar 
$DERBY_HOME/derbytools.jar ij)
 With the changes made by DERBY-1019 is one of the few 'setup' steps 
that remain before launching into IJ.
Is there a better way?

Thanks for your collaboration on this issue.




Mime
View raw message