From af18870bf842885d22c1b44aab68a4dedc0cbcd7 Mon Sep 17 00:00:00 2001
From: pietervdvn <pietervdvn@posteo.net>
Date: Sat, 24 Jul 2021 02:42:37 +0200
Subject: [PATCH] Update docs
---
Docs/SpecialInputElements.md | 12 ++-
Docs/TagInfo/mapcomplete_cyclofix.json | 19 ++++
Docs/URL_Parameters.md | 124 +++++++++++--------------
3 files changed, 79 insertions(+), 76 deletions(-)
diff --git a/Docs/SpecialInputElements.md b/Docs/SpecialInputElements.md
index 3eb09bbb2..3249c0b91 100644
--- a/Docs/SpecialInputElements.md
+++ b/Docs/SpecialInputElements.md
@@ -14,6 +14,14 @@ A string, but allows input of longer strings more comfortably (a text area)
A date
+## direction
+
+A geographical direction, in degrees. 0° is north, 90° is east, ... Will return a value between 0 (incl) and 360 (excl)
+
+## length
+
+A geographical length in meters (rounded at two points). Will give an extra minimap with a measurement tool. Arguments: [ zoomlevel, preferredBackgroundMapType (comma seperated) ], e.g. `["21", "map,photo"]
+
## wikidata
A wikidata identifier, e.g. Q42
@@ -30,10 +38,6 @@ A positive number or zero
A strict positive number
-## direction
-
-A geographical direction, in degrees. 0° is north, 90° is east, ... Will return a value between 0 (incl) and 360 (excl)
-
## float
A decimal
diff --git a/Docs/TagInfo/mapcomplete_cyclofix.json b/Docs/TagInfo/mapcomplete_cyclofix.json
index fc5f1d19d..7e266843e 100644
--- a/Docs/TagInfo/mapcomplete_cyclofix.json
+++ b/Docs/TagInfo/mapcomplete_cyclofix.json
@@ -588,6 +588,25 @@
"description": "Layer 'Bike stations (repair, pump or both)' shows manometer=broken with a fixed text, namely 'There is manometer but it is broken' and allows to pick this as a default answer (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')",
"value": "broken"
},
+ {
+ "key": "level",
+ "description": "Layer 'Bike stations (repair, pump or both)' shows and asks freeform values for key 'level' (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')"
+ },
+ {
+ "key": "location",
+ "description": "Layer 'Bike stations (repair, pump or both)' shows location=underground with a fixed text, namely 'Located underground' (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')",
+ "value": "underground"
+ },
+ {
+ "key": "level",
+ "description": "Layer 'Bike stations (repair, pump or both)' shows level=0 with a fixed text, namely 'Located on the ground floor' and allows to pick this as a default answer (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')",
+ "value": "0"
+ },
+ {
+ "key": "level",
+ "description": "Layer 'Bike stations (repair, pump or both)' shows level=1 with a fixed text, namely 'Located on the first floor' and allows to pick this as a default answer (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')",
+ "value": "1"
+ },
{
"key": "service:bicycle:cleaning:charge",
"description": "Layer 'Bike stations (repair, pump or both)' shows and asks freeform values for key 'service:bicycle:cleaning:charge' (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')"
diff --git a/Docs/URL_Parameters.md b/Docs/URL_Parameters.md
index 5c3158fd7..5b62d4599 100644
--- a/Docs/URL_Parameters.md
+++ b/Docs/URL_Parameters.md
@@ -20,158 +20,138 @@ the URL-parameters are stated in the part between the `?` and the `#`. There are
Finally, the URL-hash is the part after the `#`. It is `node/1234` in this case.
-backend
----------
-
-The OSM backend to use - can be used to redirect mapcomplete to the testing backend when using 'osm-test' The default value is _osm_
-
-
-test
-------
-
-If true, 'dryrun' mode is activated. The app will behave as normal, except that changes to OSM will be printed onto the console instead of actually uploaded to osm.org The default value is _false_
-
-
-layout
---------
-
-The layout to load into MapComplete The default value is __
-
-
-userlayout
-------------
-
-If not 'false', a custom (non-official) theme is loaded. This custom layout can be done in multiple ways:
-
-- The hash of the URL contains a base64-encoded .json-file containing the theme definition
-- The hash of the URL contains a lz-compressed .json-file, as generated by the custom theme generator
-- The parameter itself is an URL, in which case that URL will be downloaded. It should point to a .json of a theme The default value is _false_
-
-
-layer-control-toggle
+ layer-control-toggle
----------------------
-Whether or not the layer control is shown The default value is _false_
+ Whether or not the layer control is shown The default value is _false_
-tab
+ tab
-----
-The tab that is shown in the welcome-message. 0 = the explanation of the theme,1 = OSM-credits, 2 = sharescreen, 3 = more themes, 4 = about mapcomplete (user must be logged in and have >50 changesets) The default value is _0_
+ The tab that is shown in the welcome-message. 0 = the explanation of the theme,1 = OSM-credits, 2 = sharescreen, 3 = more themes, 4 = about mapcomplete (user must be logged in and have >50 changesets) The default value is _0_
-z
+ z
---
-The initial/current zoom level The default value is _14_
+ The initial/current zoom level The default value is _0_
-lat
+ lat
-----
-The initial/current latitude The default value is _51.2095_
+ The initial/current latitude The default value is _0_
-lon
+ lon
-----
-The initial/current longitude of the app The default value is _3.2228_
+ The initial/current longitude of the app The default value is _0_
-fs-userbadge
+ fs-userbadge
--------------
-Disables/Enables the user information pill (userbadge) at the top left. Disabling this disables logging in and thus disables editing all together, effectively putting MapComplete into read-only mode. The default value is _true_
+ Disables/Enables the user information pill (userbadge) at the top left. Disabling this disables logging in and thus disables editing all together, effectively putting MapComplete into read-only mode. The default value is _true_
-fs-search
+ fs-search
-----------
-Disables/Enables the search bar The default value is _true_
+ Disables/Enables the search bar The default value is _true_
-fs-layers
+ fs-layers
-----------
-Disables/Enables the layer control The default value is _true_
+ Disables/Enables the layer control The default value is _true_
-fs-add-new
+ fs-add-new
------------
-Disables/Enables the 'add new feature'-popup. (A theme without presets might not have it in the first place) The default value is _true_
+ Disables/Enables the 'add new feature'-popup. (A theme without presets might not have it in the first place) The default value is _true_
-fs-welcome-message
+ fs-welcome-message
--------------------
-Disables/enables the help menu or welcome message The default value is _true_
+ Disables/enables the help menu or welcome message The default value is _true_
-fs-iframe
+ fs-iframe
-----------
-Disables/Enables the iframe-popup The default value is _false_
+ Disables/Enables the iframe-popup The default value is _false_
-fs-more-quests
+ fs-more-quests
----------------
-Disables/Enables the 'More Quests'-tab in the welcome message The default value is _true_
+ Disables/Enables the 'More Quests'-tab in the welcome message The default value is _true_
-fs-share-screen
+ fs-share-screen
-----------------
-Disables/Enables the 'Share-screen'-tab in the welcome message The default value is _true_
+ Disables/Enables the 'Share-screen'-tab in the welcome message The default value is _true_
-fs-geolocation
+ fs-geolocation
----------------
-Disables/Enables the geolocation button The default value is _true_
+ Disables/Enables the geolocation button The default value is _true_
-fs-all-questions
+ fs-all-questions
------------------
-Always show all questions The default value is _false_
+ Always show all questions The default value is _false_
-fs-export
+ fs-export
-----------
-If set, enables the 'download'-button to download everything as geojson The default value is _false_
+ If set, enables the 'download'-button to download everything as geojson The default value is _false_
-fake-user
+ test
+------
+
+ If true, 'dryrun' mode is activated. The app will behave as normal, except that changes to OSM will be printed onto the console instead of actually uploaded to osm.org The default value is _false_
+
+
+ fake-user
-----------
-If true, 'dryrun' mode is activated and a fake user account is loaded The default value is _false_
+ If true, 'dryrun' mode is activated and a fake user account is loaded The default value is _false_
-debug
+ debug
-------
-If true, shows some extra debugging help such as all the available tags on every object The default value is _false_
+ If true, shows some extra debugging help such as all the available tags on every object The default value is _false_
-custom-css
+ backend
+---------
+
+ The OSM backend to use - can be used to redirect mapcomplete to the testing backend when using 'osm-test' The default value is _osm_
+
+
+ custom-css
------------
-If specified, the custom css from the given link will be loaded additionaly The default value is __
+ If specified, the custom css from the given link will be loaded additionaly The default value is __
-background
+ background
------------
-The id of the background layer to start with The default value is _osm_
+ The id of the background layer to start with The default value is _osm_
-oauth_token
--------------
-
-Used to complete the login No default value set
layer-<layer-id>
------------------