[kepler-dev] [Bug 5529] New: Documentation for some actors such as Run Composite Actor is empty

[bugzilla-daemon at ecoinformatics.org]

http://bugzilla.ecoinformatics.org/show_bug.cgi?id=5529

             Bug #: 5529
           Summary: Documentation for some actors such as Run Composite
                    Actor is empty
    Classification: Unclassified
           Product: Kepler
           Version: trunk
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: normal
          Priority: P2
         Component: documentation
        AssignedTo: altintas at sdsc.edu
        ReportedBy: cxh at eecs.berkeley.edu
         QAContact: kepler-dev at kepler-project.org


In the devel trunk and in Kepler-2.2, the documentation for Run Composite Actor
is empty.

To replicate:
1) Start Kepler
2) Search for
Run Composite Actor
3) Drag the actor on to the canvas
4) Right click and select Documentation -> Display

However, documentation for actors like Constant are present.

My guess is that 
kepler/actors/resources/kar/CoreActors/RunCompositeActor.xml
has no actor-specific documentation

There are several bugs here:
1) The file has no real documentation.  I updated that file with documentation,
but my changes do not appear when I try to view the documentation?  Why?

2) There is no obvious way to update the file.  When I get a mostly empty
file, I should at least get link to instructions about how to update
the docs.  There are some docs at
https://kepler-project.org/developers/reference/updating-the-kepler-directors-and-actors

3) There are probably a bunch of other actors that have very minimal
documentation.

These actors have documentation that is 17 lines or less:

bash-3.2$ wc -l ~/src/kepler/actors/resources/kar/CoreActors/*.xml | sort -nr |
tail -15
      17
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/NexusFileReader.xml
      16 /Users/cxh/src/kepler/actors/resources/kar/CoreActors/TreeToString.xml
      16 /Users/cxh/src/kepler/actors/resources/kar/CoreActors/Image.xml
      15
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/SequenceScope.xml
      15
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/MemeOpalInput.xml
      15 /Users/cxh/src/kepler/actors/resources/kar/CoreActors/Logger.xml
      15
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/HistogramPlotter.xml
      14
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/MastOpalInput.xml
      10
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/IntRangeParameter.xml
      10
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/Documentation.xml
       9
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/RunCompositeActor.xml
       9
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/PAUPConsensusTrees.xml
       9 /Users/cxh/src/kepler/actors/resources/kar/CoreActors/JRunCIPRes.xml
       9
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/ClustalWSeqAlign.xml
       9
/Users/cxh/src/kepler/actors/resources/kar/CoreActors/AlignmentEditor_Seaview.xml


It would be best if the documentation would default to the Ptolemy
documentation, or at least if there was a link.  In vergil, if there
is no documentation found, then the user is offered a link to documentation
at http://ptolemy.eecs.berkeley.edu/ptolemyII/ptII8.1/ptII.
The way this works is that the major version number is used.
See vergil/basic/GetDocumentationAction.java:

 Parameter remoteDocumentationURLBaseParameter = (Parameter) configuration
                        .getAttribute("_remoteDocumentationURLBase",
                                Parameter.class);
                String tentativeRemoteDocumentationURLBase = null;
                if (remoteDocumentationURLBaseParameter != null) {
                    tentativeRemoteDocumentationURLBase =
remoteDocumentationURLBaseParameter
                            .getExpression();
                } else {
                    tentativeRemoteDocumentationURLBase =
"http://ptolemy.eecs.berkeley.edu/ptolemyII/ptII"
                            + VersionAttribute.majorCurrentVersion() +
"/ptII/";
                }

-- 
Configure bugmail: http://bugzilla.ecoinformatics.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the QA Contact for the bug.