Changes between Version 2 and Version 3 of PLUGIN_MODULE_STRUCTURE

Timestamp:

01/14/09 17:48:04 (16 years ago)

Author:

pav

Comment:

--

PLUGIN_MODULE_STRUCTURE

@@ -6 +6 @@
 The structure of Sophie 2 module can be seen on [wiki:PLATFORM_STRUCTURE] page, second table.
 === Proto Project ===
-We created a proto project module so we can easily create new modules with the correct structure. It is stored in the [source:/trunk/sophie2-platform/dev-tools] in zip format. Its structure is just like the module structure described in [wiki:PLATFORM_STRUCTURE] except the target folder, which is created after the build process. [[BR]]
+We created a proto project module so we can easily create new modules with the correct structure. It is stored in the [source:/trunk/sophie2-platform/dev-tools] in zip format. Its structure is just like the module structure described in [wiki:PLATFORM_STRUCTURE] except the target folder, which is created after the build process. [[BR]]`
 It contains the needed folders created and: 
  * Hello.java simple class to prevent failing the build if the module creator forgets to put classes in his/her new module.
@@ -12 +12 @@
 === How to make a new module ===
 This is important so be careful reading and doing the steps:
- * 
+ * Extract the archive org.sophie2.proto.project(the .zip file doesn't contain .svn files for its subfolders so you don't have to deal with nasty svn issues later), located in [source:/trunk/sophie2-platform/dev-tools]. in the [source:/trunk/sophie2-platform/modules modules] folder.
+ * Edit its pom.xml file, changing the 'artifactId'. All other occurencies of org.sophie2.proto.project (for example in the <Export-Package> should be replaced with the new module name. You should also edit the <name> and <description> tags. You can look at the <instructions> tag if your module requires a main class or a class, extending SophieModule.
+ * Rename the org.sophie2.proto.project folder to the name of the new module(using the file system or Refactor->Rename in Eclipse).
+ * Add the name of the new module to the [source:/trunk/sophie2-platform/pom.xml] - modules section.
+ * In Eclipse - Select 'Import'->'Maven Projects'->Choose the 'Root Directory' to be sophie2-platform folder in the repo and select the new module shown in the 'Projects' box-> Click Finish. 
+ * The project is shown and it has errors because the package is not correct - rename the package to be your new module name and you are ready to go.
 
 == Sophie Modules ==
@@ -22 +27 @@
 === Functionality ===
 The list of modules and their functionality in few words:
- * org.sophie2.author - 
- * org.sophie2.
+ * org.sophie2.author - It is one of the main sophie2 parts and represents the Author Sophie2 edition. For now provides main method for running the application under Eclipse. It has varous configuration files in resources folder - for log4j, runtime properties and file with modules to be loaded for the author edition.
+ * org.sophie2.base.* - Contains classes which provides base functionally for persistence, scenes, model book and resource models, layouts, halos and dialogs. org.sophie2.base module will be decomposed more in the future.
+ * org.sophie2.core - Provides the core functionality. Contains 'properties' implementation(See [wiki:PRO_LIB_CORE_TUTORIAL], mvc logic implementation and testing package with the testing help classes. It will be decomposed more.
+ * org.sophie2.core.modularity - Provides classes for dealing with common modularity issues and has very good demonstration(in the test folder) using them.
+ * org.sophie2.launcher - Module for launching the editions and loading the modules needed. Contains Main which runs the application under JavaWebStart.
+ * org.sophie2.main.* - Contains the main implementation for sophie2 components. Provides the viewed part of the project.
+ * org.sophie2.messy - For 'messy' things. Contain everything that isn't already decomposed.
+ * org.sophie2.server.* - Contains the sophie2 server libraries and starting server configurations.
+=== Extension/Extension Points ===
+
+==== Description ====
+
+==== Usage ====
+
+=== Shared Resources ===
 
 |_Basic module structure