mapcomplete/Docs/URL_Parameters.md


URL-parameters and URL-hash
============================

This document gives an overview of which URL-parameters can be used to influence MapComplete.

What is a URL parameter?
------------------------

URL-parameters are extra parts of the URL used to set the state.

For example, if the url is `https://mapcomplete.osm.be/cyclofix?lat=51.0&lon=4.3&z=5&test=true#node/1234`,
the URL-parameters are stated in the part between the `?` and the `#`. There are multiple, all seperated by `&`, namely:

- The url-parameter `lat` is `51.0` in this instance
- The url-parameter `lon` is `4.3` in this instance
- The url-parameter `z` is `5` in this instance
- The url-parameter `test` is `true` in this instance

Finally, the URL-hash is the part after the `#`. It is `node/1234` in this case.


 layer-control-toggle 
----------------------

 Whether or not the layer control is shown The default value is _false_


 filter-toggle 
---------------

 Whether or not the filter view is shown The default value is _false_


 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_


 z 
---

 The initial/current zoom level The default value is _0_


 lat 
-----

 The initial/current latitude The default value is _0_


 lon 
-----

 The initial/current longitude of the app The default value is _0_


 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_


 fs-search 
-----------

 Disables/Enables the search bar The default value is _true_


 fs-layers 
-----------

 Disables/Enables the layer control The default value is _true_


 fs-filter 
-----------

 Disables/Enables the filter The default value is _true_


 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_


 fs-welcome-message 
--------------------

 Disables/enables the help menu or welcome message The default value is _true_


 fs-iframe 
-----------

 Disables/Enables the iframe-popup The default value is _false_


 fs-more-quests 
----------------

 Disables/Enables the 'More Quests'-tab in the welcome message The default value is _true_


 fs-share-screen 
-----------------

 Disables/Enables the 'Share-screen'-tab in the welcome message The default value is _true_


 fs-geolocation 
----------------

 Disables/Enables the geolocation button The default value is _true_


 fs-all-questions 
------------------

 Always show all questions The default value is _false_


 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_


 debug 
-------

 If true, shows some extra debugging help such as all the available tags on every object 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_


 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 __


 background 
------------

 The id of the background layer to start with The default value is _osm_


 layer-<layer-id> 
------------------

 Wether or not the layer with id <layer-id> is shown The default value is _true_ Generated from QueryParameters
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00
Documentation updates, patches image paths in themes to load remote images from Github 2021-04-17 11:37:22 +02:00			`URL-parameters and URL-hash`
			`============================`

			`This document gives an overview of which URL-parameters can be used to influence MapComplete.`

			`What is a URL parameter?`
			`------------------------`

			`URL-parameters are extra parts of the URL used to set the state.`

			For example, if the url is `https://mapcomplete.osm.be/cyclofix?lat=51.0&lon=4.3&z=5&test=true#node/1234`,
			the URL-parameters are stated in the part between the `?` and the `#`. There are multiple, all seperated by `&`, namely:

			- The url-parameter `lat` is `51.0` in this instance
			- The url-parameter `lon` is `4.3` in this instance
			- The url-parameter `z` is `5` in this instance
			- The url-parameter `test` is `true` in this instance

			Finally, the URL-hash is the part after the `#`. It is `node/1234` in this case.

Add docs on URL-parameters 2021-04-06 18:34:45 +02:00
Update docs 2021-07-24 02:42:37 +02:00			`layer-control-toggle`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00			`----------------------`
Documentation update 2021-06-08 17:00:54 +02:00
Update docs 2021-07-24 02:42:37 +02:00			`Whether or not the layer control is shown The default value is _false_`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00

Fix doc-generating script, regenerate docs 2021-07-28 00:12:14 +02:00			`filter-toggle`
			`---------------`

			`Whether or not the filter view is shown The default value is _false_`


Update docs 2021-07-24 02:42:37 +02:00			`tab`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00			`-----`
Documentation updates, patches image paths in themes to load remote images from Github 2021-04-17 11:37:22 +02:00
Update docs 2021-07-24 02:42:37 +02:00			`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_`
Documentation updates, patches image paths in themes to load remote images from Github 2021-04-17 11:37:22 +02:00
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00
Update docs 2021-07-24 02:42:37 +02:00			`z`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`---`

