Changes between Version 1 and Version 2 of Paose/Documentation/HowTo-CDDs

Timestamp:

Nov 1, 2010, 10:30:56 AM (14 years ago)

Author:

Lawrence Cabac

Comment:

Added setup of generator

Paose/Documentation/HowTo-CDDs

@@ -20 +20 @@
 It facilitates Velocity templates for that cause. 
 Following parts are generated: 
- - Folder structure of the plugin with source code structur for
+ - Folder structure of the plugin with source code structure for
   - Interactions (. . . /interactions/) 
   - Roles (. . . /roles/) 
@@ -28 +28 @@
  - Plugin configuration (plugin.cfg) 
  - Start scripts (start.sh, sartCapa.rnw, startKBE.sh) 
- - Skeleton:  Roles/Dependencies Diagram and a Project-File (!RolesDependencies.mad, pro jects.xml) 
- - Protégé: Ontology Files (<name>.pprj, <name>.pons, <name>.pint) 
+ - Skeleton:  Roles/Dependencies Diagram and a Project-File (!RolesDependencies.mad, projects.xml) 
+ - Protégé: Ontology file skeletons (<name>.pprj, <name>.pons, <name>.pint)
+ - FS Ontology: Concept Diagram skeleton as an alternative to Protégé 
  - Skeletons: AIPs for all Interactions, containing role names of all Participants. (<interaction>.aip) 
-After generation the plugin compiles with ant, it can be deployed through a repository (subversion) and the domain specific design of the system starts.
 
+== Generation == 
+The name and the location for the created files have to be defined when generating files. 
+The generator will prompt you for both, the name and the location.
+Alternatively, the name can be defined in a configuration file ending on .plg. 
+The property name is ''appName''. 
+It has to be defined in a Java Properties style (e.g. appName=MyApplication).
+
+=== Setting-Up Generator: ===
+ - Draw a Use Case Diagram with the elements from the tool palette. Use actors for agent roles and cases for interactions.
+ - Use the ''Create Folder Structure'' (or the ''Create Agentlet'') Command to start the generation process.
+ - Select a plugin.cfg (*optional*). You can skip this and instead in the next step...
+ - Choose a (new) name for your Application (Plugin). Use camel case, start with a capital and abide to Java conventions (e.g. do not use ''\_'').
+ - Choose a location. This should be a repository that is prepared for the compilation of plugins (e.g. Mulan, CAP). Be careful, Java folder selection is tricky. Double-clicks might not work as expected (i.e. select CAP in the folder above CAP and confirm by pressing the button).
+ - Some log output concerning the created files will be promted.
+
+After generation the plugin compiles with ''ant fsdist'' (or ''ant dist'', ''ant fsdist-nosns'',...), it can be deployed through a repository (subversion) and the domain specific design of the system starts.
 
 == (4) Inscriptions (Actors, Interactions): ==