History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: CASTOR-979
Type: Improvement Improvement
Status: Open Open
Priority: Minor Minor
Assignee: Unassigned
Reporter: Martin Fuchs
Votes: 0
Watchers: 1

If you were logged in you would be able to see more operations.

extend JDO documentation by illustrations

Created: 02/Jan/05 08:43 AM   Updated: 13/Oct/05 09:08 AM
Component/s: JDO docs
Affects Version/s: 0.9.6
Fix Version/s: None

Time Tracking:
Not Specified

File Attachments: 1. Text File castor-1842.patch (5 kb)

Operating System: All
Platform: All

Bugzilla Id: 1842

 Description  « Hide
As a picture says more than thousand words, I made an approach for a
illustration of the chapter "Using A JDO Database" of our current documentation
at http://castor.exolab.org/jdo.html:


There is available an english and a germ an version of the text.
It shows what happens and which functions are used when creating, querying,
updating and deleting objects using JDO.

How can we include the pictures into the XML-formated documentation?

 All   Comments   Work Log   Change History      Sort Order: Ascending order - Click to sort in descending order
Werner Guttmann - 06/Jan/05 12:25 PM
> How can we include the pictures into the XML-formated documentation?
Either you add a new template for e.g. <pictures> to exolab.xsl, or you simply
include an image element in the source file.

Werner Guttmann - 06/Jan/05 12:26 PM
Martin, great stuff in general. This should make things a lot easier for our
users to grasp the main concepts. Having said that, I honestly think that the
images can (and should) be made easier to follow. It's very difficult to explain
why, so let's talk off-line.

Martin Fuchs - 07/Jan/05 04:33 AM
Created an attachment (id=844)
patch for src/doc/jdo.xml

This is a first draft of the docu extension. (just copied from my web page)
It doesn't include the pictures itself, only <img src="..."/> references.
Any concrete ideas how to make them easier to follow?

Werner Guttmann - 13/Oct/05 09:08 AM
Martin, still interested to get this committed (with my help, if required) ? Let's forget about the modifications for the time being ... as we can always 'refactor' later on.