| Line 2 was replaced by line 2 |
| - __Kirsten__ |
| + __Kirsten__ __ALL COMPLETE EXCEPT FOR GLOSSARY__ |
| Line 21 was replaced by line 21 |
| - *Make the listserv |
| + *Make the listservs searchable |
| Lines 26-33 were replaced by lines 26-34 |
| - *Create guidelines for how to write documentation for actors and Sam to place on Wiki |
| - *Must note dependencies in the actor docs |
| - **R actors need R installed |
| - **GRASS actors need GRASS installed |
| - **Matlab needs Matlab installed; command line actor depends on system-specific executables and is operating-system specific. |
| - *''Web Service actor'': Update copy to reflect that the actor only works for a subset of WSDL constructs. Only ones that use base types for parameters or arrays of base types. “Intended to work on any web service with certain limitations, in particular related to the types of parameters that are used as input and output to Web Service.” Define “Web Service” in first paragraph e.g., “which is a… computer program that runs on a remote host using a standardized protocol.” |
| - *''Random Normal actor'': this uses R norm and hist function—add note “For a full detailed desc. of how this actor works, look at R norm docs” |
| - *''AddGrids actor'': Revise to say that actor takes “two or more geospatial images”/less jargon-y. Update desc. about file formats—it is not generically true that all actors use ESRI ASCII file format (e.g., not true for Interpolate actor) |
| + *Create guidelines for how to write documentation for actors ([Actor documentation guidlines|http://cvs.ecoinformatics.org/cvs/cvsweb.cgi/kepler-docs/user/Creating_Actor_Documentation.doc])and Sam to place on Wiki __COMPLETE__ |
| + *Must note dependencies in the actor docs__COMPLETE__ |
| + **R actors need R installed__COMPLETE__ |
| + **GRASS actors need GRASS installed__COMPLETE__ |
| + **Matlab needs Matlab installed __COMPLETE__ |
| + **command line actor depends on system-specific executables and is operating-system specific.__COMPLETE__ |
| + *''Web Service actor'': Update copy to reflect that the actor only works for a subset of WSDL constructs. Only ones that use base types for parameters or arrays of base types. “Intended to work on any web service with certain limitations, in particular related to the types of parameters that are used as input and output to Web Service.” Define “Web Service” in first paragraph e.g., “which is a… computer program that runs on a remote host using a standardized protocol.” __COMPLETE__ |
| + *''Random Normal actor'': this uses R norm and hist function—add note “For a full detailed desc. of how this actor works, look at R norm docs”__COMPLETE__ |
| + *''AddGrids actor'': Revise to say that actor takes “two or more geospatial images”/less jargon-y. Update desc. about file formats—it is not generically true that all actors use ESRI ASCII file format (e.g., not true for Interpolate actor)__COMPLETE__ |
| Lines 35-37 were replaced by lines 36-38 |
| - *''Boolean Multiplexor actor'': Revise to include context (used as a control flow actor/for branching) Suggested first sentence: “The Boolean Multiplexor uses a Boolean value to determine which of two input values to output.” |
| - *Boolean Switch actor. Needs more context; only works under certain directors (SDF does not work; PN does work) |
| - *''Expression actor'': Change to read “actor evaluates a specified expression” |
| + *''Boolean Multiplexor actor'': Revise to include context (used as a control flow actor/for branching) Suggested first sentence: “The Boolean Multiplexor uses a Boolean value to determine which of two input values to output.” __COMPLETE__ |
| + *Boolean Switch actor. Needs more context; only works under certain directors (SDF does not work; PN does work)__COMPLETE__ |
| + *''Expression actor'': Change to read “actor evaluates a specified expression”__COMPLETE__ |
| Lines 40-42 were replaced by lines 41-49 |
| - *send email to Efrat to document*TransitiveClosureDatabaseQuery |
| - *send email to Christopher to review Image Contrast actor documentation to clarify |
| - *send email to Jianting to generalize actor and redocument ENM PCP actor without reference to niche model (PCP==Parallel Coordinates Plot). |
| + *send email to Efrat to document*TransitiveClosureDatabaseQuery __ COMPLETE__ |
| + *send email to Christopher to review Image Contrast actor documentation to clarify __ COMPLETE__ |
| + *send email to Jianting to generalize actor and redocument ENM PCP actor without reference to niche model (PCP==Parallel Coordinates Plot). __ COMPLETE__ |
| + * 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. |
| + *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?'' |
| Line 45 was replaced by lines 52-62 |
| - *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. |
| + *look into the implications of using spaces in actor and parameter names. And then to decide on a convention. |
| + __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. |
| + |
| + |
| Lines 51-52 were replaced by lines 68-69 |
| - __Samantha__ |
| - *Update the Outline |
| + __Samantha and Kirsten__ |
| + *Update the Outline __COMPLETE__ |
| Line 58 was replaced by line 75 |
| - ***Change this section title to “” |
| + ***Change this section title to “Building Workflows with Existing Actors” |