Update docs 2021-07-24 02:42:37 +02:00			`The initial/current zoom level The default value is _0_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`lat`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`-----`

Update docs 2021-07-24 02:42:37 +02:00			`The initial/current latitude The default value is _0_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`lon`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`-----`

Update docs 2021-07-24 02:42:37 +02:00			`The initial/current longitude of the app The default value is _0_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-userbadge`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`--------------`

Update docs 2021-07-24 02:42:37 +02:00			`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_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-search`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`-----------`

Update docs 2021-07-24 02:42:37 +02:00			`Disables/Enables the search bar The default value is _true_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-layers`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`-----------`

Update docs 2021-07-24 02:42:37 +02:00			`Disables/Enables the layer control The default value is _true_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Fix doc-generating script, regenerate docs 2021-07-28 00:12:14 +02:00			`fs-filter`
			`-----------`

			`Disables/Enables the filter The default value is _true_`


Update docs 2021-07-24 02:42:37 +02:00			`fs-add-new`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`------------`

Update docs 2021-07-24 02:42:37 +02:00			`Disables/Enables the 'add new feature'-popup. (A theme without presets might not have it in the first place) The default value is _true_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-welcome-message`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`--------------------`

Update docs 2021-07-24 02:42:37 +02:00			`Disables/enables the help menu or welcome message The default value is _true_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-iframe`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`-----------`

Update docs 2021-07-24 02:42:37 +02:00			`Disables/Enables the iframe-popup The default value is _false_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-more-quests`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`----------------`

Update docs 2021-07-24 02:42:37 +02:00			`Disables/Enables the 'More Quests'-tab in the welcome message The default value is _true_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-share-screen`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`-----------------`

Update docs 2021-07-24 02:42:37 +02:00			`Disables/Enables the 'Share-screen'-tab in the welcome message The default value is _true_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-geolocation`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00			`----------------`

Update docs 2021-07-24 02:42:37 +02:00			`Disables/Enables the geolocation button The default value is _true_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`fs-all-questions`
Documentation update 2021-06-08 17:00:54 +02:00			`------------------`

Update docs 2021-07-24 02:42:37 +02:00			`Always show all questions The default value is _false_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`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_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`debug`
Add fake user switch to mimick a logged in user; fixes #432 2021-07-16 02:06:33 +02:00			`-------`
Documentation update 2021-06-08 17:00:54 +02:00
Update docs 2021-07-24 02:42:37 +02:00			`If true, shows some extra debugging help such as all the available tags on every object The default value is _false_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00
Fix doc-generating script, regenerate docs 2021-07-28 00:12:14 +02:00			`fake-user`
			`-----------`

			`If true, 'dryrun' mode is activated and a fake user account is loaded The default value is _false_`


Update docs 2021-07-24 02:42:37 +02:00			`backend`
			`---------`
Add docs on URL-parameters 2021-04-06 18:34:45 +02:00
Update docs 2021-07-24 02:42:37 +02:00			`The OSM backend to use - can be used to redirect mapcomplete to the testing backend when using 'osm-test' The default value is _osm_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

Update docs 2021-07-24 02:42:37 +02:00			`custom-css`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00			`------------`

Update docs 2021-07-24 02:42:37 +02:00			`If specified, the custom css from the given link will be loaded additionaly The default value is __`


			`background`
			`------------`
Add fake user switch to mimick a logged in user; fixes #432 2021-07-16 02:06:33 +02:00
Update docs 2021-07-24 02:42:37 +02:00			`The id of the background layer to start with The default value is _osm_`
Fix deployment, fix documentation generation, add a small markdown generator 2021-06-15 00:28:59 +02:00

			`layer-<layer-id>`
			`------------------`

Regenerate docs 2021-06-16 17:21:37 +02:00			`Wether or not the layer with id <layer-id> is shown The default value is _true_ Generated from QueryParameters`