Index: /branches/PublicaMundi_David-devel/docs/contribute/index.rst =================================================================== --- /branches/PublicaMundi_David-devel/docs/contribute/index.rst (revision 721) +++ /branches/PublicaMundi_David-devel/docs/contribute/index.rst (revision 722) @@ -17,3 +17,4 @@ dev release + translate contributors Index: /branches/PublicaMundi_David-devel/docs/contribute/translate.rst =================================================================== --- /branches/PublicaMundi_David-devel/docs/contribute/translate.rst (revision 722) +++ /branches/PublicaMundi_David-devel/docs/contribute/translate.rst (revision 722) @@ -0,0 +1,82 @@ +.. _contribute_trans: + +Contribute translation +====================== + +Introduction +------------ + +This chapter aims to explain how to help translating the internal +ZOO-Kernel messages into another language than English. Some +languages are already enabled for translating and some are not. Please +see :ref:`documentation_translation_newlang` if needed. + +This chapter describes how to add a new language, how to join a language group, +and how to translate the internal ZOO-Kernel messages. + + +What is Transifex for? +---------------------------------------- + +`Transifex `_ is a croudsourcing +translation web application. It allows projects to let people easily +translate documentation, websites, and applications. + +It offers a graphic interface for those of you who don't like command +line but also some features for those who love them. + +Transifex helps the translator to improve their translation with +suggestions, glossary and proofreading process. + +Starting with Transifex +----------------------- + +Subscribe to Transifex +...................... + +You need to subscribe to Transifex before translating. Go to +`Transifex subscribing page +`_ and create a new +account. + +Access the project +.................. + +The project can be found here: `ZOO-Project Dashboard `_ + +Each project has a news page to send some information to you, so please, take +some time to read them. You can also send some messages to others to discuss on +a topic. + +Ask to join the Translator group +................................ + +Click on the link to access the dashboard of the ZOO-Project project +in Transifex (link above), find the button *Join team*. You should +now wait for the manager accept you in the group (given them time to +read your request and act in consequence). + +.. _documentation_translation_newlang: + +Request a new language +---------------------- + +Go to the ZOO-Project dashboard on Transifex (see link above) and +click on 'Request language'. + +Creating a new language by the manager should not be too long, actually as long +as to accept you in the team. + + +Translate messages +------------------ + +Once you are a member of the Translator team, go on the ZOO-Project +Dashboard you can translate and click on the language you want to +translate, then press the button 'Translate' and you can start +translating strings by using the online editor. Please refer to this `documentation +`_ if you need details +on how to use this editor. + + + Index: /branches/PublicaMundi_David-devel/docs/install/installation.rst =================================================================== --- /branches/PublicaMundi_David-devel/docs/install/installation.rst (revision 721) +++ /branches/PublicaMundi_David-devel/docs/install/installation.rst (revision 722) @@ -110,4 +110,26 @@ linked files. +.. _zoo_create_db_backend: + +To create a new database to be used by the ZOO-Kernel, you have +to load the `schema.sql +`_ +file. For instance, you may run the following: + +.. code:: + + createdb zoo_project + psql zoo_project -f zoo-project/zoo-kernel/sql/schema.sql + +.. note:: + You can choose another schema to store ZOO-Kernel specific + informations. In such a case, you would need to edit the + schema.sql file to uncomment line `33 + `_ + and `34 + `_. + + + YAML Support (Optional) ************************ @@ -373,12 +395,15 @@ ****************************** -The ZOO-Kernel is able to translate the messages it produce in different -natural languages. For this translation support to work, you have to -generate and install manually the quested files on your system, by -using the following command: - -.. code:: - - msgfmt zoo-project/zoo-kernel/locale/po/fr_FR.utf8.po -o /usr/share/locale/fr/LC_MESSAGES/zoo-kernel.mo +The ZOO-Kernel is able to translate the messages it produces in different +natural languages. This requires that you download `the messages file +`_ +translated in your language, if any. Then, for this translation +support to work, you have to generate manually the requested file on +your system. For instance for the French translation, you may use the +following command: + +.. code:: + + msgfmt messagespo_fr_FR.utf8.po -o /usr/share/locale/fr/LC_MESSAGES/zoo-kernel.mo The ZOO-Kernel is also able to handle translation of Index: /branches/PublicaMundi_David-devel/docs/install/windows.rst =================================================================== --- /branches/PublicaMundi_David-devel/docs/install/windows.rst (revision 721) +++ /branches/PublicaMundi_David-devel/docs/install/windows.rst (revision 722) @@ -8,37 +8,23 @@ ==================== -Using OSGeo4W --------------- - -Install OSGeo4W -.......................................... - -First download the OSGeo4W installer from http://trac.osgeo.org/osgeo4w/, and install it with all the dependencies needed by your -WPS services such as GDAL for example. +Compile ZOO-Project from source +------------------------------- .. warning:: - FastCGI, libxml, Python and cURL are mandatory - -Install ZOO4W -.......................................... - -Once OSGeo4W installed on your platform, you will need more GNU tools and libraries. `This package `__ contains full dependencies required to compile on a WIN32 platform and this one contains `full runtime dependencies `__ . Place it to your ``C:\OSGeo4W\bin``. - -Download the `binary version `__ of ZOO Kernel for WIN32, then place it in the ``C:\OSGeo4W\bin`` directory. Don't forget to place the *main.cfg* file in the same directory, you can use a modified copy of `this file `__. - -Additionaly, the binary version of the OGR Services Provider available from `here `__ can be used directly. Place the two libraries with their respective .zcfg files in your local ``C:\OSGeo4W\bin`` directory to do so. - -Compile ZOO from source ---------------------- - -.. warning:: - Ensure to first perform the :ref:`prerequisite steps ` before compiling the ZOO Kernel. - -The following steps are for use with the Microsoft Visual Studio compiler (and tested with MSVC 2008). - -1. Make sure the gnuwin32 tools *bison.exe* and *flex.exe* are found in your path. You can download the GNUwin32 tools `here `__. - -2. Modify the *nmake.opt* file to point to your local libraries. You can find a modified nmake.opt that points to local libs `here `__. - You can also find a modified ``zoo-project\zoo-kernel\makefile.vc`` file `here `__. + Ensure to first perform the :ref:`prerequisite steps + ` before compiling the ZOO Kernel. + +The following steps are for use with the Microsoft Visual Studio +compiler (and tested with MSVC 2010). + +1. Make sure the gnuwin32 tools ``bison.exe`` and ``flex.exe`` are found + in your path. You can download the GNUwin32 tools `here + `__. + +2. Modify the ``nmake.opt`` file to point to your local libraries. Note + that you can also use definition directly in the command line if + you prefer. See :ref:`win_configure_options` for details about this + options. + 3. Execute: @@ -48,14 +34,18 @@ nmake /f makefile.vc -4. A file *zoo_loader.cgi* should be created. Note that if another file named *zoo_loader.cgi.manifest* is also created, you - will have to run another command: - +4. A file ``zoo_loader.cgi`` and ``libzoo_service.dll`` should be + created. Note that if another file named + ``zoo_loader.cgi.manifest`` is also created, you will have to run + another command: + :: nmake /f makefile.vc embed-manifest -5. Copy the files *zoo_loader.cgi* and *main.cfg* into your cgi-bin directory. - -6. Using the command prompt, test the zoo-kernel by executing the following command: +5. Copy the files ``zoo_loader.cgi``, ``libzoo_service.dll`` and + ``main.cfg`` into your cgi-bin directory. + +6. Using the command prompt, test the ZOO-Kernel by executing the + following command: :: @@ -77,6 +67,6 @@ -7. Edit the *main.cfg* file so that it contains values describing your WPS service. An example of such - a file running on Windows is: +7. Edit the ``main.cfg`` file so that it contains values describing + your WPS service. An example of such a file running on Windows is: :: @@ -133,4 +123,206 @@ ... + +.. _win_configure_options: + +Build options +............. + +Various build options can be set in the ``nmake.opt`` file to define +the location of the built libraries you want to use to build your +ZOO-Kernel. Some are optional and some are required, they are listed +below exhaustively: + +.. contents:: + :local: + :depth: 1 + :backlinks: top + + +gettext (Required) +****************** + +The location of the libintl (built when building gettext) should be +specified by defining the ``INTL_DIR`` environment variable. It +supposes that the header and the ``intl.lib`` file are available. + +So for instance, in case you build the gettext in +``\buildkit\srcs\gettext-0.14.6``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set INTL_DIR=\buildkit\srcs\gettext-0.14.6\gettext-runtime\intl + + +libCURL (Required) +****************** + +The location of the libCURL should be specified by defining +the ``CURL_DIR`` environment variable. It supposes that there are 2 +sub-directory ``include`` containing the libCURL header and ``lib`` +which contains the ``libcurl.lib`` file. + +So for instance, in case you build the libCURL in +``\buildkit\srcs\curl-7.38.0``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set CURL_DIR=\buildkit\srcs\curl-7.38.0\builds\libcurl-vc10-x86-release-dll-ssl-dll-zlib-dll-ipvs6-sspi + + +libFCGI (Required) +****************** + +The location of the libFCGI should be specified by defining the +``FCGI_DIR`` environment variable. It supposes that there are 2 +sub-directory ``include`` containing the FastCGI header and +``libfcgi/Release`` which contains the ``libfcgi.lib`` file. + +So for instance, in case you build the libXML2 library in +``\buildkit\srcs\fcgi-2.4.1``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set FCGI_DIR=\buildkit\srcs\fcgi-2.41.1 + +libXML2 (Required) +****************** + +The location of the libXML2 should be specified by defining the +``XML2_DIR`` environment variable. It supposes that there are 2 +sub-directory ``include`` containing the libXML2 header and +``win32\bin.msvc`` which contains the ``libxml2.lib`` file. + +So for instance, in case you build the libXML2 library in +``\buildkit\srcs\libxml2-2.9.0``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set XML2_DIR=\buildkit\srcs\libxml2-2.9.0 + +OpenSSL (Required) +****************** + +The location of the OpenSSL library should be specified by defining +the ``SSL_DIR`` environment variable. It supposes that there are 2 +sub-directory ``inc32`` containing the header files and +``out32dll`` which contains the ``ssleay32.lib`` file. + +So for instance, in case you build the libXML2 library in +``\buildkit\srcs\openssl-1.0.2c``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set SSL_DIR=\buildkit\srcs\openssl-1.0.2c + +GDAL (Required) +****************** + +The location of the GDAL library should be specified by defining +the ``GDAL_DIR`` environment variable. It corresponds to the path +where you uncompress and built GDAL, it supposes that you have the +``gdal_i.lib`` file available in this directory. + +So for instance, in case you build the libXML2 library in +``\buildkit\srcs\gdal-1.10.1``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set GDAL_DIR=\buildkit\srcs\gdal-1.10.1 + +MapServer (Optional) +******************** + +The location of the MapServer library path should be specified by +defining the ``MS_DIR`` environment variable. It corresponds to the +path where you build MapServer on your system, this directory should +contain the ``nmake.opt`` file used. + +So for instance, in case you build Python in +``\buildkit\srcs\mapserver-6.2.0``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set MS_DIR=\buildkit\srcs\mapserver-6.2.0 + + +Python (Optional) +***************** + +The location of the Python binaries path should be specified by +defining the ``PY_DIR`` environment variable. It corresponds to the +path where you build Python on your system. The location of the +``pythonXX.lib`` files should be specified by setting the +``PY_LIBRARY`` environment variable. + +So for instance, in case you build Python in +``\buildkit\srcs\Python-2.7``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set PY_DIR=\buildkit\srcs\Python-2.7 + set PY_LIBRARY=\buildkit\srcs\Python-2.7\PCBuild\python27.lib + +JavaScript (Optional) +********************* + +The location of libmozjs should be specified by defining the +``JS_DIR`` environment variable. It corresponds to the path where you +build libmozjs on your system, it supposes that the header and +the ``mozjs185-1.0.lib`` file are available in this directory. + +So for instance, in case you build libmozjs in +``\buildkit\srcs\js-1.8.5``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set JS_DIR=\buildkit\srcs\js-1.8.5 + +PHP (Optional) +***************** + +The location of PHP should be specified by defining the ``PHP_DIR`` +environment variable. It corresponds to the path where you build PHP +on your system. The location of the ``php5embed.lib`` files should be +specified by setting the ``PHP_LIB`` environment variable. + +So for instance, in case you build PHP in +``\buildkit\srcs\php-5.5.10``, you may define the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set PHP_DIR=\buildkit\srcs\php-5.5.10 + set PHP_LIB=\buildkit\srcs\php-5.5.10\Release_TS\php5embed.lib + +Database backend (Optional) +*************************** + +ZOO-Kernel can use a database backend to store ongoing status +informations of running services, for activating this operation mode, +you should define the evironment variable ``DB`` and set it to any +value. So, to activate this option, you may use the following before +running ``nmake /f makefile.vc``: + +.. code:: + + set DB=activated + +.. note:: + To learn how to setup the corresponding database, please refer to + :ref:`this section `. + + + + Optionally Compile Individual Services ............................................................. Index: /branches/PublicaMundi_David-devel/docs/kernel/configuration.rst =================================================================== --- /branches/PublicaMundi_David-devel/docs/kernel/configuration.rst (revision 721) +++ /branches/PublicaMundi_David-devel/docs/kernel/configuration.rst (revision 722) @@ -208,25 +208,6 @@ PG:"dbname=zoo_project host=127.0.0.1 port=5432 user=username" -.. _zoo_create_db_backend: - -To create a new database to be used by the ZOO-Kernel, you have -to load the `schema.sql -`_ -file. For instance, you may run the following: - -.. code:: - - createdb zoo_project - psql zoo_project -f zoo-project/zoo-kernel/sql/schema.sql - -.. note:: - You can choose another schema to store ZOO-Kernel specific - informations. In such a case, you would need to edit the - schema.sql file to uncomment line `33 - `_ - and `34 - `_. - - +Please refer to this `section `_ to learn how +to setup the database. Index: /branches/PublicaMundi_David-devel/docs/kernel/what.rst =================================================================== --- /branches/PublicaMundi_David-devel/docs/kernel/what.rst (revision 721) +++ /branches/PublicaMundi_David-devel/docs/kernel/what.rst (revision 722) @@ -17,5 +17,4 @@ new or existing web platforms. - ZOO-Kernel lets you process geospatial or non geospatial data using well formed WPS requests. The WPS server is able to manage and chain @@ -25,4 +24,25 @@ First class WPS server ----------------------- + +Simple +...... + +The ZOO-Kernel rely on simple principles and tends to ease the +implementation of new services by sharing similar data structures for +every supported programming languages. The ZOO-Kernel is responsible +to parse the requests it receives and return the corresponding WPS +response. + +In case of an *Execute* request, the ZOO-Kernel stores informations in +a basic KVP data structure for the programming language used to +implement the service, dynamically load the Service Provider defined +in the zcfg file and run a specific function corresponding to the +service, passing three arguments. Once the function return, ZOO-Kernel +knows if the service run succeessfuly or failed by checking the +returned value. In the case it succeeded, the ZOO-Kernel then parse +the third arguments containing the result and produce the output in +the desired format. + + Compliant @@ -82,12 +102,2 @@ .. _`Hash`: http://ruby-doc.org/core-2.2.0/Hash.html - -Scalable -........................................................ - -ZOO-Kernel can **scale** to large infrastructures involving high -numbers of (concurrent) WPS requests and/or huge amounts of -input/output. - - - Index: /branches/PublicaMundi_David-devel/docs/services/translation.rst =================================================================== --- /branches/PublicaMundi_David-devel/docs/services/translation.rst (revision 721) +++ /branches/PublicaMundi_David-devel/docs/services/translation.rst (revision 722) @@ -31,5 +31,5 @@ -Then generate the 'messages.po' file based on the Services Provider +Then generate the ``messages.po`` file based on the Services Provider source code (located in ``service.c`` in this example) using the following command: @@ -40,7 +40,7 @@ xgettext service.c locale/.cache/my_service_string_to_translate.c -o message.po -p locale/po/ -k_ss -Once 'messages.po' is created, use the following command to create the -``.po`` file for the targeted language to translate into. We will use the -French language here as an example: +Once ``messages.po`` is created, use the following command to create +the ``.po`` file for the targeted language to translate into. We will +use the French language here as an example: ::