source: branches/PublicaMundi_David-devel/docs/_build/html/client/howto.html @ 659

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

Massive update of zoo docs
File size: 13.5 KB
Line 
1
2
3<!DOCTYPE html>
4<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
5<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
6<head>
7  <meta charset="utf-8">
8  <meta name="viewport" content="width=device-width, initial-scale=1.0">
9 
10  <title>Using ZOO-Client &mdash; ZOO-Project 1.4a0 documentation</title>
11 
12  <link href="http://fonts.googleapis.com/css?family=Days+One" rel="stylesheet" type="text/css">
13 
14 
15
16 
17
18 
19 
20   
21      <link rel="search" type="application/opensearchdescription+xml" title="Search within ZOO-Project 1.4a0 documentation" href="../_static/opensearch.xml"/>
22   
23
24 
25
26 
27 
28    <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
29 
30
31 
32
33 
34    <link rel="top" title="ZOO-Project 1.4a0 documentation" href="../index.html"/>
35        <link rel="up" title="ZOO-Client" href="index.html"/>
36        <link rel="next" title="Example application" href="example.html"/>
37        <link rel="prev" title="What is ZOO-Client ?" href="what.html"/> 
38
39 
40  <script src="_static/js/modernizr.min.js"></script>
41
42</head>
43
44<body class="wy-body-for-nav" role="document">
45
46  <div class="wy-grid-for-nav">
47
48   
49    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
50      <div class="wy-side-nav-search">
51       
52
53       
54          <a class="shrink" href="http://zoo-project.org"><img src="http://zoo-project.org/img/zoo-sun-logo.png" class="img-responsive sun" style="display: inline;"> ZOO</a>
55       
56
57       
58        </a>
59
60       
61<div role="search">
62  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
63    <input type="text" name="q" placeholder="Search docs" />
64    <input type="hidden" name="check_keywords" value="yes" />
65    <input type="hidden" name="area" value="default" />
66  </form>
67</div>
68
69       
70      </div>
71
72      <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
73       
74         
75         
76              <ul class="current">
77<li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a><ul>
78<li class="toctree-l2"><a class="reference internal" href="../intro.html#what-is-zoo-project">What is ZOO-Project ?</a></li>
79<li class="toctree-l2"><a class="reference internal" href="../intro.html#zoo-project-components">ZOO-Project components</a></li>
80<li class="toctree-l2"><a class="reference internal" href="../intro.html#open-source">Open Source</a></li>
81</ul>
82</li>
83<li class="toctree-l1"><a class="reference internal" href="../install/index.html">ZOO-Project installation</a><ul>
84<li class="toctree-l2"><a class="reference internal" href="../install/install-prerequisites.html">Prerequisites</a></li>
85<li class="toctree-l2"><a class="reference internal" href="../install/install-download.html">Download</a></li>
86<li class="toctree-l2"><a class="reference internal" href="../install/install-confoptions.html">Configure options</a></li>
87<li class="toctree-l2"><a class="reference internal" href="../install/install-installation.html">Installation on Unix/Linux</a></li>
88<li class="toctree-l2"><a class="reference internal" href="../install/install-onwindows.html">Installation on Windows ™</a></li>
89<li class="toctree-l2"><a class="reference internal" href="../install/install-onmacos.html">Installation on MacOSX ™</a></li>
90</ul>
91</li>
92<li class="toctree-l1"><a class="reference internal" href="../kernel/index.html">ZOO-Kernel</a><ul>
93<li class="toctree-l2"><a class="reference internal" href="../kernel/what.html">What is ZOO-Kernel ?</a></li>
94<li class="toctree-l2"><a class="reference internal" href="../kernel/configuration.html">ZOO-Kernel configuration</a></li>
95<li class="toctree-l2"><a class="reference internal" href="../kernel/mapserver.html">Optional MapServer support</a></li>
96<li class="toctree-l2"><a class="reference internal" href="../kernel/orfeotoolbox.html">Optional Orfeo Toolbox support</a></li>
97<li class="toctree-l2"><a class="reference internal" href="../kernel/sagagis.html">Optional SAGA GIS support</a></li>
98</ul>
99</li>
100<li class="toctree-l1"><a class="reference internal" href="../services/index.html">ZOO-Services</a><ul>
101<li class="toctree-l2"><a class="reference internal" href="../services/what.html">What are ZOO-Services ?</a></li>
102<li class="toctree-l2"><a class="reference internal" href="../services/zcfg-reference.html">ZOO-Service configuration file</a></li>
103<li class="toctree-l2"><a class="reference internal" href="../services/process-profiles.html">Process profiles registry</a></li>
104<li class="toctree-l2"><a class="reference internal" href="../services/howtos.html">Create your own ZOO-Services</a></li>
105<li class="toctree-l2"><a class="reference internal" href="../services/status.html">ZOO Status Service</a></li>
106<li class="toctree-l2"><a class="reference internal" href="../services/debug.html">Debugging ZOO Services</a></li>
107<li class="toctree-l2"><a class="reference internal" href="../services/zoo-services.html">Available ZOO-Services</a></li>
108</ul>
109</li>
110<li class="toctree-l1"><a class="reference internal" href="../api/index.html">ZOO-API</a><ul>
111<li class="toctree-l2"><a class="reference internal" href="../api/what.html">What is ZOO-API ?</a></li>
112<li class="toctree-l2"><a class="reference internal" href="../api/howto.html">Using ZOO-API</a></li>
113<li class="toctree-l2"><a class="reference internal" href="../api/classes.html">ZOO-API Classes</a></li>
114<li class="toctree-l2"><a class="reference internal" href="../api/examples.html">Examples</a></li>
115</ul>
116</li>
117<li class="toctree-l1 current"><a class="reference internal" href="index.html">ZOO-Client</a><ul class="current">
118<li class="toctree-l2"><a class="reference internal" href="what.html">What is ZOO-Client ?</a></li>
119<li class="toctree-l2 current"><a class="current reference internal" href="">Using ZOO-Client</a></li>
120<li class="toctree-l2"><a class="reference internal" href="example.html">Example application</a></li>
121</ul>
122</li>
123<li class="toctree-l1"><a class="reference internal" href="../contribute/index.html">Contributor Guide</a><ul>
124<li class="toctree-l2"><a class="reference internal" href="../contribute/howto.html">How to contribute ?</a></li>
125<li class="toctree-l2"><a class="reference internal" href="../contribute/code.html">Contribute code</a></li>
126</ul>
127</li>
128</ul>
129
130         
131       
132      </div>
133      &nbsp;
134    </nav>
135
136    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
137
138     
139      <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
140        <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
141        <a href="../contents.html">ZOO-Project</a>
142      </nav>
143
144
145     
146      <div class="wy-nav-content">
147        <div class="rst-content">
148          <div role="navigation" aria-label="breadcrumbs navigation">
149  <ul class="wy-breadcrumbs">
150
151    <li><a href="../contents.html"> Docs</a> &#8725; &#160;</li>
152     
153          <li><a href="index.html">ZOO-Client</a> &#8725; &#160;</li>
154     
155    <li>Using ZOO-Client</li>
156      <li class="wy-breadcrumbs-aside">
157       
158          <a href="../_sources/client/howto.txt" rel="nofollow"> View page source</a>
159       
160      </li>
161  </ul>
162  <hr/>
163</div>
164          <div role="main" class="document">
165           
166  <div class="section" id="using-zoo-client">
167<span id="client-howto"></span><h1>Using ZOO-Client<a class="headerlink" href="#using-zoo-client" title="Permalink to this headline"></a></h1>
168<p>This section will help you to get started using <a class="reference internal" href="what.html#client-what"><span>ZOO-Client</span></a>.</p>
169<div class="section" id="prerequisites">
170<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline"></a></h2>
171<p>ZOO-Client is based on the following Javascript libraries</p>
172<ul class="simple">
173<li>jQuery (<a class="reference external" href="http://www.jquery.com">http://www.jquery.com</a>)</li>
174<li>x2js (<a class="reference external" href="https://code.google.com/p/x2js/">https://code.google.com/p/x2js</a>)</li>
175<li>Require.js (<a class="reference external" href="http://requirejs.org/">http://requirejs.org</a> )</li>
176<li>Hogan.js (<a class="reference external" href="http://twitter.github.io/hogan.js">http://twitter.github.io/hogan.js</a> )</li>
177<li>query-string (<a class="reference external" href="https://github.com/sindresorhus/query-string/">https://github.com/sindresorhus/query-string</a> )</li>
178</ul>
179<div class="admonition warning">
180<p class="first admonition-title">Warning</p>
181<p class="last"><a class="reference external" href="http://nodejs.org/">Node.js</a> is also required on your system
182for compiling ZOO-Client templates.</p>
183</div>
184</div>
185<div class="section" id="download">
186<h2>Download<a class="headerlink" href="#download" title="Permalink to this headline"></a></h2>
187<p>If you did not <a class="reference internal" href="../install/install-download.html#install-download"><span>download</span></a> the ZOO-Project
188source code already, please proceed to a svn checkout with the
189following command:</p>
190<div class="highlight-python"><div class="highlight"><pre>svn checkout http://svn.zoo-project.org/svn/trunk/zoo-project/zoo-client
191</pre></div>
192</div>
193<div class="admonition warning">
194<p class="first admonition-title">Warning</p>
195<p class="last">You do not necessarily need to <a class="reference internal" href="../install/install-installation.html#install-installation"><span>install</span></a> the ZOO-Project server for using ZOO-Client. The corresponding svn <a class="reference external" href="http://zoo-project.org/trac/browser/trunk/zoo-project/zoo-client">directory</a> is needed only.</p>
196</div>
197</div>
198<div class="section" id="compiling-zoo-client-templates">
199<h2>Compiling ZOO-Client templates<a class="headerlink" href="#compiling-zoo-client-templates" title="Permalink to this headline"></a></h2>
200<p>In order to work with ZOO-Client, you will first need to compile the provided <a class="reference external" href="http://mustache.github.io/">Mustache</a>
201templates using <a class="reference external" href="http://nodejs.org/">Node.js</a>. The ZOO-Client templates are located in the <code class="docutils literal"><span class="pre">/zoo-project/zoo-client/lib/tpl</span></code> directory downloaded from svn.</p>
202<ul>
203<li><p class="first">Install Node.js (see related <a class="reference external" href="https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager">documentation</a>.)</p>
204</li>
205<li><p class="first">Install Hogan, the JavaScript templating engine, using the following command:</p>
206<div class="highlight-python"><div class="highlight"><pre>sudo npm install hogan
207</pre></div>
208</div>
209</li>
210<li><p class="first">Use Hulk (Hogan&#8217;s command line utility) for compiling the tempaltes
211using the following command:</p>
212<div class="highlight-python"><div class="highlight"><pre>hulk zoo-client/lib/tpl/*mustache &gt; \ zoo-client/lib/js/wps-client/payloads.js
213</pre></div>
214</div>
215</li>
216</ul>
217<div class="admonition warning">
218<p class="first admonition-title">Warning</p>
219<p class="last">Using different versions of Hogan to compile and to use in a web application may lead to compatibility issue.</p>
220</div>
221<p>Everything is now ready to work with <a class="reference internal" href="what.html#client-what"><span>ZOO-Client</span></a>. Read the <a class="reference internal" href="example.html#client-example"><span>next section</span></a> for an example JavaScript application.</p>
222</div>
223<div class="section" id="building-zoo-client-documentation">
224<h2>Building ZOO-Client documentation<a class="headerlink" href="#building-zoo-client-documentation" title="Permalink to this headline"></a></h2>
225<p>You may also build the ZOO-Client API documentation using <a class="reference external" href="http://usejsdoc.org/jsDoc">jsDoc</a>, with the following command:</p>
226<div class="highlight-python"><div class="highlight"><pre>npm install jsdoc
227~/node_modules/.bin/jsdoc zoo-client/lib/js/wps-client/* -p
228</pre></div>
229</div>
230<p>This will build HTML documentation in a new directory named <code class="docutils literal"><span class="pre">/out</span></code> in
231your working directory.</p>
232</div>
233</div>
234
235
236          </div>
237          <footer>
238 
239    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
240     
241        <a href="example.html" class="btn btn-neutral float-right" title="Example application">Next <span class="fa fa-arrow-circle-right"></span></a>
242     
243     
244        <a href="what.html" class="btn btn-neutral" title="What is ZOO-Client ?"><span class="fa fa-arrow-circle-left"></span> Previous</a>
245     
246    </div>
247 
248
249  <hr/>
250  <div class="pfoot">
251  <div role="contentinfo">
252    <p>
253        &copy; Copyright 2009-2015, ZOO-Project team.
254    </p>
255  </div>
256  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> inspired by <a href="https://readthedocs.org">Read the Docs</a>.
257</div>
258</footer>
259
260        </div>
261      </div>
262
263    </section>
264
265  </div>
266 
267
268
269 
270
271    <script type="text/javascript">
272        var DOCUMENTATION_OPTIONS = {
273            URL_ROOT:'../',
274            VERSION:'1.4a0',
275            COLLAPSE_INDEX:false,
276            FILE_SUFFIX:'.html',
277            HAS_SOURCE:  true
278        };
279    </script>
280      <script type="text/javascript" src="../_static/jquery.js"></script>
281      <script type="text/javascript" src="../_static/underscore.js"></script>
282      <script type="text/javascript" src="../_static/doctools.js"></script>
283
284 
285
286 
287 
288    <script type="text/javascript" src="../_static/js/theme.js"></script>
289 
290
291 
292 
293  <script type="text/javascript">
294      jQuery(function () {
295          SphinxRtdTheme.StickyNav.enable();
296      });
297  </script>
298   
299
300</body>
301</html>
Note: See TracBrowser for help on using the repository browser.

Download now !

Search

Context Navigation

Main 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