You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Stan Bradbury (JIRA)" <de...@db.apache.org> on 2006/03/07 02:15:31 UTC
[jira] Updated: (DERBY-913) [WWD] Proposal to create and add
Working With Derby, an activity-based tutorial document, to the Derby
documentation set
[ http://issues.apache.org/jira/browse/DERBY-913?page=all ]
Stan Bradbury updated DERBY-913:
--------------------------------
Attachment: wwdDitaSrc0306_Ch1and2.zip
workingwithderby0306.pdf
Version 1.2 of Chapters 1 and 2 of Working With Derby - based on the version 1.1 proposal and outline:
wwdDitaSrc0306_Ch1and2.zip - the dita source files and ditamap for Chap 1 and 2
workingwithderby0306.pdf - PDF for Review and comment: Chap 1 and 2.
Also requesting specific feed back on the following two items:
I would appreciate comment (support for or alternatives to) the following:
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?
> [WWD] Proposal to create and add Working With Derby, an activity-based tutorial document, to the Derby documentation set
> ------------------------------------------------------------------------------------------------------------------------
>
> Key: DERBY-913
> URL: http://issues.apache.org/jira/browse/DERBY-913
> Project: Derby
> Type: Improvement
> Components: Documentation
> Versions: 10.2.0.0
> Reporter: Stan Bradbury
> Assignee: Stan Bradbury
> Attachments: WWDditaSrc0220.zip, WWDditaSrc0222.zip, WWDhtml0220.zip, WorkingWithDerbyV1.1.html, WorkingWithDerbyV10.html, workingwithderby0222.pdf, workingwithderby0306.pdf, wwdDitaSrc0306_Ch1and2.zip
>
> I propose starting a new activity-based tutorial document for Derby. The proposed name is "Working With Derby" and I'd like to include it with the next release. The document would target new Derby users. Information would be presented that supports a series of activities designed to be performed after installation. These activities will guide beginners through the basics of using Derby. Attached is a proposal that further describes the initial topics as I see them. I would very much like feedback on all aspects of this proposal from the Derby communities. Please post all feedback to the derby-user maillist, include Working With Derby (WWD for short) in the subject line of all messages on this topic.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://issues.apache.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see:
http://www.atlassian.com/software/jira