[kepler-dev] another big checkin
altintas at sdsc.edu
Sun Mar 18 22:54:16 PDT 2007
On Mar 16, 2007, at 7:08 PM, Chad Berkley wrote:
> Hey Ilkay,
> See below:
> Ilkay Altintas wrote:
>> Chad, Kirsten,
>> Thanks for all the updates. I've just tested the docs a little bit
>> and have a few questions.
>> 1. Documentation for some generic actors says null. We used to
>> have documentation for these actors. (Example: WebService actor)
> The documentation either needs to get moved to the moml file, or
> the KeplerDocumentationAttribute in that moml file needs to be
> removed. If the KeplerDocumentationAttribute exists, it won't go
> try to find the other docs. If you're going to do it, you should
> just move the documentation to the moml file so that it will show
> up on the website and so it will be more portable.
>> 2. If the documentation window is open for one actor, it does not
>> refresh when I try display the doc for another actor.
> Did this used to work? I noticed this too. If I broke it, I'll
> fix it. If I didn't, I'll blame someone else and tell them to fix
> it :) It might have something to do with the fact that only one
> docTableau can be open at the same time. We might have to ask EAL
> about this.
I don't know if this us to work. I just noticed it last week.
>> 3. Do we distinguish now between the documentation actor and class
> did you mean "author" instead of "actor"? If so, no. The author
> listed in the docs is the author of the actor. say that 3 times
> fast: "author of the actor, author of the actor, author of the
Yes, I meant author. :-) Thanks. Something is probably set up wrong
in my docs. I'll ask you on irc if I can't fix it after moving the
documentation to moml.
>> 4. It would be really nice to be able to view the documentation
>> without having to drag and drop the actor, i.e., from the left
>> pane library with a right-click context menu. Do we have any plans
>> for this? Just an idea that was mentioned to me by a user.
> I fully agree. It wouldn't be too hard to put a rt. click menu on
> actors in the tree to fetch the docs. Put it in bugzilla and maybe
> I'll get to it in 2009 :) Just kidding, it shouldn't be too hard.
Thanks. I'll add this to Bugzilla.
>> Thanks very much!
>> On Mar 14, 2007, at 2:18 PM, Chad Berkley wrote:
>>> I just did another pretty major change. The new documentation
>>> system should now work properly (i.e. you should see the new user
>>> documentation that Kirsten has been working on when you rt. click
>>> on a component and go to "Documenatation/Display".) You will
>>> need to update and recompile both ptolemy and kepler to get this
>>> to work. You may get compile errors if you try to just update
>>> kepler without ptolemy.
>>> To use the new documentation system, add your documentation in
>>> the actor metadata file for your actor in kepler/src/actors.
>>> Check out one of the other files for the correct format.
>>> Basically, you just need to add a KeplerDocumentationAttribute
>>> and put your docs there and it will show up in the DocViewer.
>>> For those of you editing documentation. Please only make changes
>>> in the actor metadata files. Do not make any additional changes
>>> to the kepler-docs/user/Actor_Docs_for_Users_In_Progress.*
>>> files. If you do, the changes will have to be hand added to the
>>> actor metadata.
>>> Let me know if you see any problems. Note that some actors do
>>> not have any documentation so the DocViewer will just show you
>>> nulls. If no KeplerDocumenatationAttribute property exists, the
>>> system should default to the old behavior of first looking for a
>>> DocAttribute then searching for the source file on the classpath.
>>> Kepler-dev mailing list
>>> Kepler-dev at ecoinformatics.org <mailto:Kepler-dev at ecoinformatics.org>
>> Ilkay ALTINTAS
>> Assistant Director, National Laboratory for Advanced Data Research
>> Manager, Scientific Workflow Automation Technologies (SWAT) Lab
>> San Diego Supercomputer Center(SDSC), UCSD
>> 9500 Gilman Drive, MC: 0505 La Jolla, CA 92093-0505
>> phone: (858) 822-5453 fax: (858) 534-8303
>> web: http://users.sdsc.edu/~altintas
More information about the Kepler-dev