[kepler-dev] Documentation updates

Kevin Ruland kruland at ku.edu
Thu Jan 5 14:03:50 PST 2006


I think the end state is to have a deliverable .kar file which is 
completely self contained.  That is it has the bytecode, the moml, and 
supporting "static" information like documentation.  The format and 
functionality of this beast has yet to be defined, but given that this 
information is intended to be delivered as a unit I don't think there 
can or should be any way for the end-user to update it.

Storing the documentation in the moml might not be such a good idea.  
Given the current situation of parsing all the moml for all the actors 
on Kepler startup, having the documentation in the moml cause the kepler 
runtime memory requirements to be very much larger than they currently are.

Since we plan on using classloaders to find the various resources for 
the actors, I think it would be best if the documentation were a 
seperate file distributed in the kar with the actor.  The moml would 
then contain the name of the resource.

Matt or Chad might have other insights which could allow this functionality.


Nandita Mangal wrote:

> Hi Kevin,
> As with the recent changes in the documentation infrastructure in 
> Ptolemy ( editing & storing the custum documentation  in a MOML file) 
> , I was wondering if one can also implement the "GetDocumentation" 
> feature in Kepler & store new results in the actor's moml file ? Could 
> you also suggest  possible implementation changes/issues with the 
> above structure in Kepler.
> Thanks!
> Nandita.
> Edward A. Lee wrote:
>> Ilkay:
>> This is exactly what happens now... Drop in the Documentation attribute
>> and double click on it, and you get a form for filling out documentation
>> fields (overall description, author, documentation for each parameter
>> and port, etc.).  The form is customized to the actor (you get fields 
>> for
>> ports and parameters that exist...).
>> Edward
>> At 03:55 PM 1/2/2006 -0800, Ilkay Altintas wrote:

More information about the Kepler-dev mailing list