914
edits
Changes
src -> gramps
Finished: Gramps 4.0 (See [[Gramps 4.x File Organization]])
Gramps was originally written as a GTK application intended to only be used in a graphical environment. Over time, support has been added for other user interfaces (CLI and web). In order to reduce unnecessary dependencies between the various interfaces, the software architecture is being organized into 5 main categories of code - each in their own directory.
The descriptions below provide the general purpose and scope of each category. Not all code in the source tree conforms to this architecture yet. However, new code should attempt to move the source in a direction that conforms to this organization. ''Moving to this architecture is an ongoing process and a work in progress.''
== gramps/gen/ ==
This directory contains the core components of Gramps. The gramps/gen/ directory shall not have any dependencies on the other top level source directories (gramps/gui/, gramps/cli/, gramps/webwebapp/, etc). The gramps/gen/ directory also shall not have any dependencies on the gtk library.
The word "gen" was chosen because it is short for "general" and "generic" which is a good way to describe code in this directory because it doesn't depend on or require a specific user interface. "gen" is also short for "genealogy" which is also an appropriate term for the code in this directory because it implements the "business logic" that makes Gramps a genealogy application.
=== gramps/gen/lib/ ===
The lib directory contains the classes for the database objects.
=== gramps/gen/merge/ ===
The plug directory contains the core logic for registering and running plugins. It also contains any utility classes used by plugins.
==== gramps/gen/plug/report/ ====
This directory contains the base class for reports, constants, and basic utilities.
=== gramps/gen/proxy/ ===
This directory contains classes to provide proxy access to the Gramps database.
=== gramps/gen/simple/ ===
This directory contains classes to provide simple access the Gramps database and reports.
=== gramps/gen/utils/ ===
This directory contains utility functions.
== gramps/gui/ ==
This directory contains the code for the object editors used in the GUI.
==== gramps/gui/editors/displaytabs/ ====
This directory contains the code for the tabs used in the GUI editors.
This directory contains the code for the GUI filter interface.
==== gramps/gui/filters/sidebar ====
This directory contains the code for the GUI sidebar filters.
=== gramps/gui/glade/ ===
This directory contains Glade user interface definition files.
=== gramps/gui/logger/ ===
The gui.plug directory contains windows, dialogs, and tools that the plugins will use.
==== gramps/gui/plug/export ====This directory contains the GUI code for running export plugins. ==== gramps/gui/plug/quick ====This directory contains the GUI code for running quick view plugins. ==== gramps/gui/plug/report ====
This directory has the dialogs for running reports, such as selection criteria, file pickers, and paper sizes.
=== gramps/gui/selectors/ ===
This directory contains the code for the object selection dialogs in the GUI.
=== gramps/gui/views/ ===
This directory contains the code for the various graphical "views" in the GUI.
==== gramps/gui/views/treemodels/ ====
This directory contains the code for the models used in the GUI.
=== gramps/gui/widgets/ ===
This directory contains the code for the command line interface.
== gramps/webwebapp/ ==
This directory contains the code for the gramps-connect web interface.
=== gramps/plugins/rel/ ===
This directory contains the relationship calculator plugins.
=== gramps/plugins/sidebar/ ===
* #{{bug|2622}}: File Organization (GEPS 008)
* #{{bug|4646}}: reports cannot be run from the command line in a non-GUI environment
* #{{bug|2621}}: use python-setuptools instead of make (See [[GEPS 026: Replace 'make' for Gramps build]])
[[Category:GEPS|F]]
