AMAPstudio

User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
documentation:new_module [2018/10/31 11:01]
beudez [2.2 Option 2: Create the skeleton by duplicating automatically an existing module (recommended)]
documentation:new_module [2019/09/04 16:35] (current)
beudez [5. Compile and test the new module skeleton]
Line 21: Line 21:
 The easiest way is to come and meet the developper team in Montpellier. We periodically organise short training sessions and starting stages to accompany the incoming Capsis modellers. The easiest way is to come and meet the developper team in Montpellier. We periodically organise short training sessions and starting stages to accompany the incoming Capsis modellers.
  
-If you are far from France, you may try to do it by yourself with the help of the Capsis developpers by mail, with the documentations on the capsis ​web site (particularly the present documentation) and possibly with the help of a local Java developper in your own institution.+If you are far from France, you may try to do it by yourself with the help of the Capsis developpers by mail, with the documentations on the Capsis ​web site (particularly the present documentation) and possibly with the help of a local Java developper in your own institution.
 ===== Accept the Capsis Charter to become a Capsis modeller ===== ===== Accept the Capsis Charter to become a Capsis modeller =====
  
Line 57: Line 57:
 You can use the **create-module** command of Ant to generate a copy of the template module. For that you have to type the following command from the capsis4/ directory. You can use the **create-module** command of Ant to generate a copy of the template module. For that you have to type the following command from the capsis4/ directory.
  
-On Linux/MacOS:+On Linux/macOS:
  
 <​code>​ <​code>​
Line 75: Line 75:
 ==== 2.2 Option 2: Create the skeleton by duplicating automatically an existing module (recommended) ==== ==== 2.2 Option 2: Create the skeleton by duplicating automatically an existing module (recommended) ====
  
-It is possible using the **duplicate-module** command of Ant to duplicate an existing module ​located in the //​capsis4/​src//​ directory ​in order to create a new module having a new package name, a new module name and a new prefix. The user chooses the new package name and the new prefix, and the new module name is created automatically from the new package name.+It is possible using the **duplicate-module** command of Ant to duplicate an existing module in order to create a new module having a new package name, a new module name and a new prefix.
  
 See: [[documentation:​duplicatemodule|How to duplicate a module]] See: [[documentation:​duplicatemodule|How to duplicate a module]]
Line 117: Line 117:
 **Reminder:​** package names are all lowercase, ClassName and Prefix start with an uppercase. **Reminder:​** package names are all lowercase, ClassName and Prefix start with an uppercase.
  
-==== 4. Update the capsis/​etc/​capsis.models file ====+==== 4. Update the capsis4/​etc/​capsis.models file ====
  
-Add a line for the new module in the case it has been created by copying an existing module (see section 2.2 above). The name to be specified is the package name all in lowercase letters.+Add a line for the new module in the case it has been created by copying ​by hand an existing module (see [[documentation:​new_module?&#​option_3create_the_skeleton_by_copying_by_hand_an_existing_module_experts_only|section 2.3]]). The name to be specified is the package name all in lowercase letters.
  
-If the new module has been created using the ''​ant ​create-module''​ command ​(see section 2.1 above) or the ''​ant ​duplicate-module''​ command ​(see section 2.3 above) there is nothing to do: the line for the new module has been automatically ​added to the capsis/​etc/​capsis.models file.+If the new module has been created using the **create-module** (see [[documentation:​new_module?&#​option_1create_the_skeleton_from_the_template_module_recommended|section 2.1]]) 
 +or the **duplicate-module** (see [[documentation:​new_module?&#​option_2create_the_skeleton_by_duplicating_automatically_an_existing_module_recommended|section 2.2]]commands of Ant, then there is nothing to do: the line for the new module has been added automatically ​to the capsis4/​etc/​capsis.models file.
 ==== 5. Compile and test the new module skeleton ==== ==== 5. Compile and test the new module skeleton ====
  
 Force a general recompilation with the following command (from the Capsis install directory). Force a general recompilation with the following command (from the Capsis install directory).
  
-On Linux/MacOS:+On Linux/macOS:
 <​code>​ <​code>​
 sh ant clean compile sh ant clean compile
documentation/new_module.1540980096.txt · Last modified: 2018/10/31 11:01 by beudez