Merge pull request orbisgis#783 from gpetit/doc_h2gis_version

Add doc for H2GISversion, ST_MakeValid and ST_RemoveDuplicatedCoordinates
gpetit · Mar 30, 2017 · d165246 · d165246
2 parents 38968d9 + 84c2141
commit d165246
Show file tree

Hide file tree

Showing 37 changed files with 3,364 additions and 25 deletions.
diff --git a/_data/docs.yml b/_data/docs.yml
@@ -38,11 +38,15 @@
   - geom3D/topography, Topography
   - geom3D/triangulation, Triangulation
 
+- title: Raster
+  page: raster
+  docs:
+
+- title: System
+  page: system
+  docs:
+
 - title: Applications
   page: applications
   docs:
   - h2network, H2Network
-
-- title: Raster
-  page: raster
-  docs:
diff --git a/_includes/all_system_functions.html b/_includes/all_system_functions.html
@@ -0,0 +1,31 @@
+<!-- For this to work, every page must have a category and a description -->
+<table>
+<thead>
+<tr>
+<th>Function</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+{% assign pages = site.pages | sort: 'name' %}
+{% assign version = page.url | replace_first:'/docs/','' | split:"/" | first %}
+{% for p in pages %}
+    {% if p.url contains version %}
+	    {% if p.category contains 'system' %}
+		{% unless p.permalink contains 'system' %}
+		    {% if p.description %}
+		        {% capture described %}{{ described | plus:1 }}{% endcapture %}
+		    {% endif %}
+		    {% capture total %}{{ total | plus:1 }}{% endcapture %}
+		    <tr>
+		    <td><a href="{{ p.url }}"><code>{{ p.title }}</code></a></td>
+		    <td>{{ p.description }}</td>
+		    </tr>
+		{% endunless %}
+	    {% endif %}
+    {% endif %}
+{% endfor %}
+</tbody>
+</table>
+
+Documented functions: {{ described }}/{{ total }}.
diff --git a/docs/1.2/H2GISversion.md b/docs/1.2/H2GISversion.md
@@ -0,0 +1,7 @@
+---
+layout: docs
+title: H2GISversion
+permalink: /docs/1.2/H2GISversion/
+---
+
+Sorry, this function does not exist in this version of H2GIS.
diff --git a/docs/1.2/ST_MakeValid.md b/docs/1.2/ST_MakeValid.md
@@ -0,0 +1,7 @@
+---
+layout: docs
+title: ST_MakeValid
+permalink: /docs/1.2/ST_MakeValid/
+---
+
+Sorry, this function does not exist in this version of H2GIS.
diff --git a/docs/1.2/applications/h2network.md b/docs/1.2/applications/h2network.md
@@ -2,8 +2,7 @@
 layout: docs
 title: H2Network
 category: applications/h2network
-prev_section: applications
-next_section: raster
+prev_section: system
 permalink: /docs/1.2/h2network/
 ---
 

diff --git a/docs/1.2/applications/list.md b/docs/1.2/applications/list.md
@@ -2,7 +2,7 @@
 layout: docs
 title: Applications
 category: applications
-prev_section: geom3D/triangulation
+prev_section: system
 next_section: h2network
 permalink: /docs/1.2/applications/
 ---

diff --git a/docs/1.2/geom3D/triangulation.md b/docs/1.2/geom3D/triangulation.md
@@ -3,7 +3,7 @@ layout: docs
 title: Triangulation
 category: geom3D/triangulation
 prev_section: geom3D/topography
-next_section: applications
+next_section: raster
 permalink: /docs/1.2/geom3D/triangulation/
 ---
 

diff --git a/docs/1.2/raster/list.md b/docs/1.2/raster/list.md
@@ -2,7 +2,8 @@
 layout: docs
 title: Raster functions
 category: raster
-prev_section: h2network
+prev_section: geom3D
+next_section: system
 permalink: /docs/1.2/raster/
 ---
 

