Science Environment for Ecological Knowledge
Ecoinformatics site parent site of Partnership for Biodiversity Informatics site parent site of SEEK - Home
Science Environment for Ecological Knowledge









 

 

 



Documentation Action Items

Difference between version 2 and version 1:

At line 42 added 2 lines.
+ * Add "documentation" to testing spreadsheet to track doc status. (Matt and Sam)
+ *Update Ptolemy actor documentation for releases. Flag the change and update the Kepler docs appropriately.
Line 45 was replaced by lines 47-59
- *Directors (SDF, PN, etc) Need more of a functional description.
+ *Directors (SDF, PN, etc) Need more of a functional description.
+ * Look into using the first sentence of each actor description as a tooltip. May involve some rewriting.
+ *Fix "Save as KAR" option so that new doc files can be saved (Chad; Dan to look at quickly)
+ *Nandita's auto-actor-doc generating system is not currently working properly. Need a mechanism for generating a complete actor doc in useful formats (HTML, Text, PDF) so that the docs are easy to update and reference.
+ __Matt__
+ * Decide which actors will be incorporated into the release (Ilkay, Matt, and Bertram)
+ __???__
+ *Make MOML files the place where actor and parameter names are edited so that these names can be updated when the Documentation screens are updated.
+ *Incorporating documentation into application
+ **Strategy: Use the Actor right-click menu to update the individual documentation screens (i.e., update the actor's MOML files). Use HTML <p>, <i>, and <tt> tags to preserve formatting. Save the updated actor files as KAR file and then overwrite the existing files in the /Kepler/src/actors directory in CVS.
+ **In the current system, the application will display the Java doc, unless there is doc info in the corresponding MOML file, which will override the Java doc. The system also examines the class and displays that name. An example of an actor with a MOML doc is the Scatterplot actor.
+ **Documentation about ports and parameters should only be pasted into the actor if it differs from its base class. ''Will this work? Now that I'm writing this up, I'm a bit confused. We're updating the MOML file, right? Will the class MOML file overwrite a child's Java docs?''
+

Back to Documentation Action Items, or to the Page History.