[kepler-dev] Documentation Framework Conference Call

[nmangal at sdsc.edu]

Hi All,

Conference Call: Monday 11am-12 Pacific Time.
I will email phone number asap.


Below is a summary of documentation topics/framework.

------------------------------------------------------------------------------------------------------------------

Conference Call Discussions Topics:

1) comments on the current documentationFramework of actors
    a) areas that need improvement/changes?
    b) questions on the current documentationFramework
2) discussion on implementation of workflow documentation framework
3) other comments ?

----------------------------------------------------------------------------------------------------------------------


Here are the basic steps summarized to get started with the process of
generating Documents as well as viewing Documentation from canvas.

Firstly there are 2 locations of documentation:
--> HTML Page Documentation ( A listing of all actors and their respective
MAN pages ,found in
kepler-docs/dev/documentationFramework/generatedHTMLPages)
--> Canvas Documentation  ( Right clicking an actor to get/edit the
documentation ,modified instance documentation stored in worfklow MOML
file & base class documentation found in
kepler-docs/dev/documentationFramework)

-------------------------------------------------------------------------------------------------------------
Generating Docs:

1) Check out kepler-docs at the desired location
    > cvs -d :ext:username at cvs.ecoinformatics.org:/cvs co kepler-docs
2) Set KEPLER_DOCS env. variable to point to the folder
3) If Ptolemy,Kepler builds have never been created, kindly do so now
4) Under kepler Home
    > ant generateDoc

HTML MAN pages:The above steps generate the required ptolemy and kepler
documentation under
$KEPLER_DOCS/dev/documentationFramework/generatedHTMLPages
You can veiw the above folder to see HTML form documentation of actors.
1) Open the "FinalDeveloperDocumentation/FinalUserDocumentation" HTML Page.

Canvas Documentation: The above steps also enable viewing documentation
from the "Get Documenation" feature by right-clicking actor.
1) Drag the actor on the canvas
2) Right click actor and then choose the "Get Documenation" option.
-----------------------------------------------------------------------------------------------------------------

Editing Docs:

1) In the actor's source file edit the javadocs information to include
actor's developler level description,authors, version , ports n parameters
dev level descriptions
2) User level description to be added by Non-Developers like Laura,Samantha.

For a sample format of how to add documentation kindly see the
"documentationFrameworkTutorial" under
$KEPLER_DOCS/dev/documentationFramework.

3) After modifiying your actor source files, under Kepler home
   > ant generateDoc
4) Don't forget to check in the CVS your new actor source file as well as
new HTML page generated under
$KEPER_DOS/dev/documentationFramework/generatedHTMLPages/developer

--------------------------------------------------------------------------------------------------------------------


thanks,
nandita.