diff --git a/docs/1.2/system/list.md b/docs/1.2/system/list.md
@@ -0,0 +1,12 @@
+---
+layout: docs
+title: System
+category: system
+prev_section: raster
+next_section: applications
+permalink: /docs/1.2/system/
+---
+
+Sorry, there is no system functions available in the v1.2 of H2GIS.
+
+Please refers to the documentation under [development](../../dev/system).
diff --git a/docs/1.3/H2GISversion.md b/docs/1.3/H2GISversion.md
@@ -0,0 +1,7 @@
+---
+layout: docs
+title: H2GISversion
+permalink: /docs/1.3/H2GISversion/
+---
+
+Sorry, this function does not exist in this version of H2GIS.
diff --git a/docs/1.3/ST_MakeValid.md b/docs/1.3/ST_MakeValid.md
@@ -0,0 +1,7 @@
+---
+layout: docs
+title: ST_MakeValid
+permalink: /docs/1.3/ST_MakeValid/
+---
+
+Sorry, this function does not exist in this version of H2GIS.
diff --git a/docs/1.3/applications/h2network.md b/docs/1.3/applications/h2network.md
@@ -2,8 +2,7 @@
 layout: docs
 title: H2Network
 category: applications/h2network
-prev_section: applications
-next_section: raster
+prev_section: system
 permalink: /docs/1.3/h2network/
 ---
 

diff --git a/docs/1.3/applications/list.md b/docs/1.3/applications/list.md
@@ -2,7 +2,7 @@
 layout: docs
 title: Applications
 category: applications
-prev_section: geom3D/triangulation
+prev_section: system
 next_section: h2network
 permalink: /docs/1.3/applications/
 ---

diff --git a/docs/1.3/geom3D/triangulation.md b/docs/1.3/geom3D/triangulation.md
@@ -3,7 +3,7 @@ layout: docs
 title: Triangulation
 category: geom3D/triangulation
 prev_section: geom3D/topography
-next_section: applications
+next_section: raster
 permalink: /docs/1.3/geom3D/triangulation/
 ---
 

diff --git a/docs/1.3/raster/list.md b/docs/1.3/raster/list.md
@@ -2,7 +2,8 @@
 layout: docs
 title: Raster functions
 category: raster
-prev_section: h2network
+prev_section: geom3D
+next_section: system
 permalink: /docs/1.3/raster/
 ---
 

diff --git a/docs/1.3/system/list.md b/docs/1.3/system/list.md
@@ -0,0 +1,12 @@
+---
+layout: docs
+title: System
+category: system
+prev_section: raster
+next_section: applications
+permalink: /docs/1.3/system/
+---
+
+Sorry, there is no system functions available in the v1.3 of H2GIS.
+
+Please refers to the documentation under [development](../../dev/system).
diff --git a/docs/dev/H2GISversion.md b/docs/dev/H2GISversion.md
@@ -0,0 +1,34 @@
+---
+layout: docs
+title: H2GISversion
+category: system/version
+is_function: true
+description: Return H2GIS version
+prev_section: system
+next_section: applications
+permalink: /docs/dev/H2GISversion/
+---
+
+### Signature
+
+{% highlight mysql %}
+STRING H2GISversion();
+{% endhighlight %}
+
+### Description
+
+Return the current version of H2GIS stored in the manifest, otherwise return `unknown`.
+
+
+### Example
+
+{% highlight mysql %}
+SELECT H2GISversion();
+
+-- Answer:
+	1.3.1-SNAPSHOT
+{% endhighlight %}
+
+##### See also
+
+* <a href="https://github.com/orbisgis/h2gis/blob/master/h2gis-functions/src/main/java/org/h2gis/functions/system/H2GISversion.java" target="_blank">Source code</a>
diff --git a/docs/dev/ST_LineMerge.md b/docs/dev/ST_LineMerge.md
@@ -5,7 +5,7 @@ category: geom2D/process-geometries
 is_function: true
 description: Merges a collection of linear components to form maximal-length <code>LINESTRING</code>
 prev_section: ST_LineIntersector
-next_section: ST_Polygonize
+next_section: ST_MakeValid
 permalink: /docs/dev/ST_LineMerge/
 ---