source: branches/PublicaMundi_David-devel/docs/client/howto.rst @ 666

Last change on this file since 666 was 659, checked in by nbozon, 9 years ago

Massive update of zoo docs

File size: 2.7 KB

Using ZOO-Client

This section will help you to get started using :ref:`ZOO-Client <client-what>`.

?

Prerequisites

ZOO-Client is based on the following Javascript libraries

Warning

Node.js is also required on your system for compiling ZOO-Client templates.

Download

If you did not :ref:`download <install-download>` the ZOO-Project source code already, please proceed to a svn checkout with the following command:

?
svn checkout http://svn.zoo-project.org/svn/trunk/zoo-project/zoo-client

Warning

You do not necessarily need to :ref:`install <install-installation>` the ZOO-Project server for using ZOO-Client. The corresponding svn directory is needed only.

?

Compiling ZOO-Client templates

?
Compiling ZOO-Client templates
---------------------------

In order to work with ZOO-Client, you will first need to compile the provided Mustache templates using Node.js. The ZOO-Client templates are located in the /zoo-project/zoo-client/lib/tpl directory downloaded from svn.

  • Install Node.js (see related documentation.)

  • Install Hogan, the JavaScript templating engine, using the following command:

    sudo npm install hogan
    
  • Use Hulk (Hogan's command line utility) for compiling the tempaltes using the following command:

    hulk zoo-client/lib/tpl/*mustache > \ zoo-client/lib/js/wps-client/payloads.js
    

Warning

Using different versions of Hogan to compile and to use in a web application may lead to compatibility issue.

Everything is now ready to work with :ref:`ZOO-Client <client-what>`. Read the :ref:`next section <client-example>` for an example JavaScript application.

??

Building ZOO-Client documentation

?
Building ZOO-Client documentation
--------------------------

You may also build the ZOO-Client API documentation using jsDoc, with the following command:

npm install jsdoc
~/node_modules/.bin/jsdoc zoo-client/lib/js/wps-client/* -p

This will build HTML documentation in a new directory named /out in your working directory.

Note: See TracBrowser for help on using the repository browser.

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png