Changes between Version 2 and Version 3 of GROUP_PLUGIN_STRUCTURE_R0

Timestamp:

03/31/09 15:39:57 (16 years ago)

Author:

pav

Comment:

--

GROUP_PLUGIN_STRUCTURE_R0

@@ -30 +30 @@
  * One part of the convention is that there couldn't be module with name x.y if there is already module named x.y.z.
  * Functional modules should be separated to [modulename].viewer and [modulename].editor 
- * There should be new org.sophie2.main.app module which will contain classes for the whole application(for example left and right flap,
+ * There should be new org.sophie2.main.app module which will contain classes for the whole application(for example left and right flap, main window, app view, etc)
 
 == Related ==
@@ -41 +41 @@
 
 = Design =
- * The naming convention(or the rules - there can be some exceptions so convention may be is not the right word):
-  * there
+ * The naming convention(or the rules - there can show some exceptions so convention may be is not the right word):
+  * It is recommended not to have module with name x.y if there is already module named x.y.z.
+  * Modules for the reader ends with .viewer and for the author - with .editor. (i.e. org.sophie2.extra.pdf.editor, org.sophie2.extra.pdf.viewer, etc..)
+  * When you write module which provides specific functionality you have to add .func before its name.(For example org.sophie2.main.func.file, org.sophie2.main.func.config - functional modules are always with org.sophie2.main prefix)
+  * When you create module which is concrete implementation of a base library, name it like the base module but with main except the base word.(org.sophie2.base.media -> org.sophie2.main.media)
+  * If you want to write a module which is not concrete implementation of base library or concrete functionality(and is not core logic or base library), name it with org.sophie2.main. prefix before the module name.
+  * Add .commons and .util suffices when needed so the first rule is respected.
+  * Note: write in comments section for more ideas about naming convention.
+ * Remove:
+  * org.sophie2.main module
+  * view word in main halos, layout and menus module.
+  * org.sophie2.messy module
+  * org.sophie2.main.func.file
+ * Rename:
+  * org.sophie2.main.view to org.sophie2.main.app.view and remove the Main class there
+  * org.sophie2.extra modules to org.sophie2.extra.func 
+  * org.sophie2.base to org.sophie2.base.commons
+  * org.sophie2.main.media to org.sophie2.main.func.media
+  * org.sophie2.main.model to org.sophie2.main.app.model
+  * org.sophie2.main.model.book.format.r1/r2 to org.sophie2.main.persistence.r1/r2
+ * Create:
+  * org.sophie2.reader module with FakeReaderMain and with reader.bundles.config file
+  * org.sophie2.main.func.resources and move resource manipulation and view classes there
+  * org.sophie2.main.model.text with text model.
+  * org.sophie2.func.image with image functionality.
+  * new legacy package in main.app, main.model, with legacy views and logic.
+  * org.sophie2.core.prolib
+  * org.sophie2.core.testing
+  * org.sophie2.main.app.dialogs and move the dialogs from main.app.view and main.func.file there
+  * org.sophie2.main.func.hottext
+
+ * Move:
+  * BookExtra in main.app module
+  * mvc.logic in core.mvc under legacy package
+  * org.sophie2.main.dialogs.input to org.sophie2.main.app.dialogs
+
 
 = Implementation =