[[BackLinksMenu]]

[[TicketQuery(summary=PLUGIN_MODULE_STRUCTURE_R1, format=table, col=summary|owner|status|type|component|priority|effort|importance, rows=description|analysis_owners|analysis_reviewers|analysis_score|design_owners|design_reviewers|design_score|implementation_owners|implementation_reviewers|implementation_score|test_owners|test_reviewers|test_score|)]]
= Analysis =
== Overview ==
This revision should explain throughly the structure of the module, what is inside a module, where are stored different components, what defines external and shared components, how are they loaded, etc. Each module has different structure in development, compiled and runtime stages. This revision should explain the differences between them.
== Task requirements ==
 * Explain the structure of an example module
 * List elements that are obligatory for each module 
  * link explanations of them if any
  * write explanations
{{{
org.sophie2.m1
|_pom.xml
|_src
|__main
|___java
|____*.java
|___resources
|____*.png
|__test
|___java
|____*.java
|___resources
|____*.png
|_target
|__classes
|__test classes
}}}
 * List available modules now
 * Describe specific information about available modules.
 * Include the information from [wiki:PLUGIN_MODULE_STRUCTURE_R0]
 * Explain differences between module in the repository and in the distribution. 
== Task result ==
[wiki:PLUGIN_MODULE_STRUCTURE]

== Implementation idea ==
Implement this task in parallel with [wiki:PLATFORM_STUCTURE_R2]. Use 
{{{
/trunk/sophie2-platform/modules/org.sophie2.*/
/trunk/sophie2-platform/modules/org.sophie2.*/.settings	project settings configurations for Eclipse. They must be synchronized with the sophie2-platform project settings
/trunk/sophie2-platform/modules/org.sophie2.*/target	contains compiled classes
/trunk/sophie2-platform/modules/org.sophie2.*/src	contains sources and configuration files
/trunk/sophie2-platform/modules/org.sophie2.*/src/test/java	contains unit tests
/trunk/sophie2-platform/modules/org.sophie2.*/src/test/resources	contains unit tests' tools (scripts, documentation, needed files for the tests)
/trunk/sophie2-platform/modules/org.sophie2.*/src/main
/trunk/sophie2-platform/modules/org.sophie2.*/src/main/resources	contains the resources which the module uses
/trunk/sophie2-platform/modules/org.sophie2.*/src/main/resources/distrib	each module contains its own distrib folder it is used it contains the files which will be installed on the users machine in order each module to be completely funtional
/trunk/sophie2-platform/modules/org.sophie2.*/src/main/java
/trunk/sophie2-platform/modules/org.sophie2.*/src/main/java/org
/trunk/sophie2-platform/modules/org.sophie2.*/src/main/java/org/sophie2	contains application sources
}}}

== Related ==
[wiki:PLUGIN_MODULE_STRUCTURE_R0] [[BR]]
[wiki:PLATFORM_STRUCTURE_R2] [[BR]]

== How to demo ==
Present [wiki:PLUGIN_MODULE_STRUCTURE]

= Design =

= Implementation =
^(Implementation results should be described and linked here (from the wiki or the repository))^

= Testing =

= Comments =
^(Write comments for this or later revisions here.)