[kepler-dev] [Bug 4909] New: Actor documentation: updates ignored, duplicate info, how to refer to other actors/models?

[bugzilla-daemon at ecoinformatics.org]

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

           Summary: Actor documentation: updates ignored, duplicate info,
                    how to refer to other actors/models?
           Product: Kepler
           Version: 1.x dev
          Platform: All
        OS/Version: All
            Status: NEW
          Severity: minor
          Priority: P2
         Component: documentation
        AssignedTo: altintas at sdsc.edu
        ReportedBy: cxh at eecs.berkeley.edu
         QAContact: kepler-dev at kepler-project.org


A few comments about the Kepler Actor Documentation system

1.  If I update the .xml file for a Director, then preexisting models
do not get the updates.  I think this is wrong.  For example,
I added text to PNDirector.xml.  If a user has a preexisting model
that uses PNDirector, then to see the new text, they would need
to drag in a new PNDirector. 

2. The model files contain copies of the documentation.  This is
related to point 1 above.  This will be an issue for large systems
because parsing a large file with redundant info takes time and
possibly consumes lots of memory

3. In a documentation .xml file, how do I refer to another actor
or director?  For example in
kepler/directors/resources/kar/CoreDirectors/PNDirector.xml
I want to refer to the Ramp actor so that if the user
clicks on the link, then they are shown the Ramp actor documentation
How do I do that?

4. In a documentation .xml file, how do I refer to a model?
For example, in
kepler/directors/resources/kar/CoreDirectors/PNDirector.xml
I want to refer to
ptolemy/domains/pn/demo/RemoveNilTokens/RemoveNilTokens.xml
How do I do that?

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