[ZOO-Discuss] [ZOO Project Trac] #22: Table of Contents for documentation

[ZOO Project Trac]

#22: Table of Contents for documentation
---------------------------+------------------------------------------------
 Reporter:  jmckenna       |       Owner:  jmckenna
     Type:  task           |      Status:  new     
 Priority:  major          |   Milestone:  1.2.0   
Component:  Documentation  |     Version:          
 Keywords:                 |  
---------------------------+------------------------------------------------
 from nickboz:

             Introduction to ZOO-Project

                 ZOO Kernel description (in short)
                 ZOO Services description (in short)
                 ZOO API description (in short)

             ZOO Tutorial

                 The tutorial should be a lighter version of this:
 (simplified WS TOC)
                 http://zoo-project.org/trac/wiki/ZooWorkshop/FOSS4GJapan
                 with and simplified text, OSGeoLive 4.5 use and Python
 language exercises only


             ZOO Kernel Documentation

                 Installation

                     Unix
                         Prerequisites
                         Getting the code from SVN
                         For the impatient
                         Configure options
                         ZOO on OpenSuse ( see: http://www.zoo-
 project.org/trac/wiki/ZooDocumentation/ZOOKernel/OpenSUSE_installation)
                         ZOO on CentOS (see: http://www.zoo-
 project.org/trac/wiki/ZooDocumentation/ZOOKernel/CentOS_installation )
                         ZOO on Debian/Ubuntu (http://www.zoo-
 project.org/trac/wiki/ZooDocumentation/ZOOKernel/DebianLike_installation)

                     Win32 (Aka ZOO4W. see http://zoo-
 project.org/trac/wiki/ZooWebSite/ZooKernel/ZOO4W )
                         Prerequisites
                         Download and install ZOO kernel
                         Deploy ZOO Services Providers

                     Mac OSX (see http://zoo-
 project.org/trac/wiki/ZooDocumentation/ZOOKernel/MacOSX_installation )
                         Prerequisites
                         Compilation
                         Deploy ZOO Services Providers

                     Congiguration option
                             GDAL Support
                             XML2 Support
                             Python Support
                             PHP Support
                             Perl Support
                             Fortran support
                             Java Support
                             JavaScript Support

             ZOO Services Documentation

                     Introduction
                     What is a ZOO Service ?
                         Description
                         Configuration file

                     The .zcfg Reference (see: http://zoo-
 project.org/trac/wiki/ZooWebSite/ZooServices/ZCFGReference )
                         Main metadata informations
                         List of Inputs
                         List of Outputs
                         Type Of Data Nodes
                             LiteralData node
                             BoundingBoxData node
                             ComplexData node

                     Example ZOO Services with code blocks and explanations
 (see source codes here: http://www.zoo-project.org/trac/browser/trunk/zoo-
 services)

                         C services
                             GDAL based service example
                             OGR based service example

                         Python service
                             see http://www.zoo-
 project.org/trac/browser/trunk/zoo-services/hello-py
                             see http://www.zoo-
 project.org/trac/wiki/ZooDocumentation/ZOOServices

                         Java Service
                             see http://zoo-project.org/trac/browser/trunk
 /zoo-services/hello-java

                         Perl Service
                             see http://zoo-project.org/trac/browser/trunk
 /zoo-services/hello-java

                         Fortran service
                             see http://zoo-project.org/trac/browser/trunk
 /zoo-services/hello-fotran

                         PHP service
                             see http://zoo-project.org/trac/browser/trunk
 /zoo-services/hello-php

                         JavaScript service
                             see http://zoo-project.org/trac/browser/trunk
 /zoo-services/hello-js#cgi-env

                     Using GRASS7 support
                         Introduction to WPS-bridge (with link to soeren's
 project page)
                         List of the GRASS7 supported modules with link to
 the official GRASS documenation
                         Example generated python code and zcfg with r.xxx
 module
                         Example generated python code and zcfg with v.xxx
 module


             ZOO API Documentation

                 Introduction
                     What is the ZOO API? (see: http://zoo-
 project.org/trac/wiki/ZooDocumentation/ZOOAPI)

                 ZOO API classes ( see: http://zoo-
 project.org/trac/ticket/15 . A zip with the API natural doc inside is
 available)

                 ZOO API examples (see: http://zoo-
 project.org/trac/wiki/ZooWebSite/ZOOAPI/Examples )

-- 
Ticket URL: <http://svn.zoo-project.org/trac/ticket/22>
ZOO Project Trac <http://www.zoo-project.org/>
Open WPS Platform