Aplicación gvSIG con fines educativos » Mapas temáticos

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

gvSIG Educa

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

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

Personalización de gvSIG con fines educativos

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

Descripción

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

Este fichero es un índice del contenido del repositorio

Contenido

=========

REAME.txt/LEEME.txt

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

Este fichero. Está en formato reStructureText. Para mas información ver el `portal de gvSIG <https://gvsig.org/web/projects/gvsig-desktop/docs/devel/guia-para-documentar/el-formato-restructuredtext>`_  o en la `referencia de docUtils  <http://docutils.sourceforge.net/rst.html>`_)

org.gvsig.educa.thematicmap

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

Directorio principal de la funcionalidad de los Mapas temáticos.

org.gvsig.educa.thematicmap.app

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

Plugins de gvSIG que permiten usar la funcionalidad de Mapas temáticos.

org.gvsig.batovi

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

Scripts y Plugins para el proyecto *gvSIG Batovi* que tiene como fin instalar gvSIG en los equipos OLPC del `plan Ceibal <http://www.ceibal.edu.uy>`_

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

gvSIG Educa

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

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

Customization of gvSIG for education purpose

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

Description

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

This file is an index of the repository

Contents

=========

REAME.rst

-----------

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

org.gvsig.educa.thematicmap

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

Main folder of Thematic Map functionality.

org.gvsig.educa.thematicmap.app

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

gvSIG add-on which uses the Thematic Map functionality.

org.gvsig.batovi

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

Scripts and plugins for *gvSIG Batovi* project which target is to install gvSIG in a OLPC of `plan Ceibal <http://www.ceibal.edu.uy>`_

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

gvSIG Educa

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

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

Thematic Map add-ons

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

Description

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

This folder contains the sources of the add-on which uses Thematic Map functionality.

Requirements

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

* Maven 2.6 or higher

* Java JDK 1.5 or higher

* gvSIG 2.0 (Build number 2043 or higher) installed

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

==========

org.gvsig.educa.thematicmap.app.viewer

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

Add-on which allows gvSIG to intall and view Thematic Map. 

org.gvsig.educa.thematicmap.app.editor

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

Add-on which allows gvSIG to create, update, package Thematic Map. Requires `org.gvsig.educa.thematicmap.app.viewer`_

pom.xml

---------

Maven project definition file

prepare-workspace.xml and README-ECLIPSE.txt

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

Instructions and utilities to work with eclipse

README.rst

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

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

testing

-----------

Contains the test plans definition and all resources to perform functionally test of all add-ons.

Compilation

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

Prepare maven ``gvsig-install`` profile

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

Add-on projets are configured to deploy itself into a gvSIG installation. This must configured using *maven profiles* by setting the gvSIG installation y the ``~/.m2/settings.xml`` file this way::

    <?xml version="1.0" encoding="UTF-8" standalone="no"?>

    <settings>

      ....

      ....

      <profiles>

        ....

        ....

        <profile>

           <id>gvsig-install</id>

           <activation>

             <activeByDefault>true</activeByDefault>

           </activation>

           <properties>

             <gvsig.install.dir>/home/user/gvSIG_2.0</gvsig.install.dir>

           </properties>

        </profile>

        ....

        ....

      </profiles>

      ....

      ....

    <settings>

From shell

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

Execute this command::

    org.gvsig.educa.thematicmap.app$ 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>`_

Packing

========

This plug-in use the standard gvSIG packing process.

Generate gvSIG add-on installer files from shell

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

To generate the ``.gvspkg`` and ``.gvspki`` files just add the ``create-installer`` profile to compilation command::

     org.gvsig.educa.thematicmap.app.*$ mvn -P create-installer clean install 

Files will be generated in ``${gvsig.install.dir}/build/product/install/pool/`` folder. You can see effective path in maven output::

    ...

    ...

    [INFO] Generating a PackageIndex for the plugin: org.gvsig.educa.thematicmap.app.editor with the following information:

    [INFO] 	gvSIG Plugin's folder: /home/[...]/v2_0_0_prep/build/product/gvSIG/extensiones

    [INFO] 	Package 

Generate gvSIG add-on installer files from eclipse

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

To generate the ``.gvspkg`` and ``.gvspki`` files just use the parepared external tools configuration ``maven create installed``.

Files will be generated in ``${gvsig.install.dir}/build/product/install/pool/`` folder. You can see effective path in maven output::

    ...

    ...

    [INFO] Generating a PackageIndex for the plugin: org.gvsig.educa.thematicmap.app.editor with the following information:

    [INFO] 	gvSIG Plugin's folder: /home/[...]/v2_0_0_prep/build/product/gvSIG/extensiones

    [INFO] 	Package 

Version 

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

To changes version number just set in in ``project/version`` tag of *pom.xml* in this folder. 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 status

#. 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.app/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.app/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.thematicmap.swing/org.gvsig.educa.thematicmap.swing.impl/src/main/resources/org/gvsig/educa/thematicmap/swing/impl/i18n*

+ *org.gvsig.educa.thematicmap.lib/org.gvsig.educa.thematicmap.lib.impl/src/main/resources/org/gvsig/educa/thematicmap/impl/i18n*

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.

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

gvSIG Educa

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

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

Thematic Map add-ons

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

Description

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

This folder contains the test plan sources of the functionality.

Requirements

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

* Maven 2.6 or higher

* Java JDK 1.5 or higher

* gvSIG 2.0 (Build number 2043 or higher) installed

* FreeMind

Contents

==========

geodata

---------

This folder contains de geographic data used to test application. This is part of free-to-use data provided by gvSIG project for test propourses. 

Source data could be found in http://downloads.gvsig.org/download/geodata/

org.gvsig.educa.thematicmap.mm

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

FreeMind file which contains the instructions to test the functionality.

resources

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

Folder with resources used in test plan.

prepare-to-upload.sh

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

Scripts to prepare source files to send to gvSIG project for a release.

Creates a *target* folder which containst the required structure and folders to send.

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

gvSIG Educa

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

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

Thematic Map

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

Description

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

This folder contains the sources of the Thematic Map functionality.

Requirements

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

* 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

==========

org.gvsig.educa.thematicmap.lib

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

Functionality sources. This project just contain the main process and the logic without any dependency with User Interface.

org.gvsig.educa.thematicmap.swing

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

User Interface components to access a manage the application services.

org.gvsig.educa.thematicmap.main

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

Little test application which allow run the main functionality of application.

See `Execute little test application`_ to know how run it.

pom.xml

---------

Maven project definition file

prepare-workspace.xml and README-ECLIPSE.txt

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

Instructions and utilities to work with eclipse

README.rst

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

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

Compilation

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

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. 

Packing

========

This functionality has no stand-alone packing process.

Version 

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

To changes version number just set in in ``project/version`` tag of *pom.xml* in this folder. 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 status

#. 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.thematicmap.app.viewer/src/main/resources*

+ *org.gvsig.educa.thematicmap.app.editor/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.

Execute little test application

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

From shell

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

After compile the application, execute this command::

    org.gvsig.educa.thematicmap$ cd org.gvsig.educa.thematicmap.main

    org.gvsig.educa.thematicmap/org.gvsig.educa.thematicmap.main$ mvn exec:java

Form eclipse

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

Select ``org.gvsig.educa.thematicmap.main`` project in *Project tree* using *Java perspective*, click with right mouse button and select ``Run as.../Java application``. Select ``Main`` class for project.