Add help in the admin page

tilecloud_chain/CONFIG.md

@@ -298,7 +298,7 @@
       - **`name`** _(string)_: The name used in the admin interface.
   - **`allowed_commands`** _(array)_: The allowed commands (main configuration). Default: `["generate-tiles", "generate-controller", "generate-cost"]`.
     - **Items** _(string)_
-  - **`allowed_arguments`** _(array)_: The allowed arguments (main configuration). Default: `["--layer", "--get-hash", "--generate-legend-images", "--get-bbox", "--help", "--ignore-errors", "--bbox", "--zoom", "--test", "--near", "--time", "--measure-generation-time", "--no-geom", "--dimensions"]`.
+  - **`allowed_arguments`** _(array)_: The allowed arguments (main configuration). Default: `["--layer", "--get-hash", "--generate-legend-images", "--get-bbox", "--help", "--ignore-error", "--bbox", "--zoom", "--test", "--near", "--time", "--measure-generation-time", "--no-geom", "--dimensions"]`.
     - **Items** _(string)_
   - **`admin_footer`** _(string)_: The footer of the admin interface.
   - **`admin_footer_classes`** _(string)_: The CSS classes used on the footer of the admin interface.

tilecloud_chain/configuration.py

@@ -14,7 +14,7 @@
     "--generate-legend-images",
     "--get-bbox",
     "--help",
-    "--ignore-errors",
+    "--ignore-error",
     "--bbox",
     "--zoom",
     "--test",
@@ -2527,7 +2527,7 @@ class Server(TypedDict, total=False):
       - --generate-legend-images
       - --get-bbox
       - --help
-      - --ignore-errors
+      - --ignore-error
       - --bbox
       - --zoom
       - --test

tilecloud_chain/schema.json

@@ -1137,7 +1137,7 @@
             "--generate-legend-images",
             "--get-bbox",
             "--help",
-            "--ignore-errors",
+            "--ignore-error",
             "--bbox",
             "--zoom",
             "--test",

tilecloud_chain/templates/admin_index.html

@@ -138,6 +138,45 @@ <h2>Launch generation</h2>
     <span id="result"></span>
     %endif
 
+    <!---->
+    %if request.identity.is_auth:
+    <h3>Usage</h3>
+    <h4><code>generate-tiles</code></h4>
+    <p>Generate the tiles.</p>
+    <p>Arguments:</p>
+    <ul>
+      <li>
+        <code>--layer=NAME</code>: the layer name to generate, it not specified all the layers are generated.
+      </li>
+      <li>
+        <code>--get-hash=Z/X/Y</code>: get the hash configuration for the layer (requires
+        <code>--layer</code>).
+      </li>
+      <li>
+        <code>--get-bbox=Z/X/Y[:-N/+N]</code>: get the bbox of a tile, use the specified tile
+        <code>Z/X/Y</code>, or <code>Z/X/Y:+N/+N</code> for metatiles (requires <code>--layer</code>).
+      </li>
+      <li>
+        <code>--dimensions DIMENSION=VALUE [DIMENSION=VALUE ...]</code>: overwrite the dimensions values
+        specified in the config file.
+      </li>
+      <li>
+        <code>--zoom=ZOOM</code> restrict to specified zoom level, or a zooms range (2-5), or a zooms list
+        (2,4,5).
+      </li>
+      <li><code>--bbox MINX MINY MAXX MAXY</code>: restrict to specified bounding box.</li>
+      <li>
+        <code>--near X Y</code>: This option is a good replacement of <code>--bbox</code>, to used with
+        <code>--time</code> or <code>--test</code> and <code>--zoom</code>, implies <code>--no-geom</code>. It
+        automatically measure a bbox around the X Y position that corresponds to the metatiles.
+      </li>
+      <li><code>--test N</code>: test with generating N tiles.</li>
+    </ul>
+
+    <h4><code>generate-controller --generate-legend-images</code></h4>
+    <p>Generate the legend images.</p>
+    %endif
+
     <h2>Test</h2>
     <p>See the result in <a href="/${admin_path}/test">the test page</a>.</p>
 

tilecloud_chain/tests/test_ui.py

@@ -17,7 +17,7 @@ def test_should_not_commit():
     [
         pytest.param("http://application:8080/admin/", "not-login", 250, 800, id="not-login"),
         pytest.param("http://application:8080/admin/test", "test", 800, 800, id="test-not-login"),
-        pytest.param("http://app_test_user:8080/admin", "index", 500, 1000, id="index"),
+        pytest.param("http://app_test_user:8080/admin", "index", 1000, 1000, id="index"),
         pytest.param("http://app_test_user:8080/admin/test", "test", 800, 800, id="test"),
     ],
 )