Re: [visad] Visad Tutorials and Documentation

Hello again,

I'm not sure if a change of VisAD web representation is even wanted, but instead of only having a plain Javadoc it would be cool to have something like for example http://www.yiiframework.com/doc/api/. I got seasoned to this kind of documentation usage really fast, and the autocomplete for method and class search (check it out by typing something like 'metadata' into the search input field) helps alot and I use it fain and frequent, because it speeds my work up.

Another very useful thing to have would be a cheat sheet for the most important VisAD concept similar to the famous refcards on http://refcardz.dzone.com/ or http://www.yiiframework.com/files/yii-1.0-cheatsheet.pdf

I do like the rest of the Yii documentation concept (http://www.yiiframework.com/doc/) as well. The blog tutorial is a step-by-step guide that ends up as a simple but functional Blog Application. The definite guide to Yii is similar to the VisAD Developer Guide in combination with the available tutorials, giving the hint for the classes better to know about. The cookbook gathers user content, helping to solve a certain concern. Last there is a forum substituting the need for a mailing list in a more read- and searchable manner. Is or was there a VisAD forum and are there reasons not to have one?

If we could at least combine the present VisAD Documentation into one "definite" document, draw obsolete content and perhaps create some quickstart refcard, the jump-start into VisAD would seem much more easy to me.

Just my thoughts, kind regards,
Marius Schmidt

visad-request@xxxxxxxxxxxxxxxx schrieb:
Send visad mailing list submissions to
        visad@xxxxxxxxxxxxxxxx

To subscribe or unsubscribe via the World Wide Web, visit
        http://mailman.unidata.ucar.edu/mailman/listinfo/visad
or, via email, send a message with subject or body 'help' to
        visad-request@xxxxxxxxxxxxxxxx

You can reach the person managing the list at
        visad-owner@xxxxxxxxxxxxxxxx

When replying, please edit your Subject line so it is more specific
than "Re: Contents of visad digest..."


Today's Topics:

   1. Re: Visad Tutorials and Documentation (Jonathan Beavers)
   2. Re: Visad Tutorials and Documentation (hiding@xxxxxxxxx)
   3. Re: Visad Tutorials and Documentation (Marius Schmidt)
   4. Re: Visad Tutorials and Documentation (Jonathan Beavers)


----------------------------------------------------------------------

Message: 1
Date: Tue, 22 Jun 2010 13:10:07 -0500
From: Jonathan Beavers <jbeavers@xxxxxxxxxxxxx>
To: visad@xxxxxxxxxxxxxxxx
Subject: Re: [visad] Visad Tutorials and Documentation
Message-ID: <763583E4-5022-44E3-A905-190D2B720A47@xxxxxxxxxxxxx>
Content-Type: text/plain; charset=us-ascii

Hi Marius,

I am trying to transform the VisAD Java Component Library Developers Guide into 
representation more pleasing to read and print. Beside that this could perhaps 
be a good time for updating information? I do not know if it is possible in 
this mailing list, but I attached a demo of what kind of PDF im thinking about 
and would be lucky, if somebody would like to support me in this conversion? 
Software used so far is Latex, perhaps it could be a good idea to replace the 
ASCII graphics with some UML Diagram SVGs ?

I like your example, and would be happy to collaborate; I've been (slowly) working on a wiki version of the guide myself, but it's still very preliminary.
FWIW I'm not sure that the guide is outdated relative to the VisAD source 
code... but rethinking the guide's scope might be worthwhile:
* Removing the various "constructor" and "method" sections in favor of linking to javadocs (they're basically the same thing).
* Integrate the collaboration/datarenderer/event tutorials.

* More examples!

* Definitely agree with you on updating the diagrams.

Jon


------------------------------

Message: 2
Date: Tue, 22 Jun 2010 15:14:11 -0400
From: hiding@xxxxxxxxx
To: mariuss@xxxxxxxxxxxxxxxxxxxxxxxxxx, visad@xxxxxxxxxxxxxxxx
Subject: Re: [visad] Visad Tutorials and Documentation
Message-ID: <8CCE0563A95C057-D78-5974@xxxxxxxxxxxxxxxxxxxxxxxxxx>
Content-Type: text/plain; charset="us-ascii"; format=flowed

Hello Marius,

Anything that you, Bruce, Jon and anyone else can
do to improve the VisAD documentation will be most
welcome. As Jon says, more examples would certainly
help.

Best wishes,
Bill Hibbard

-----Original Message-----
From: Marius Schmidt <mariuss@xxxxxxxxxxxxxxxxxxxxxxxxxx>
To: visad@xxxxxxxxxxxxxxxx
Sent: Tue, Jun 22, 2010 12:42 pm
Subject: [visad] Visad Tutorials and Documentation

Hello again VisAD community,

I am trying to transform the VisAD Java Component Library Developers
Guide into representation more pleasing to read and print. Beside that
this could perhaps be a good time for updating information? I do not
know if it is possible in this mailing list, but I attached a demo of
what kind of PDF im thinking about and would be lucky, if somebody would
like to support me in this conversion? Software used so far is Latex,
perhaps it could be a good idea to replace the ASCII graphics with some
UML Diagram SVGs ?

Kind regards,
Marius Schmidt

_______________________________________________
visad mailing list
visad@xxxxxxxxxxxxxxxx
For list information, to unsubscribe, visit: http://www.unidata.ucar.edu/mailing_lists/




------------------------------

Message: 3
Date: Wed, 23 Jun 2010 12:59:23 +0200
From: Marius Schmidt <mariuss@xxxxxxxxxxxxxxxxxxxxxxxxxx>
To: visad@xxxxxxxxxxxxxxxx
Subject: Re: [visad] Visad Tutorials and Documentation
Message-ID: <4C21E90B.6090804@xxxxxxxxxxxxxxxxxxxxxxxxxx>
Content-Type: text/plain; charset=ISO-8859-1; format=flowed

Hi Bruce, Bill, Jon and the others,

im very happy that my Latex approach for the documentation does some favor :-) and many thanks for your offer to help. Did Jon posted his answer to the mailing list? Because I have not received any message of him. I think I will have finished the main conversion of the developers guide in three or four days. @Bruce: I'd like to suggest, that you just could create appropriate diagrams where ever you think it makes sense. I can include it in the pdf most simple, if each diagram is a pdf itself, but even eps or svg will work. For inclusion just tell me the section number and the last few words before the position where I shall include the graphics. E.g. 2.1 'with VisAD in code listing 2.1:'. Perhaps a really simple pipeline of activities executed one after another could make sense here, expanded with some class information of Plain, DataImpl, etc, instead of the enumeration?

@All: Is there a shared place to upload the tex sources to? So it would be possible to do the correct code indentations collaboratively wherever I missed it.

Kind regards,
Marius Schmidt



------------------------------

Message: 4
Date: Wed, 23 Jun 2010 11:03:44 -0500
From: Jonathan Beavers <jbeavers@xxxxxxxxxxxxx>
To: Marius Schmidt <mariuss@xxxxxxxxxxxxxxxxxxxxxxxxxx>
Cc: visad@xxxxxxxxxxxxxxxx
Subject: Re: [visad] Visad Tutorials and Documentation
Message-ID: <F44C4EF1-58D2-4001-90CE-BAE9F198864F@xxxxxxxxxxxxx>
Content-Type: text/plain; charset=us-ascii

Hi Marius,

@All: Is there a shared place to upload the tex sources to? So it would be 
possible to do the correct code indentations collaboratively wherever I missed 
it.

Well, the source code is being migrated to SVN (thanks, bruce!)... but it's 
probably a hassle to get write access set up without being at SSEC.

I'm thinking that the ideal solution is probably to use git and github:
http://git-scm.com/
http://github.com/

[ I actually prefer git over anything else... so far! ]

Jon


------------------------------

_______________________________________________
visad mailing list
visad@xxxxxxxxxxxxxxxx
For list information, to unsubscribe, visit: http://www.unidata.ucar.edu/mailing_lists/
End of visad Digest, Vol 12, Issue 4
************************************



--
Marius Schmidt
Mitarbeiter Physik Online

Institut für Theoretische Physik
Raum 1.126
Max-von-Laue Str. 1
60438 Frankfurt am Main
Germany

Phone:  +49-(0)69 798 47355
E-Mail: mariuss@xxxxxxxxxxxxxxxxxxxxxxxxxx