CCP4i: Graphical User Interface
	Documentation for Programmers
	The modules File

The modules File

The modules file defines which items appear in the task menu list on the left hand side of the CCP4i main window. The file has the full path name $CCP4I_top/etc/modules.

The CCP4i convention is to organise the functionality into tasks (where one task usually corresponds to one major program) and then to group the tasks into modules (where each module is a stage in the crystallographic refinement procedure). There is also a 'Program List' module which is just a list of the interfaced programs in alphabetical order. There is a menubutton in contrast colour near the top left of the main window which is used to select a module. The tasks in the module are listed beneath the module menubutton. By convention the tasks are listed in the order that you would expect them to be used in a refinement procedure.

If you look at the first few lines of the modules file, you will see the following keywords followed by some text:

PROJECT

The name of the project - usually CCP4

TITLE

The title of the project which will be the title given to the main window

MODULE

This is followed by a single word name for a module modulename and then the text which will appear in the main window module_title.
Following the MODULE line are pairs of lines which define the tasks within the module. The first task line has a single word taskname followed by the task_title which is the text which will appear in the main interface. The second line is a brief task_description, a description of the task which will be used for the message line help (i.e. the information which appears when the cursor is over the button for the task).

The module_title and task_title will appear in the main window but the other information is used to find the files needed for the task interface.

The taskname specifies the names of the files which define the task window. These are the .def file $CCP4I_top/tasks/taskname.def and the .tcl file $CCP4I_top/tasks/taskname.tcl. If these files do not exist, the task will not be list in the task menu.

The modulename is used to specify the name of the help file which contains an overview of the tasks in the module: $CCP4I_HELP/modules/modulename.html. By default the Help button on the top right of a task window will link to this help file.