[kepler-dev] Actor documentation

[Edward A. Lee]

This would be interesting... The way I would do it would be to put
a link in the actor documentation to a targeted wiki for that actor.
Ferdinando Villa also suggested this...

The risk is that if there is no commentary on any actors, then it
looks pretty dumb...  I guess we could all agree to go comment...

Edward

At 11:05 AM 12/21/2005 -0800, Christopher Brooks wrote:
>Here's a half baked idea.
>
>I think it would be nice if users could update and comment on
>documentation.
>
>I was thinking it would be cool to have some sort of wiki for actor
>documentation, or at least something so that users could annotate
>actor documentation.  The PhP website uses this to great advantage,
>see
>http://us2.php.net/manual/en/function.eregi.php
>
>The beauty is that users tend to make note of things that weren't
>clear or "aha!" moments that they had.  Yah, the comments don't
>make great reading, but I've found them really useful for PhP, where
>I'm by no means an expert and often flailing around for a quick
>solution.
>
>_Christopher
>
>--------
>
>
>     At 10:58 AM 12/19/2005 -0700, Laura L. Downey wrote:
>     >I'm a little confused here.  Why would the user want to edit the
>     >documentation?  Or is this "edit" feature supposed to be for creators of
>     the
>     >documentation?
>
>     Yes, or to modify the documentation for an instance of the actor,
>     or to add documentation for a composite actor.  Can you think of a better
>     phrase than "Edit Documentation"?
>
>     Edward
>
>     [LLD>]
>     Oh I'm not opposed to the phrase "Edit Documentation," I was just 
> thinking
>     that many of the Kepler users would not ever edit the documentation, 
> that i
>    s
>     sort of like an advanced feature -- maybe only creators of new actors 
> (the
>     owners) would have the permission to edit the associated 
> documentation.  I
>     would also expect that we wouldn't want the documentation edited on 
> the bas
>    e
>     set of actors that ships with Kepler.  But maybe my assumptions are 
> wrong..
>    .
>     I can't see any issue though with Ptolemy putting in "Edit 
> Documentation" a
>    s
>     a menu item.  Kepler can certainly hide or reveal the menu item as
>     appropriate, I would assume.  (un oh more assumptions ) :-)
>
>     Laura
>
>     _______________________________________________
>     Kepler-dev mailing list
>     Kepler-dev at ecoinformatics.org
>     http://mercury.nceas.ucsb.edu/ecoinformatics/mailman/listinfo/kepler-dev
>--------
>_______________________________________________
>Kepler-dev mailing list
>Kepler-dev at ecoinformatics.org
>http://mercury.nceas.ucsb.edu/ecoinformatics/mailman/listinfo/kepler-dev

------------
Edward A. Lee
Professor, Chair of the EE Division, Associate Chair of EECS
231 Cory Hall, UC Berkeley, Berkeley, CA 94720
phone: 510-642-0253 or 510-642-0455, fax: 510-642-2845
eal at eecs.Berkeley.EDU, http://ptolemy.eecs.berkeley.edu/~eal