gvsig-educa / org.gvsig.educa.portableview / tags / org.gvsig.educa.portableview-1.0.7 / README.txt @ 831
History | View | Annotate | Download (4.19 KB)
1 | 256 | llmarques | =============== |
---|---|---|---|
2 | gvSIG Educa |
||
3 | =============== |
||
4 | |||
5 | --------------------- |
||
6 | Portable View |
||
7 | --------------------- |
||
8 | |||
9 | Description |
||
10 | ============== |
||
11 | |||
12 | This folder contains the sources of the Portable View functionality. |
||
13 | |||
14 | Requirements |
||
15 | ============== |
||
16 | |||
17 | * Maven 2.6 or higher |
||
18 | |||
19 | * Java JDK 1.5 or higher |
||
20 | |||
21 | For eclipse |
||
22 | ------------- |
||
23 | |||
24 | See `developer guide at gvSIG.org <http://www.gvsig.org/plone/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2-1-0/introduccion>`_ and the file ``REAME-ECLIPSE.txt`` |
||
25 | |||
26 | |||
27 | Contents |
||
28 | ========== |
||
29 | |||
30 | org.gvsig.educa.portableview.lib |
||
31 | --------------------------------- |
||
32 | |||
33 | Functionality sources. This project just contain the main process and the logic without any dependency with User Interface. |
||
34 | |||
35 | org.gvsig.educa.portableview.swing |
||
36 | ------------------------------------- |
||
37 | |||
38 | User Interface components to access a manage the application services. |
||
39 | |||
40 | org.gvsig.educa.portableview.main |
||
41 | ----------------------------------- |
||
42 | |||
43 | Little test application which allow run the main functionality of application. |
||
44 | |||
45 | See `Execute little test application`_ to know how run it. |
||
46 | |||
47 | pom.xml |
||
48 | --------- |
||
49 | |||
50 | Maven project definition file |
||
51 | |||
52 | README.rst |
||
53 | -------------- |
||
54 | |||
55 | This file (in reStructureText format, for more info this format look at `gvSIG portal <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/guia-para-documentar/el-formato-restructuredtext>`_ or at `docUtils reference <http://docutils.sourceforge.net/rst.html>`_) |
||
56 | |||
57 | |||
58 | Compilation |
||
59 | ================ |
||
60 | |||
61 | From shell |
||
62 | ------------ |
||
63 | |||
64 | Execute this command:: |
||
65 | |||
66 | org.gvsig.educa.portableview$ mvn clean install |
||
67 | |||
68 | |||
69 | From eclipse |
||
70 | -------------- |
||
71 | |||
72 | See `work in a proyect of the developer guide at gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/trabajar-con-un-proyecto>`_ |
||
73 | |||
74 | In some project, could be better use ``mvn eclipse:clean eclipse:eclipse`` than import project as a *Maven project*. Maven plugin of eclipse does not set classpath correctly in some project. |
||
75 | |||
76 | |||
77 | Packing |
||
78 | ======== |
||
79 | |||
80 | This functionality has no stand-alone packing process. |
||
81 | |||
82 | Version |
||
83 | --------------- |
||
84 | |||
85 | To changes version number just set in in ``project/version`` tag of *pom.xml* in this folder. Sub-projects will inherit it. |
||
86 | |||
87 | Version polity is the standard in project. Changes in version number: |
||
88 | |||
89 | * third number: Bug fixes and minors improvements. API must have no changes from previous version. |
||
90 | * second number: Bug fixes and mayor improvements. API can have minor changes. Previously deprecated classes could be removed. No architectural changes. |
||
91 | * first number: Mayor changes. |
||
92 | |||
93 | Create a tag |
||
94 | ------------------ |
||
95 | |||
96 | TODO: use *maven release* plugin |
||
97 | |||
98 | Use svn copy command to copy version in server. Process could be like this: |
||
99 | |||
100 | |||
101 | #. Check that there ins no changes in workspace:: |
||
102 | |||
103 | svn up ; svn status |
||
104 | |||
105 | #. Check that project compiles and passes all test. |
||
106 | |||
107 | mvn clean install |
||
108 | |||
109 | #. Update *pom.xml* to set version of tag (usually removing *-SNAPSHOT*) |
||
110 | #. create tag folder on server:: |
||
111 | |||
112 | 265 | llmarques | svn mkdir -m "Create {version} tag folder" https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.portablewview/tags/{version} |
113 | 256 | llmarques | |
114 | #. Copy current workcopy to tag folder:: |
||
115 | |||
116 | 265 | llmarques | svn copy -m "Create {version} tag" * https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.portablewview/tags/{version} |
117 | 256 | llmarques | |
118 | #. Update *pom.xml* to next version |
||
119 | #. Commit *pom.xml* changes:: |
||
120 | |||
121 | svn commit -m "Set new version {version}-SNAPSHOT" pom.xml |
||
122 | |||
123 | |||
124 | i18n |
||
125 | ====== |
||
126 | |||
127 | The files for internationalization can be found in this folders: |
||
128 | |||
129 | 265 | llmarques | + *org.gvsig.educa.portablewview.app.viewer/src/main/resources-plugin* |
130 | + *org.gvsig.educa.portablewview.app.editor/src/main/resources-plugin* |
||
131 | 256 | llmarques | |
132 | The internationalization of this application is based on standard java resource bundle mechanism. So, to add a new language just add the file with the language code to every related folder. |
||
133 | |||
134 | Execute little test application |
||
135 | ================================= |
||
136 | |||
137 | From shell |
||
138 | ------------ |
||
139 | |||
140 | After compile the application, execute this command:: |
||
141 | |||
142 | 265 | llmarques | org.gvsig.educa.portablewview$ cd org.gvsig.educa.thematicmap.main |
143 | org.gvsig.educa.portablewview/org.gvsig.educa.portablewview.main$ mvn exec:java |
||
144 | 256 | llmarques | |
145 | Form eclipse |
||
146 | ------------------ |
||
147 | |||
148 | Select ``org.gvsig.educa.portableview.main`` project in *Project tree* using *Java perspective*, click with right mouse button and select ``Run as.../Java application``. Select ``Main`` class for project. |