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-07-12 03:16:41 +02:00
parent e51bc34749
commit 7a7439b161
266 changed files with 8503 additions and 14470 deletions
Download patch file Download diff file Expand all files Collapse all files

412
Docs/URL_Parameters.md
View file

@ -1,72 +1,59 @@
[//]: # (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-)
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-homepage-link ](#-fs-homepage-link-)
13. [ fs-share-screen ](#-fs-share-screen-)
14. [ fs-geolocation ](#-fs-geolocation-)
15. [ fs-layers-enabled ](#-fs-layers-enabled-)
16. [ fs-all-questions ](#-fs-all-questions-)
17. [ fs-export ](#-fs-export-)
18. [ test ](#-test-)
19. [ debug ](#-debug-)
20. [ moreprivacy ](#-moreprivacy-)
21. [ overpassUrl ](#-overpassurl-)
22. [ overpassTimeout ](#-overpasstimeout-)
23. [ overpassMaxZoom ](#-overpassmaxzoom-)
24. [ osmApiTileSize ](#-osmapitilesize-)
25. [ background ](#-background-)
26. [ z ](#-z-)
27. [ lat ](#-lat-)
28. [ lon ](#-lon-)
29. [ oauth_token ](#-oauth_token-)
30. [ layer-public_bookcase ](#-layer-public_bookcase-)
31. [ filter-public_bookcase-kid-books ](#-filter-public_bookcase-kid-books-)
32. [ filter-public_bookcase-adult-books ](#-filter-public_bookcase-adult-books-)
33. [ filter-public_bookcase-inside ](#-filter-public_bookcase-inside-)
34. [ filter-public_bookcase-has_image ](#-filter-public_bookcase-has_image-)
35. [ layer-note_import_public_bookcase ](#-layer-note_import_public_bookcase-)
36. [ mode ](#-mode-)
37. [ 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-homepage-link](#fs-homepage-link)
13. [fs-share-screen](#fs-share-screen)
14. [fs-geolocation](#fs-geolocation)
15. [fs-layers-enabled](#fs-layers-enabled)
16. [fs-all-questions](#fs-all-questions)
17. [fs-export](#fs-export)
18. [test](#test)
19. [debug](#debug)
20. [moreprivacy](#moreprivacy)
21. [overpassUrl](#overpassurl)
22. [overpassTimeout](#overpasstimeout)
23. [overpassMaxZoom](#overpassmaxzoom)
24. [osmApiTileSize](#osmapitilesize)
25. [background](#background)
26. [z](#z)
27. [lat](#lat)
28. [lon](#lon)
29. [oauth_token](#oauth_token)
30. [layer-public_bookcase](#layer-public_bookcase)
31. [filter-public_bookcase-kid-books](#filter-public_bookcase-kid-books)
32. [filter-public_bookcase-adult-books](#filter-public_bookcase-adult-books)
33. [filter-public_bookcase-inside](#filter-public_bookcase-inside)
34. [filter-public_bookcase-has_image](#filter-public_bookcase-has_image)
35. [layer-note_import_public_bookcase](#layer-note_import_public_bookcase)
36. [mode](#mode)
37. [layer-<layer-id>](#layer-<layer-id>)
## 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:
- 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.
@ -94,12 +81,9 @@ The possible hashes are:
`theme-menu:intro`,`theme-menu:download`,`theme-menu:copyright`,`theme-menu:share`
## language
language
----------
The language to display MapComplete in.
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
@ -115,391 +99,359 @@ Translations are never complete. If a translation in a certain language is missi
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
---------------------
## fs-translation-mode
If set, will show a translation button next to every string.
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#L78)
The default value is _false_
The default value is _false_
fake-user
-----------
## fake-user
If true, 'dryrun' mode is activated and a fake user account is loaded
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#L37)
The default value is _false_
The default value is _false_
fs-enable-login
-----------------
## fs-enable-login
Disables/Enables logging in and thus disables editing all together. This effectively puts MapComplete into read-only mode.
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#L99)
The default value is _true_
The default value is _true_
fs-search
-----------
## fs-search
Disables/Enables the search bar
Disables/Enables the search bar
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L114)
The default value is _true_
The default value is _true_
fs-background
---------------
## fs-background
Disables/Enables the background layer control where a user can enable e.g. aerial imagery
Disables/Enables the background layer control where a user can enable e.g. aerial imagery
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L119)
The default value is _true_
The default value is _true_
fs-filter
-----------
## fs-filter
Disables/Enables the filter view where a user can enable/disable MapComplete-layers or filter for certain properties
Disables/Enables the filter view where a user can enable/disable MapComplete-layers or filter for certain properties
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L125)
The default value is _true_
The default value is _true_
fs-welcome-message
--------------------
## fs-welcome-message
Disables/enables the help menu or 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#L131)
The default value is _true_
The default value is _true_
fs-community-index
--------------------
## fs-community-index
Disables/enables the button to get in touch with the community
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#L136)
The default value is _true_
The default value is _true_
fs-iframe-popout
------------------
## 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)
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#L141)
The default value is _true_
The default value is _true_
fs-homepage-link
------------------
## fs-homepage-link
Disables/Enables the various links which go back to the index page with the theme overview
Disables/Enables the various links which go back to the index page with the theme overview
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L146)
The default value is _true_
The default value is _true_
fs-share-screen
-----------------
## fs-share-screen
Disables/Enables the 'Share-screen'-tab in the welcome message
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#L151)
The default value is _true_
The default value is _true_
fs-geolocation
----------------
## fs-geolocation
Disables/Enables the geolocation button
Disables/Enables the geolocation button
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L156)
The default value is _true_
The default value is _true_
fs-layers-enabled
-------------------
## fs-layers-enabled
If set to false, all layers will be disabled - except the explicitly enabled layers
If set to false, all layers will be disabled - except the explicitly enabled layers
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L162)
The default value is _true_
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#L167)
fs-all-questions
------------------
The default value is _false_
Always show all questions
## fs-export
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L165)
Enable the export as GeoJSON and CSV button
The default value is _false_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L173)
fs-export
-----------
The default value is _true_
Enable the export as GeoJSON and CSV button
## test
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L171)
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 _true_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L187)
test
------
The default value is _false_
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
## debug
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L185)
If true, shows some extra debugging help such as all the available tags on every object
The default value is _false_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L193)
debug
-------
The default value is _false_
If true, shows some extra debugging help such as all the available tags on every object
## moreprivacy
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L191)
If true, the location distance indication will not be written to the changeset and other privacy enhancing measures might be taken.
The default value is _false_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L199)
moreprivacy
-------------
The default value is _false_
If true, the location distance indication will not be written to the changeset and other privacy enhancing measures might be taken.
## overpassUrl
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L197)
Point mapcomplete to a different overpass-instance. Example: https://overpass-api.de/api/interpreter
The default value is _false_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L205)
overpassUrl
-------------
The default value is _https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter_
Point mapcomplete to a different overpass-instance. Example: https://overpass-api.de/api/interpreter
## overpassTimeout
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L203)
Set a different timeout (in seconds) for queries in overpass
The default value is _https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L216)
overpassTimeout
-----------------
The default value is _30_
Set a different timeout (in seconds) for queries in overpass
## overpassMaxZoom
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L214)
point to switch between OSM-api and overpass
The default value is _30_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L224)
overpassMaxZoom
-----------------
The default value is _16_
point to switch between OSM-api and overpass
## osmApiTileSize
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L222)
Tilesize when the OSM-API is used to fetch data within a BBOX
The default value is _16_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L232)
osmApiTileSize
----------------
The default value is _17_
Tilesize when the OSM-API is used to fetch data within a BBOX
## background
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L230)
The id of the background layer to start with
The default value is _17_
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L239)
background
------------
No default value set
The id of the background layer to start with
## z
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L237)
No default value set
z
---
The initial/current zoom level
The initial/current zoom level
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L37)
The default value is _1_
The default value is _1_
lat
-----
## lat
The initial/current latitude
The initial/current latitude
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L37)
The default value is _0_
The default value is _0_
lon
-----
## lon
The initial/current longitude of the app
The initial/current longitude of the app
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L37)
The default value is _0_
The default value is _0_
oauth_token
-------------
## oauth_token
Used to complete the login
Used to complete the login
This documentation is defined in the source code at [ThemeViewState.ts](/src/Models/ThemeViewState.ts#L174)
No default value set
No default value set
layer-public_bookcase
-----------------------
## layer-public_bookcase
Whether or not layer public_bookcase is shown
Whether or not layer public_bookcase is shown
This documentation is defined in the source code at [FilteredLayer.ts](/src/Models/FilteredLayer.ts#L110)
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#L162)
filter-public_bookcase-kid-books
----------------------------------
The default value is _false_
State of filter kid-books
## filter-public_bookcase-adult-books
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
State of filter adult-books
The default value is _false_
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L162)
filter-public_bookcase-adult-books
------------------------------------
The default value is _false_
State of filter adult-books
## filter-public_bookcase-inside
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
State of filter inside
The default value is _false_
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L162)
filter-public_bookcase-inside
-------------------------------
The default value is _0_
State of filter inside
## filter-public_bookcase-has_image
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L161)
State of filter has_image
The default value is _0_
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L162)
filter-public_bookcase-has_image
----------------------------------
The default value is _0_
State of filter has_image
## layer-note_import_public_bookcase
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
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#L110)
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/git2/MapComplete/scripts/generateDocs.ts#L420)
mode
------
The default value is _map_
The mode the application starts in, e.g. 'map', 'dashboard' or 'statistics'
## layer-&lt;layer-id&gt;
This documentation is defined in the source code at [generateDocs.ts](ervdvn/git2/MapComplete/scripts/generateDocs.ts#L439)
Wether or not the layer with id <layer-id> is shown
The default value is _map_
This documentation is defined in the source code at [QueryParameterDocumentation.ts](/src/UI/QueryParameterDocumentation.ts#L60)
layer-&lt;layer-id&gt;
------------------------
The default value is _true_
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_
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)