Source code restructuring plan

Registered by Charles Edward Pax

The structure of our source code needs to be more logical. This is particularly important as we begin the 0.4 development cycle.

Blueprint information

Status:
Complete
Approver:
Christopher Pax
Priority:
Essential
Drafter:
Christopher Pax
Direction:
Approved
Assignee:
Christopher Pax
Definition:
Drafting
Series goal:
Accepted for 0.3
Implementation:
Implemented
Milestone target:
None
Started by
Charles Edward Pax
Completed by
Charles Edward Pax

Related branches

Sprints

Whiteboard

pax: Here is the proposal.

FILE STRUCTURE
==============
Package: gladex
---------------
/usr/bin/gladex
/usr/share/applications/gladex.desktop
/usr/share/doc/gladex/
/usr/share/gladex/examples/
/usr/share/gladex/gladex.glade
/usr/share/gladex/gladex-gui.py
/usr/share/gladex/gladex-gui_callbacks.py <== Callback functions for gladex-gui
/usr/share/gladex/gladex.conf (gladexrc?) <== Gladex default configuration file
/usr/share/gladex/templates/default/callbacks.template <== Callback default template
/usr/share/gladex/templates/default/main.template <== Main default template
/usr/share/pixmaps/gladex.png <== Gladex logo
/usr/share/pixmaps/gladex.xpm <== Gladex logo

(proposed for plugins)
/usr/share/gladex/plugins/pluginName/pluginName.info <== pluging information
/usr/share/gladex/plugins/pluginName/templates/callbacks.template <== template for callbacks file
/usr/share/gladex/plugins/pluginName/templates/main.template <== template for main file
/usr/share/gladex/plugins/pluginName/dictionaries/ <== directory containing dictionary generation code

Package: gladex-src
-------------------
gladex/AUTHORS <== list of authors
gladex/COPYING <== GPL
gladex/Makefile
gladex/README <== release notes and other info
gladex/src/gladex.glade <== Glade XML file
gladex/src/gladex.py --> /usr/bin/gladex
gladex/src/gladex-gui.py --> /usr/share/gladex/gladex-gui.py
gladex/src/gladex-gui_callbacks.py --> /usr/share/gladex/gladex-gui_callbacks.py
gladex/bin/
gladex/pixmaps/gladex.png <== Gladex logo
gladex/pixmaps/gladex.xpm <== Gladex logo
gladex/plugins/

(?)

Work Items

This blueprint contains Public information 
Everyone can see this information.

Subscribers

No subscribers.