| 17 | | '''Repository setup'''. Once you have installed SVN, you can download the repository on your own machine. Basically, this means you will have your copy of the project. In Windows, just choose a folder on your drive, right click and select SVN Checkout. Further explanation for the repository links / structure / rules for committing can be found at [wiki:PLATFORM_STANDARDS_REPOSITORY]. Just before you continue to the next step, you should know how to submit a file to the repository (for example, your daily report).[[BR]] |
| | 17 | '''Repository setup'''. Once you have installed SVN, you can download the repository on your own machine. Basically, this means that you will have your own copy of the project. In Windows, just select a folder on your drive, right click and select SVN Checkout. Further explanation for the repository links / structure / rules for committing can be found at [wiki:PLATFORM_STANDARDS_REPOSITORY]. Before you continue on to the next step, you should know how to submit a file to the repository (for example, your daily report).[[BR]] |
| 30 | | '''Eclipse setup'''. The software platform we use for developing Sophie 2.0 is Eclipse. First of all, the installation. |
| 31 | | Download the latest eclipse version from [http://www.eclipse.org/downloads/] and install it to your computer. Then, modify your compiler settings according to the [wiki:COMPILER_SETTINGS] document. The next two steps, Subclipse installation and Maven integration, are described in [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW#EclipsePlug-ins]. The most important for these is that they are eclipse plugins, which integrate the subversion and maven functionalities in Eclipse. The M2 plugin is required for loading our maven project in eclipse. Once you have installed the plugins, you can follow the steps from [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE], which describes how to import Sophie 2.0 in Eclipse and run the FakeAuthor configuration. [[BR]] |
| 32 | | You already have everything needed to develop for Sophie 2.0. :) |
| | 30 | '''Eclipse setup'''. The software platform we use for developing Sophie 2.0 is Eclipse. First of all, the installation: |
| | 31 | Download the latest Eclipse version from [http://www.eclipse.org/downloads/] and install it to your computer. Then, modify your compiler settings according to the [wiki:COMPILER_SETTINGS] document. The next two steps, Subclipse installation and Maven integration, are described in [wiki:PLATFORM_INFRASTRUCTURE_OVERVIEW#EclipsePlug-ins]. The most important for these is that they are Eclipse plugins, which integrate the subversion and maven functionalities in Eclipse. The M2 plugin is required for loading our maven project in Eclipse. Once you have installed the plugins, you can follow the steps from [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE], which describes how to import Sophie 2.0 in Eclipse and run the FakeAuthor configuration. [[BR]] |
| | 32 | You now have everything you'll need to develop for Sophie 2.0! :) |
| 45 | | * MAIN and EXTRA: they contain the main functionality, which makes Sophie 2.0 a complete platform. These two are split according to the dependencies, so that MAIN does not depend on EXTRA. |
| 46 | | * SCS: Sophie community server. It includes the Trac system we use, the Subversion, |
| | 45 | * MAIN and EXTRA: these contain the main functionality, which makes Sophie 2.0 a complete platform. They are split according to dependencies, so that MAIN does not depend on EXTRA. |
| | 46 | * SCS: Sophie community server. It includes the Trac system we use, the Subversion, and provides information for the external contributors. |
| 56 | | This chapter includes the states of each task until it is completed, the rules you have to follow when performing a task, |
| 57 | | Generally speaking, every task must first be analyzed, then a design must be made, and finally the design is implemented. If the task is a coding one, its implementation is tested. After each phase, a review is made. The tasks, sorted by iterations, can be looked at [http://sophie2.org/trac/roadmap]. The exact task states and much more are described and regularly updated at [wiki:PROCESS]. This document is fundamental, so read it carefully. Also, tasks are of several different types. For an explanation what the types are, read [wiki:PLATFORM_STANDARDS_GENERAL]. [[BR]] |
| 58 | | Every state of a task is important. However, here are the existing recommendations for performing various actions: |
| 59 | | * Analyzing: [wiki:PLATFORM_STANDARDS_ANALYSIS how to write good analysis]. Please note that when you create an analysis, the wiki page you write it in most probably won't exist. If you are logged in the Trac, you will be asked whether to use a page template. You should use TaskPageTemplate. |
| | 56 | This chapter includes the states of each task until it is completed, the rules you have to follow when performing a task, including some good/bad examples.[[BR]] |
| | 57 | Generally speaking, every task must first be analyzed, then a design must be prepared, and finally the design can be implemented. If the task is a coding one, its implementation is tested. After each phase, a review is made. The tasks, sorted by iterations, can be looked at [http://sophie2.org/trac/roadmap]. The exact task states and much more are described and regularly updated at [wiki:PROCESS]. This document is fundamental, so read it carefully. Also, tasks are of several different types. For an explanation what the types are, read [wiki:PLATFORM_STANDARDS_GENERAL]. [[BR]] |
| | 58 | Every state of a task is important. However, here are our current recommendations for performing various actions: |
| | 59 | * Analyzing: [wiki:PLATFORM_STANDARDS_ANALYSIS how to write good analysis]. Please note that when you create an analysis, the wiki page you write it in most probably won't exist. If you are logged into the Trac, you will be asked whether you want to use a page template. You should use TaskPageTemplate. |
| 68 | | '''Design'''. Here will be some of the main design features, which are present in Sophie 2.0. |
| 69 | | * Plugins: software units. In the context of our project, "plugin" is the same as module or bundle. In Eclipse, they are actually represented as different projects. Have a look at [wiki:PLATFORM_STRUCTURE platform structure]. There you can see where modules are located and what their structure is. |
| 70 | | Decomposition to plugins of Sophie 2.0 is one of the most important things to do for the project. If you need to create a new module, one of the ways to do this is described in [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE#Creatinganewmodule how to create a new module]. |
| 71 | | * Extensions / Extension points: these are used to reverse the dependencies so that we cannot have cyclic dependencies in the project. The other advantage of extensions is that they provide extensible functionality. |
| 72 | | * Editions: different standalone subsets of the Sophie 2.0 platform. Sophie 2.0 has three editions: Author, Reader |
| 73 | | * Distributions: the distribution is the end product a user will see on his/her hard drive after installing the edition. In order to be fully functional, a distribution has to provide executables and/or some other needed resources. The problem here is the way we provide these things, and the solution is the /distrib directory (look again at [wiki:PLATFORM_STRUCTURE platform structure]). [[BR]] |
| 74 | | * High-level design. This refers to the Model-View-Controller (MVC) design pattern. Its purpose is to define how the model and the view interact with each other. There is an MVC tutorial at [wiki:CORE_MVC_BASE]. There is a problem with the standard MVC pattern: it is too complicated for this particular project. This is why Properties are introduced here. So, each model in Sophie 2.0 is defined by a property. This way the controller is replaced by Logics, and this simplifies the whole pattern. The properties are represented by the ProLib library, and you can read the important Properties tutorial here: [wiki:PRO_LIB_CORE_TUTORIAL]. [wiki:PRO_LIB_CORE_CODE_TEMPLATES This page] defines useful code templates for properties. [[BR]] |
| | 68 | '''Design'''. Here can be found some of Sophie 2.0's main design features. |
| | 69 | * Plugins: software units. In the context of our project, "plugin" is the same as a module or bundle. In Eclipse, these are actually represented as different projects. Have a look at [wiki:PLATFORM_STRUCTURE platform structure]. There you can see where modules are located and what their structure is. |
| | 70 | Decomposition to plugins of Sophie 2.0 is one of the most important things that can be dome for the project. If you need to create a new module, one way to do this is described in [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE#Creatinganewmodule how to create a new module]. |
| | 71 | * Extensions / Extension points: these are used to reverse the dependencies so that we do not have cyclic dependencies in the project. The other advantage of extensions is that they provide extensible functionality. |
| | 72 | * Editions: different standalone subsets of the Sophie 2.0 platform. Sophie 2.0 has three editions: Author, Reader, and Server. The page dedicated to editions provides information about the [wiki:PLUGIN_EDITIONS_STRUCTURE plugin editions structure]. |
| | 73 | * Distributions: the distribution is the end product a user will see on his/her hard drive after installing the edition. In order to be fully functional, a distribution has to provide executables and/or some other needed resources. The problem here is the way in which we provide these items, and the solution is the /distrib directory (look again at [wiki:PLATFORM_STRUCTURE platform structure]). [[BR]] |
| | 74 | * High-level design: this refers to the Model-View-Controller (MVC) design pattern. Its purpose is to define how the model and view interact with each other. There is an MVC tutorial at [wiki:CORE_MVC_BASE]. There is a problem with the standard MVC pattern: it is too complicated for this particular project. This is why Properties are introduced here. Therefore, each model in Sophie 2.0 is defined by a property. This way the controller is replaced by Logics and this simplifies the whole pattern. The properties are represented by the ProLib library, and you can read the important Properties tutorial here: [wiki:PRO_LIB_CORE_TUTORIAL]. [wiki:PRO_LIB_CORE_CODE_TEMPLATES This page] defines useful code templates for properties. [[BR]] |
| 79 | | You will certainly encounter a problem you cannot resolve on your own. You can find help: |
| 80 | | * In the [wiki:FAQ developers' FAQ] section |
| 81 | | * In our mail groups (see the beginning of this document) |
| 82 | | * In our Skype group chat (again, see the beginning of this document) |
| 83 | | * In the Sophie 2.0 forum: [http://sophie2.org/trac/discussion/] [[BR]] |
| | 79 | You will likely encounter a problem you will not be able to resolve on your own. You can always find help in: |
| | 80 | * The [wiki:FAQ developers' FAQ] section |
| | 81 | * Our mail groups (see the beginning of this document) |
| | 82 | * Our Skype group chat (again, see the beginning of this document) |
| | 83 | * The Sophie 2.0 forum: [http://sophie2.org/trac/discussion/] [[BR]] |
