[kepler-dev] {Filename?} Kepler Javadocs

[Nandita Mangal]

Warning: This message has had one or more attachments removed
Warning: (OrbWaveformSource.doc.xml).
Warning: Please read the "NCEAS-Attachment-Warning.txt" attachment(s) for more information.


As discussed in Kepler meeting , we are creating kepler documentation 
based on Ptolemy's documentaionFramework :

1)A doc/doclets/PtDoclet.java reads Actor java files and generates xml using the DTD at
ptolemy/vergil/basic/DocML_1.dtd.  These .xml files are in kepler-docs/dev/documentationFramework/generatedJavadocs.

Both kepler as well as ptolemy javadocs are generated and the resultant XML files are in the generatedJavadocs folder.

The javadocs are named with extension "*.doc.xml" to avoid mixup with Kepler src/actors XMLs.




2) The Javadocs Doclet contains the basic info fields and tags, and also contain a "UserLevelDocumentation" tag, to 
allow Kepler to create separate "UserDocumenation" pages as well for the same actor.



_DeveloperDocumenation_
Description
 Author
 Version
 Ports Summary (Port Name + description)
 Parameters Summary (Parameter Name + description)
Sample Demos (To be added)

_User Documentation Fields_
 UserLevelDescription
 Author
 Version
 Ports Summary (Port Name + UserLevelDescription)
 Parameters Summary (Parameter Name + UserLevelDescription)
Sample Demos (To be added)

A sample javadoc XML file and its two user/developer HTML files created 
are attached.
The final documentation pages are in 
kepler-docs/dev/documenationFramework/generatedHTMLPages/user (or developer)
The main page with the ontology tree links to actors is 
"FinalUserDocumentation.html (or FinalDeveloperDocumentation.html) in 
generatedHTMLPages folder.


3)In progress: Fully integrate the "customizeDocumentation" feature as 
implemented by Ptolemy on canvas.

Any comments/errors please let me know.

Thanks,
nandita.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mercury.nceas.ucsb.edu/ecoinformatics/pipermail/kepler-dev/attachments/20060222/d91d7d1a/attachment-0001.htm
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mercury.nceas.ucsb.edu/ecoinformatics/pipermail/kepler-dev/attachments/20060222/d91d7d1a/OrbWaveformSource.doc-0002.html
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mercury.nceas.ucsb.edu/ecoinformatics/pipermail/kepler-dev/attachments/20060222/d91d7d1a/OrbWaveformSource.doc-0003.html
-------------- next part --------------
A non-text attachment was scrubbed...
Name: documentationFrameworkTutorial.pdf
Type: application/pdf
Size: 29433 bytes
Desc: not available
Url : http://mercury.nceas.ucsb.edu/ecoinformatics/pipermail/kepler-dev/attachments/20060222/d91d7d1a/documentationFrameworkTutorial-0001.pdf
-------------- next part --------------
This is a message from the MailScanner E-Mail Virus Protection Service
----------------------------------------------------------------------
The original e-mail attachment "OrbWaveformSource.doc.xml"
is on the list of unacceptable attachments for this site and has been
replaced by this warning message.

If you wish to receive a copy of the original attachment, please
e-mail helpdesk and include the whole of this message
in your request. Alternatively, you can call them, with
the contents of this message to hand when you call.

At Wed Feb 22 10:49:51 2006 the virus scanner said:
   MailScanner: Attempt to hide real filename extension (OrbWaveformSource.doc.xml)

Note to Help Desk: Look on Mercury in /var/spool/MailScanner/quarantine/20060222 (message C425C3582C3.0C261).
-- 
Postmaster
NCEAS
www.nceas.uscb.edu

MailScanner thanks transtec Computers for their support