Aplicación gvSIG con fines educativos

===================

gvSIG Educa Batoví

===================

------------------------------------------------------------

gvSIG customization for OLPC laptops of Ceibal project

------------------------------------------------------------

Description

==============

This file is a contents index.

Requirements

==============

* S.O Linux

* Maven 2.6 or higher

* Java JDK 1.5 or higher

For eclipse

-------------

See `developer guide at gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/>`_ and the file ``REAME-ECLIPSE.txt``

Contents

=========

REAME.txt/LEEME.txt

--------------------

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>`_)

docs

---------

Folder with papers related to this project.

org.gvsig.educa.batovi.activity

-----------------------------------

Scripts to generante a *Sugar Activity* contains a gvSIG v2.0 customization.

org.gvsig.educa.batovi.app

-------------------------------

gvSIG Plugins made for Batoví project (UI customization, etc...).

org.gvsig.educa.batovi.mapviewer

-----------------------------------

Little application which allows install and view *Thematic Maps*. Includes *Sugar activity* generator scripts.

Compilation

================

Just for folder which contents code. Other folders has a *README.txt* with all related information.

From shell

------------

Execute this command::

    org.gvsig.educa.thematicmap$ mvn clean install

From eclipse

--------------

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>`_

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. 

Packaging

===============

This could be applyed depending every single project:

* *org.gvsig.edica.batovi.activity* is a packager.

* *org.gvsig.educa.batovi.app* contains plugins and its packing process is the very same that gvSIG plugins.

* *org.gvsig.educa.batovi.mapviewer* contains a folder with the packaging process: *org.gvsig.educa.batovi.mapviewer/org.gvsig.educa.batovi.mapviewer.activity*

Version 

---------------

To changes version number just set in in ``project/version`` tag of *pom.xml* in this folders:

* *org.gvsig.educa.batovi.app*

* *org.gvsig.educa.batovi.mapviewer*

Sub-projects will inherit it.

Version polity is the standard in project. Changes in version number:

* third number: Bug fixes and minors improvements. API must have no changes from previous version.

* second number: Bug fixes and mayor improvements. API can have minor changes. Previously deprecated classes could be removed. No architectural changes.

* first number: Mayor changes.

Create a tag

------------------

TODO: use *maven release* plugin

Use svn copy command to copy version in server. Process could be like this:

#. Check that there ins no changes in workspace::

   svn up ; svn status

#. Check that project compiles and passes all test.

   mvn clean install

#. Update *pom.xml* to set version of tag (usually removing *-SNAPSHOT*)

#. create tag folder on server::

   svn mkdir -m "Create {version} tag folder" https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.thematicmap/tag/{version}

#. Copy current workcopy to tag folder::

   svn copy -m "Create {version} tag" * https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.thematicmap/tag/{version}

#. Update *pom.xml* to next version

#. Commit *pom.xml* changes::

   svn commit -m "Set new version {version}-SNAPSHOT" pom.xml

i18n

======

The files for internationalization can be found in this folders:

+ *org.gvsig.educa.batovi.mapviewer/org.gvsig.educa.batovi.mapviewer/src/main/resources*

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.

Requisitos

==============

* S.O Linux

* Maven 2.6 or higher

* Java JDK 1.5 or higher

Para trabajar con eclipse

--------------------------

Ver `Guía del desarrollador en gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/>`_ y el fichero ``REAME-ECLIPSE.txt``

Compilación

================

Para aquellos proyectos que contengan código. El resto contendrán un fichero *LEEME.txt* con las instrucciónes necesárias.

Desde el shell

----------------

Ejecute este comando::

    {proyecto}$ mvn clean install

Desde eclipse

--------------

Ver `Trabajar con un proyecto de la guía de desarrollador en gvSIG.org <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/gvsig-devel-guide/2.0.0/trabajar-con-un-proyecto>`_

En algunos proyectos puede que sea necesario user el comando ``mvn eclipse:clean eclipse:eclipse`` e importar como *Standar/Import existing project...* en vez de cargar como *Maven Project*. Esto es debido a que, en algunas circunstancias, parece que el plugin de Maven del eclipse no prepara el *classpath* de forma correcta.

Empaquetado

===============

Dependiendo del proyecto es aplicable o no:

* El proyecto de *org.gvsig.edica.batovi.activity* es un empaquetado en si mismo.

* El proyecto de *org.gvsig.educa.batovi.app* contiene plugins y usa el mecanismo estándar de empaquetado de gvSIG.

* El proyecto de *org.gvsig.educa.batovi.mapviewer* contiene su empaquteador en *org.gvsig.educa.batovi.mapviewer/org.gvsig.educa.batovi.mapviewer.activity*

Versionado 

--------------

Para cambiar el número de versión de los plugins solo es necesario ajustar la etiqueta ``project/version`` del fichero *pom.xml* de los proyectos:

* *org.gvsig.educa.batovi.app*

* *org.gvsig.educa.batovi.mapviewer*

Los subproyectos heredarán el valor.

La política de versión es la estándar. Los cambios en los numeros son:

* tercer número: Arreglo de errores y mejoras menores. Sin cambios en el API. 

* segundo número: Arreglo de erroes y mejoras. Pueden haber cambios menores en el API. Los elementos marcados como *deprecated* en versiones anteriores pueden eliminarse. Sin cambios de arquitectura.

* primer número: Cambios mayores.

Crear un tag

------------------

TODO: usar el plugin *release* de maven

Usar el comando *svn copy*. El proceso podría ser:

#. Comprobar que no hay cambios en la copia local::

   svn up ; svn status

#. Comprobar que los proyecto compilan y pasan todas las baterías de test::

   mvn clean install

#. Actualizar el fichero *pom.xml* con la versión de tag (normalmente quitando el sufijo *-SNAPSHOT*)

#. Crear el directorio para el tag en el servidor::

   svn mkdir -m "Create {version} tag folder" https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.thematicmap.app/tag/{version}

#. Subir la copia local al directorio del tag en el servidor::

   svn copy -m "Create {version} tag" * https://devel.gvsig.org/svn/gvsig-educa/org.gvsig.educa.thematicmap.app/tag/{version}

#. Actualizar el *pom.xml* a la siguiente version (y añadirle el sufijo *-SNAPSHOT*)

#. Subir los cambios del *pom.xml*::

   svn commit -m "Set new version {version}-SNAPSHOT" pom.xml

i18n

======

Los ficheros de internacionalización se pueden encontrar en los directorios:

+ *org.gvsig.educa.batovi.mapviewer/org.gvsig.educa.batovi.mapviewer/src/main/resources*

La internacionalización está basada en el mecanismo estándar de los *resource bundle*. Para añadir un nuevo idioma sólo es necesario añadir el fichero de propiedades en todos los directorio con el codigo de idioma adecuado.