| 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 commiting 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]] |
| 18 | | 1) Create the new file in the desired folder (for reports, it is /manage/reports/[current iteration]/. The format of reports is explained below, in the "Process" chapter). [[BR]] |
| | 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 commiting 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]] |
| | 18 | 1) Create the new file in the desired folder (for reports, it is /manage/reports/{current iteration}/. The format of reports is explained below, in the "Process" chapter). [[BR]] |
| 31 | | Download the latest eclipse version from [http://www.eclipse.org/downloads/] and install it to your computer. Then, modify your compiler esttings according to the [wiki: COMPILER_SETTINGS] document. The next two steps, subclipse installation and maven integation, 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 Sophie2 in Eclipse and run the FakeAuthor configuration. [[BR]] |
| | 31 | Download the latest eclipse version from [http://www.eclipse.org/downloads/] and install it to your computer. Then, modify your compiler esttings according to the [wiki:COMPILER_SETTINGS] document. The next two steps, subclipse installation and maven integation, 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 Sophie2 in Eclipse and run the FakeAuthor configuration. [[BR]] |
| 53 | | 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://asteasolutions.net:7080/sophie2/roadmap]. The exact task states and much more are described and regularly updated at [wiki: PROCESS]. This document is fundamental, so read it carefully. [[BR]] |
| | 53 | 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://asteasolutions.net:7080/sophie2/roadmap]. The exact task states and much more are described and regularly updated at [wiki:PROCESS]. This document is fundamental, so read it carefully. [[BR]] |
| 55 | | * Analyzing: [wiki: PLATFORM_STANDARDS_ANALYSIS how to write good analysis]. |
| 56 | | * Coding: [wiki: CODE_TASKS_REQUIREMENTS code tasks requirements], [wiki: CODE_SMELLS code smells](bad code examples), |
| 57 | | [wiki: LOGGING logging]. [wiki: JAVADOC_CONVENTIONS Javadoc] should also be here. |
| 58 | | * Testing: [wiki: TESTING auto tests](unit / system), [wiki: PLATFORM_STANDARDS_MANUAL_TESTS_R0 manual tests]. [[BR]] |
| 59 | | The process is executed with the help of Trac - the issue tracking system we use. If you have problems with using it, go to [wiki: TracGuide]. |
| | 55 | * Analyzing: [wiki:PLATFORM_STANDARDS_ANALYSIS how to write good analysis]. |
| | 56 | * Coding: [wiki:CODE_TASKS_REQUIREMENTS code tasks requirements], [wiki:CODE_SMELLS code smells](bad code examples), [wiki:LOGGING logging]. [wiki:JAVADOC_CONVENTIONS Javadoc] should also be here. |
| | 57 | * Testing: [wiki:TESTING auto tests](unit / system), [wiki:PLATFORM_STANDARDS_MANUAL_TESTS_R0 manual tests]. [[BR]] |
| | 58 | The process is executed with the help of Trac - the issue tracking system we use. If you have problems with using it, go to [wiki:TracGuide]. |
| 63 | | * 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.[[BR]] |
| 64 | | Decomposition to plugins of Sophie 2 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 the way, described in [wiki: PLATFORM_DEPLOYMENT_BUILD_ECLIPSE#Howtocreateanewmodule how to create a new module]. |
| | 62 | * 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.[[BR]] |
| | 63 | Decomposition to plugins of Sophie 2 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 the way, described in [wiki:PLATFORM_DEPLOYMENT_BUILD_ECLIPSE#Howtocreateanewmodule how to create a new module]. |
| 66 | | * Editions: different standalone subsets of Sophie2 platform. Sophie2 has 3 editions: Author, Reader and Server. The page dedicated to editions is [wiki: PLUGIN_EDITIONS_STRUCTURE Plugin editions structure]. |
| 67 | | * Distributions: the distribution is the end product an 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]] |
| 68 | | * High-level design. This refers to the Model-View-Controller (MVC) design pattern. Its idea is to define how the model and the view interact each other. There is a MVC tutorial at [wiki: CORE_MVC_BASE]. There is a problem with the standard MVC pattern, and it is that it becomes too complicated in this particular project. This is why Properties are introduced here. So, each model in Sophie2 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]] |
| | 65 | * Editions: different standalone subsets of Sophie2 platform. Sophie2 has 3 editions: Author, Reader and Server. The page dedicated to editions is [wiki:PLUGIN_EDITIONS_STRUCTURE Plugin editions structure]. |
| | 66 | * Distributions: the distribution is the end product an 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]] |
| | 67 | * High-level design. This refers to the Model-View-Controller (MVC) design pattern. Its idea is to define how the model and the view interact each other. There is a MVC tutorial at [wiki:CORE_MVC_BASE]. There is a problem with the standard MVC pattern, and it is that it becomes too complicated in this particular project. This is why Properties are introduced here. So, each model in Sophie2 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]] |
