This section describes the directory structure of the project. It's important
that all source files are placed in the right subdirectory, according to their
use and implementation.
Projects root directory This directory contains the startup script edoc.pl .
/class
This directory contains all PERL packages (*.pm ) that are coded in an object orientated way.
The created objects can be Perl/Tk widgets, Perl/Tk Toplevel windows or simply "normal" PERL objects.
/ui
Here are all UserInterface build functions for the objects contained in root-dir/class that represent a Toplevel window.
/lib
This directory contains all PERL packages (*.pm ) that are NOT coded in an object orientated way, they all contain
functions that are used allover the project again and again. All functions that cover the same probem group are packed together
into one package. For example InOut.pm contains all functions that write onto disk and read from there.
/config
This directory contains all configuration files that are:
- edoc.int .... The internal document definition
- edoc.cfg .... The configuration of e:doc (user interface, file types ...)
- edoc.mac .... The macros that belong not to a specific backend
- {backend_name}.out .... The output definition for a specific backend
- {backend_name}.mac .... The macros that belong to a specific backend
/doc
This directory contains all documentation from the documentation project in HTML files.
/graphics
This directory contains all graphic files that are needed for the application.
/widgets
This directory contains files that are thought to be redistributed via CPAN as stand-alone widgets.
These files have therefore be totally independend from e:doc.
|