| | 1 | [[BackLinksMenu]] |
| | 2 | |
| | 3 | [[TicketQuery(summary=GROUP_PLUGIN_STRUCTURE_R0, 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|)]] |
| | 4 | |
| | 5 | = Analysis = |
| | 6 | |
| | 7 | == Overview == |
| | 8 | The goal of this task is to decompose and restructure currently available plugins. All of this is important for modularizing the project and working easily with the modules we have(later enabling/disabling them) and the new ones that will come(their naming, extensions and module classes). |
| | 9 | |
| | 10 | == Task requirements == |
| | 11 | * The modules which provides too many different functional things should be decomposed. |
| | 12 | * Some of the modules should be restructured so that they represent: |
| | 13 | * core library |
| | 14 | * base library |
| | 15 | * well-defined functionality |
| | 16 | * implementation of the base library |
| | 17 | * Some of the modules should be renamed. Create convention in the design section so the next newly created modules should be named using it. (i.e. there can't be module named x.y if there is already a module with name x.y.z) |
| | 18 | * There should be separation between modules used in author edition and modules for the reader edition. This is connected with [wiki:GROUP_READER_R0]. |
| | 19 | * Create new modules for text, reader, resources(main.func.resources). Consider what more has to be separated in a new module in the design. |
| | 20 | * Preview org.sophie2.proto.project and make it more comfortable for using. |
| | 21 | * Preview pom.xml, remove the dependencies which are not needed (they are shown as warnings when building with maven) and add more brief descriptions of the modules. |
| | 22 | * If there is time left update [wiki:PLUGIN_MODULE_STRUCTURE] page. |
| | 23 | |
| | 24 | == Task result == |
| | 25 | * Descomposed, restructured, renamed and new modules. |
| | 26 | * Created distribution with assembly plugin. |
| | 27 | * updated wiki page |
| | 28 | |
| | 29 | == Implementation idea == |
| | 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. |
| | 31 | * Functional modules should be separated to [modulename].viewer and [modulename].editor |
| | 32 | * There should be new org.sophie2.main.app module which will contain classes for the whole application(for example left and right flap, |
| | 33 | |
| | 34 | == Related == |
| | 35 | [wiki:PLUGIN_MODULE_STRUCTURE][[BR]] |
| | 36 | [wiki:PLUGIN_EDITIONS_STRUCTURE][[BR]] |
| | 37 | [wiki:PLUGIN_DECOMPOSITION_R2] |
| | 38 | |
| | 39 | == How to demo == |
| | 40 | Show the new module decomposition and the new convention for naming the modules. |
| | 41 | |
| | 42 | = Design = |
| | 43 | ^(Describe your design here.)^ |
| | 44 | |
| | 45 | = Implementation = |
| | 46 | ^(Describe and link the implementation results here (from the wiki or the repository).)^ |
| | 47 | |
| | 48 | = Testing = |
| | 49 | ^(Place the testing results here.)^ |
| | 50 | |
| | 51 | = Comments = |
| | 52 | ^(Write comments for this or later revisions here.) |
