next up previous contents
Next: 10.1 PaPCo interface templates Up: PAPCO User Guide Previous: 9.3 PAPCO finishing log

   
10. Templates for PaPCo

The PaPCo distribution contains a template of a standard module directory structure with all the files needed to construct a simple module, to make the design of new modules easier. This template resides in the PaPCo module directory, in papco_XX/papco_modules/plot_type.

The general idea is that you copy the template directory structure, rename all the occurrences of plot_type with the name of your own module (including the directory name, the filename and the contents of the files) and then add any specifics you need for your own plot type.

If you're working under UNIX and have the sed utility available, you can use the PaPCo routine make_new_module.pro to automatically create a correctly named module directory & file structure for you (see Section 6.2).

The templates are extensively commented in the files themselves (any line starting with a semicolon). It is probably a good idea to have a look at some other simple existing modules too, such as the OMNI module (in papco_XX/papco_modules/omni).

The template as it stands is a fully functioning module which works with one single data file included in the module (for 11. January 1997). When you install PaPCo this template module is installed along with it and you can play with it to test out its functionality by setting the time to 11.01.97 and pressing the plot_type button to add some panels. Remember to set the correct data path using the panel editor config button. The data file will be fetched using the remote get data facility.

Included with the distribution are some sample product files. You can load these using the LOAD button, those whose name includes ``plot_type'' are for the plot_type module template.

This template does not include examples of slices beyond the simple zoom functionality: this will be added for a later release...

The plot_type_panel.help template (Section B.1.4) is not an IDL routine put a sample help file which is called by the panel editor help button. It resides in the module directory for the given module in the subdirectory papco_interface.

Please write such a help file for your module using this template, it is of great help to potential other users of your module.

As the use of these templates is quite pivotal to the successful customization of PaPCo by any user their quality and utility are very important. If you have any comments or suggestions or criticisms about these templates and would like to suggest improvements, please contact the author of this document.



 
next up previous contents
Next: 10.1 PaPCo interface templates Up: PAPCO User Guide Previous: 9.3 PAPCO finishing log
Reiner Friedel
1999-02-03