Changeset 469 for trunk/docs/services

Timestamp:

May 1, 2014, 1:28:14 AM (11 years ago)

Author:

djay

Message:

Support metapath embedded in service name. Add support for accessing ZOO-Kernel path subdirectories for full list of available services. Fix issue #98.

File:

• trunk/docs/services/zcfg-reference.txt (modified) (5 diffs)

trunk/docs/services/zcfg-reference.txt

@@ -19 +19 @@
 
 1. Main Metadata information
-2. List of Inputs metadata information
+2. List of Inputs metadata information (optional since `rev. 469 <http://zoo-project.org/trac/changeset/469>`__)
 3. List of Outputs metadata information
 
@@ -112 +112 @@
 - :ref:`ComplexData <ComplexData>`
 
-Except for ``LiteralData``, each *Type Of Data* node must have at least one ``<Default>`` and one ``<Supported>`` node. Even 
-if one of those are empty, it **has to be present** with an opening and closing tag on two different lines. So, something 
-like the following:
-
-.. code-block:: guess
-   :linenos:
-
-   <Default>
-   </Default>
-
-Otherwise, ZOO-Kernel won't be able to parse your ZCFG and will fail to process requests.
+Except for ``LiteralData``, each *Type Of Data* node must have at least one ``<Default>`` node. Even 
+if empty, it **has to be present**. So, something
+like the following should be present in your ZCFG file:
+
+.. code-block:: guess
+   :linenos:
+
+   <Default />
+
+Otherwise, ZOO-Kernel won't be able to parse your ZCFG correctly.
 
 .. _LiteralData:
@@ -132 +131 @@
 
 - one (optional) ``AllowedValues`` key containing all value allowed for this input
+- one (optional) ``range`` properties containing the range (``[``, ``]``)
 - one (optional) ``rangeMin`` (``rangeMax``) properties containing the minimum (maximum) value of this range
 - one (optional) ``rangeSpacing`` properties containing the regular distance or spacing between value in this range
@@ -178 +178 @@
    </LiteralData>
 
+Or more simply:
+
+.. code-block:: guess
+   :linenos:
+   
+   <LiteralData>
+     dataType = float
+     range = [0.0,100.0]
+     <Default />
+   </LiteralData>
+
 A typical ``<LiteralData>`` node, defining a ``string`` data type which
 support values ``hillshade``, ``slope``, ``aspect``, ``TRI``, ``TPI``
@@ -192 +203 @@
 
 Properties ``AllowedValues`` and ``range*`` can be conbined with both ``<Default>`` and
-``<Supported>`` nodes in the same ``<LiteralData>`` node.
+``<Supported>`` nodes in the same was as ``<LiteralData>`` node. For
+instance, the following is supported:
+
+.. code-block:: guess
+   :linenos:
+   
+   <LiteralData>
+     dataType = int
+     <Default>
+       value = 11
+       AllowedValues = -10,-8,-7,-5,-1
+       rangeMin = 0
+       rangeMin = 100
+       rangeClosure = co
+     </Default>
+     <Supported>
+       rangeMin = 200
+       rangeMin = 600
+       rangeClosure = co
+     </Supported>
+     <Supported>
+       rangeMin = 750
+       rangeMin = 990
+       rangeClosure = co
+       rangeSpacing = 10
+     </Supported>
+   </LiteralData>
 
 .. _BoundingBoxData: