IDE

DFF Integrated Development Environment (IDE) can be used to generate skeletons for DFF scripts, modules or graphical modules. To launch it you can both use the IDE icon of the Application tool bar or with the menu IDE -> Open.

Get started

The IDE looks as on the following screen-shot :

The left part is used to browser your file system and select which file you want to open (only python files can be opened, with the extension .py). To open a file double click on its name and its content will be displayed (on the screen-shot the merge.py file was opened).

Here is the description of the different icons of the tool-bar :

• New empty file : Open an empty file in the IDE.
• Generate skeleton : Start the wizard which will help you to configure the module you are about to develop.
• Open file : Open an existing file.
• Save : Save a file.
• Save as : Save a file and name it.
• Load : Dynamically load the current module without restarting DFF.
• Undo : Undo the previous action.
• Redo : Redo the next action.
• Comment : Comment the line on which the mouse cursor is located.
• Uncomment : Uncomment the line on which the mouse cursor is located.

Wizard

Use the Generate skeleton icon to start the wizard. A dialog box will be opened :

They are several points needing to be configured :

• Name : the name of your module.
• The module category : modules are organized under categories (file systems, Node, search, etc). The list of all categories can be accessed through the menu Modules of the application menu. In the list select the category in which you want to add the module or type a new name if you want to create a new category.
• Work location : use the browse button to define in which directory you want to create your script.
• Type : select the radio box according to the type of module you want to develop.

Once this is done, click on Next.

The next screen will ask you for a short description of the module (you can leave it empty) :

Click on Next.

Enter your name and email address so they are properly included in the module header, and click on Finish. The dialog box will be closed and new tab will be opened in the IDE, with the skeleton of the module.

You can now work on your module and modify it so it does the task it is supposed to do. You can use the different functionalities of the tool bar and the Load button to dynamically load the module without restarting DFF.