ilja_space/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Chore: regen docs

Browse source
This commit is contained in:
Pieter Vander Vennet 2024-05-07 00:41:59 +02:00
parent fbf23b6e18
commit e653b64e69
181 changed files with 47772 additions and 30313 deletions
Download patch file Download diff file Expand all files Collapse all files

646
Docs/URL_Parameters.md
View file

@ -1,397 +1,493 @@
[//]: # (WARNING: this file is automatically generated. Please find the sources at the bottom and edit those sources)
URL-parameters and URL-hash
===========================
URL-parameters and URL-hash
=============================
This document gives an overview of which URL-parameters can be used to influence MapComplete.
Table of contents
-----------------
1. [What is a URL parameter?](#-what-is-a-url-parameter-)
## Table of contents
* [Possible hashes to open a menu](#possible-hashes-to-open-a-menu)
1. [ What is a URL parameter? ](#-what-is-a-url-parameter-)
- [Possible hashes to open a menu](#possible-hashes-to-open-a-menu)
2. [ language ](#-language-)
3. [ fs-translation-mode ](#-fs-translation-mode-)
4. [ fake-user ](#-fake-user-)
5. [ fs-enable-login ](#-fs-enable-login-)
6. [ fs-search ](#-fs-search-)
7. [ fs-background ](#-fs-background-)
8. [ fs-filter ](#-fs-filter-)
9. [ fs-welcome-message ](#-fs-welcome-message-)
10. [ fs-community-index ](#-fs-community-index-)
11. [ fs-iframe-popout ](#-fs-iframe-popout-)
12. [ fs-more-quests ](#-fs-more-quests-)
13. [ fs-share-screen ](#-fs-share-screen-)
14. [ fs-geolocation ](#-fs-geolocation-)
15. [ fs-all-questions ](#-fs-all-questions-)
16. [ fs-export ](#-fs-export-)
17. [ test ](#-test-)
18. [ debug ](#-debug-)
19. [ moreprivacy ](#-moreprivacy-)
20. [ overpassUrl ](#-overpassurl-)
21. [ overpassTimeout ](#-overpasstimeout-)
22. [ overpassMaxZoom ](#-overpassmaxzoom-)
23. [ osmApiTileSize ](#-osmapitilesize-)
24. [ background ](#-background-)
25. [ z ](#-z-)
26. [ lat ](#-lat-)
27. [ lon ](#-lon-)
28. [ oauth_token ](#-oauth_token-)
29. [ layer-public_bookcase ](#-layer-public_bookcase-)
30. [ filter-public_bookcase-kid-books ](#-filter-public_bookcase-kid-books-)
31. [ filter-public_bookcase-adult-books ](#-filter-public_bookcase-adult-books-)
32. [ filter-public_bookcase-inside ](#-filter-public_bookcase-inside-)
33. [ filter-public_bookcase-has_image ](#-filter-public_bookcase-has_image-)
34. [ layer-note_import_public_bookcase ](#-layer-note_import_public_bookcase-)
35. [ mode ](#-mode-)
36. [ layer-<layer-id> ](#-layer-<layer-id>-)
What is a URL parameter?
--------------------------
2. [language](#-language-)
3. [fs-translation-mode](#-fs-translation-mode-)
4. [fake-user](#-fake-user-)
5. [fs-enable-login](#-fs-enable-login-)
6. [fs-search](#-fs-search-)
7. [fs-background](#-fs-background-)
8. [fs-filter](#-fs-filter-)
9. [fs-welcome-message](#-fs-welcome-message-)
10. [fs-community-index](#-fs-community-index-)
11. [fs-iframe-popout](#-fs-iframe-popout-)
12. [fs-more-quests](#-fs-more-quests-)
13. [fs-share-screen](#-fs-share-screen-)
14. [fs-geolocation](#-fs-geolocation-)
15. [fs-all-questions](#-fs-all-questions-)
16. [fs-export](#-fs-export-)
17. [test](#-test-)
18. [debug](#-debug-)
19. [overpassUrl](#-overpassurl-)
20. [overpassTimeout](#-overpasstimeout-)
21. [overpassMaxZoom](#-overpassmaxzoom-)
22. [osmApiTileSize](#-osmapitilesize-)
23. [background](#-background-)
24. [z](#-z-)
25. [lat](#-lat-)
26. [lon](#-lon-)
27. [oauth\_token](#-oauth_token-)
28. [layer-public\_bookcase](#-layer-public_bookcase-)
29. [filter-public\_bookcase-kid-books](#-filter-public_bookcase-kid-books-)
30. [filter-public\_bookcase-adult-books](#-filter-public_bookcase-adult-books-)
31. [filter-public\_bookcase-inside](#-filter-public_bookcase-inside-)
32. [filter-public\_bookcase-has\_image](#-filter-public_bookcase-has_image-)
33. [layer-note\_import\_public\_bookcase](#-layer-note_import_public_bookcase-)
34. [mode](#-mode-)
35. [layer-](#-layer-%3Clayer-id%3E-)
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.org/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 separated by `&`, namely:
For example, if the url is `https://mapcomplete.org/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 separated 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
* 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.
The URL-hash can contain multiple values:
* The id of the currently selected object, e.g. `node/1234`
* The currently opened menu view
* The base64-encoded JSON-file specifying a custom theme (only when loading)
- The id of the currently selected object, e.g. `node/1234`
- The currently opened menu view
- The base64-encoded JSON-file specifying a custom theme (only when loading)
### Possible hashes to open a menu
The possible hashes are:
`menu:about`,`menu:settings`,`menu:favourites`,`menu:community`,`menu:privacy`,`menu:advanced`
`theme-menu:intro`,`theme-menu:download`,`theme-menu:copyright`,`theme-menu:share`
language
--------
The language to display MapComplete in. The user display language is determined in the following order:
1. Use the language as set by the URL-parameter `language` (following ISO 639-1 | ex. `language=nl`). This will _disable_ setting the language by the user
2. If the user did log in and did set their language before with MapComplete, use this language. This language selection is synchronized accross devices using the openstreetmap.org user preferences.
3. If the user visited MapComplete before and did change their language manually, this changed language will be saved in local storage. Use the language from local storage
4. Use the navigator-language (if available)
5. Use English
language
----------
Note that this URL-parameter is not added to the URL-bar by default. Note that the _loading_ screen will always use the navigator language.
The language to display MapComplete in.
The user display language is determined in the following order:
1. Use the language as set by the URL-parameter `language` (following ISO 639-1 | ex. `language=nl`). This will _disable_ setting the language by the user
2. If the user did log in and did set their language before with MapComplete, use this language. This language selection is synchronized accross devices using the openstreetmap.org user preferences.
3. If the user visited MapComplete before and did change their language manually, this changed language will be saved in local storage. Use the language from local storage
4. Use the navigator-language (if available)
5. Use English
Note that this URL-parameter is not added to the URL-bar by default.
Note that the _loading_ screen will always use the navigator language.
Translations are never complete. If a translation in a certain language is missing, English is used as fallback.
This documentation is defined in the source code at [Locale.ts](/src/UI/i18n/Locale.ts#L35)
No default value set
No default value set
fs-translation-mode
-------------------
If set, will show a translation button next to every string.
This documentation is defined in the source code at [Locale.ts](/src/UI/i18n/Locale.ts#L79)
fs-translation-mode
---------------------
The default value is _false_
If set, will show a translation button next to every string.
fake-user
---------
This documentation is defined in the source code at [Locale.ts](/src/UI/i18n/Locale.ts#L78)
If true, 'dryrun' mode is activated and a fake user account is loaded
The default value is _false_
fake-user
-----------
If true, 'dryrun' mode is activated and a fake user account is loaded
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L33)
The default value is _false_
The default value is _false_
fs-enable-login
---------------
Disables/Enables logging in and thus disables editing all together. This effectively puts MapComplete into read-only mode.
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L73)
fs-enable-login
-----------------
The default value is _true_
Disables/Enables logging in and thus disables editing all together. This effectively puts MapComplete into read-only mode.
fs-search
---------
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L74)
Disables/Enables the search bar
The default value is _true_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L88)
The default value is _true_
fs-background
-------------
Disables/Enables the background layer control
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L93)
The default value is _true_
fs-filter
---------
Disables/Enables the filter view
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L99)
The default value is _true_
fs-welcome-message
------------------
Disables/enables the help menu or welcome message
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L105)
The default value is _true_
fs-community-index
------------------
Disables/enables the button to get in touch with the community
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L110)
The default value is _true_
fs-iframe-popout
----------------
Disables/Enables the extraLink button. By default, if in iframe mode and the welcome message is hidden, a popout button to the full mapcomplete instance is shown instead (unless disabled with this switch or another extraLink button is enabled)
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L115)
The default value is _true_
fs-more-quests
--------------
Disables/Enables the 'More Quests'-tab in the welcome message
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L120)
The default value is _true_
fs-share-screen
---------------
Disables/Enables the 'Share-screen'-tab in the welcome message
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L125)
The default value is _true_
fs-geolocation
--------------
Disables/Enables the geolocation button
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L130)
The default value is _true_
fs-all-questions
----------------
Always show all questions
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L135)
The default value is _false_
fs-export
---------
Enable the export as GeoJSON and CSV button
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L141)
The default value is _true_
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
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L155)
The default value is _false_
debug
-----
If true, shows some extra debugging help such as all the available tags on every object
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L161)
The default value is _false_
overpassUrl
fs-search
-----------
Point mapcomplete to a different overpass-instance. Example: [https://overpass-api.de/api/interpreter](https://overpass-api.de/api/interpreter)
Disables/Enables the search bar
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L167)
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L89)
The default value is _[https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter](https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter)_
The default value is _true_
overpassTimeout
fs-background
---------------
Set a different timeout (in seconds) for queries in overpass
Disables/Enables the background layer control
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L178)
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L94)
The default value is _30_
The default value is _true_
overpassMaxZoom
---------------
point to switch between OSM-api and overpass
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L186)
fs-filter
-----------
The default value is _16_
Disables/Enables the filter view
osmApiTileSize
--------------
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L100)
Tilesize when the OSM-API is used to fetch data within a BBOX
The default value is _true_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L194)
The default value is _17_
background
----------
fs-welcome-message
--------------------
The id of the background layer to start with
Disables/enables the help menu or welcome message
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L201)
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L106)
No default value set
The default value is _true_
z
-
The initial/current zoom level
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L34)
fs-community-index
--------------------
The default value is _1_
Disables/enables the button to get in touch with the community
lat
---
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L111)
The initial/current latitude
The default value is _true_
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L34)
The default value is _0_
lon
---
fs-iframe-popout
------------------
The initial/current longitude of the app
Disables/Enables the extraLink button. By default, if in iframe mode and the welcome message is hidden, a popout button to the full mapcomplete instance is shown instead (unless disabled with this switch or another extraLink button is enabled)
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L34)
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L116)
The default value is _0_
The default value is _true_
oauth\_token
fs-more-quests
----------------
Disables/Enables the 'More Quests'-tab in the welcome message
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L121)
The default value is _true_
fs-share-screen
-----------------
Disables/Enables the 'Share-screen'-tab in the welcome message
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L126)
The default value is _true_
fs-geolocation
----------------
Disables/Enables the geolocation button
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L131)
The default value is _true_
fs-all-questions
------------------
Always show all questions
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L136)
The default value is _false_
fs-export
-----------
Enable the export as GeoJSON and CSV button
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L142)
The default value is _true_
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
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L156)
The default value is _false_
debug
-------
If true, shows some extra debugging help such as all the available tags on every object
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L162)
The default value is _false_
moreprivacy
-------------
If true, the location distance indication will not be written to the changeset and other privacy enhancing measures might be taken.
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L169)
The default value is _false_
overpassUrl
-------------
Point mapcomplete to a different overpass-instance. Example: https://overpass-api.de/api/interpreter
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L176)
The default value is _https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter_
overpassTimeout
-----------------
Set a different timeout (in seconds) for queries in overpass
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L187)
The default value is _30_
overpassMaxZoom
-----------------
point to switch between OSM-api and overpass
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L195)
The default value is _16_
osmApiTileSize
----------------
Tilesize when the OSM-API is used to fetch data within a BBOX
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L203)
The default value is _17_
background
------------
Used to complete the login
The id of the background layer to start with
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L210)
No default value set
z
---
The initial/current zoom level
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L34)
The default value is _1_
lat
-----
The initial/current latitude
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L34)
The default value is _0_
lon
-----
The initial/current longitude of the app
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L34)
The default value is _0_
oauth_token
-------------
Used to complete the login
This documentation is defined in the source code at [ThemeViewState.ts](/src/Models/ThemeViewState.ts#L171)
No default value set
No default value set
layer-public\_bookcase
----------------------
Whether or not layer public\_bookcase is shown
layer-public_bookcase
-----------------------
Whether or not layer public_bookcase is shown
This documentation is defined in the source code at [FilteredLayer.ts](/src/Models/FilteredLayer.ts#L105)
The default value is _true_
The default value is _true_
filter-public\_bookcase-kid-books
---------------------------------
State of filter kid-books
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
The default value is _false_
filter-public\_bookcase-adult-books
-----------------------------------
State of filter adult-books
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
The default value is _false_
filter-public\_bookcase-inside
------------------------------
State of filter inside
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
The default value is _0_
filter-public\_bookcase-has\_image
filter-public_bookcase-kid-books
----------------------------------
State of filter has\_image
State of filter kid-books
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
The default value is _0_
The default value is _false_
layer-note\_import\_public\_bookcase
filter-public_bookcase-adult-books
------------------------------------
Whether or not layer note\_import\_public\_bookcase is shown
State of filter adult-books
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
The default value is _false_
filter-public_bookcase-inside
-------------------------------
State of filter inside
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
The default value is _0_
filter-public_bookcase-has_image
----------------------------------
State of filter has_image
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
The default value is _0_
layer-note_import_public_bookcase
-----------------------------------
Whether or not layer note_import_public_bookcase is shown
This documentation is defined in the source code at [FilteredLayer.ts](/src/Models/FilteredLayer.ts#L105)
The default value is _true_
The default value is _true_
mode
----
The mode the application starts in, e.g. 'map', 'dashboard' or 'statistics'
This documentation is defined in the source code at [generateDocs.ts](ervdvn/git/MapComplete/scripts/generateDocs.ts#L441)
mode
------
The default value is _map_
The mode the application starts in, e.g. 'map', 'dashboard' or 'statistics'
layer-<layer-id>
----------------
This documentation is defined in the source code at [generateDocs.ts](ervdvn/git2/MapComplete/scripts/generateDocs.ts#L441)
Wether or not the layer with id is shown
The default value is _map_
layer-&lt;layer-id&gt;
------------------------
Wether or not the layer with id <layer-id> is shown
This documentation is defined in the source code at [QueryParameterDocumentation.ts](/src/UI/QueryParameterDocumentation.ts#L59)
The default value is _true_
The default value is _true_
This document is autogenerated from [src/Logic/Web/QueryParameters.ts](https://github.com/pietervdvn/MapComplete/blob/develop/src/Logic/Web/QueryParameters.ts), [src/UI/QueryParameterDocumentation.ts](https://github.com/pietervdvn/MapComplete/blob/develop/src/UI/QueryParameterDocumentation.ts)