New formatting of documentation

This commit is contained in:
Pieter Vander Vennet 2024-04-28 03:46:56 +02:00
parent aea9f9b5ed
commit 015b9aebad
263 changed files with 31332 additions and 44633 deletions

View file

@ -1,482 +1,397 @@
[//]: # (WARNING: this file is automatically generated. Please find the sources at the bottom and edit those sources)
URL-parameters and URL-hash
=============================
## Table of contents
1. [URL-parameters and URL-hash](#url-parameters-and-url-hash)
- [What is a URL parameter?](#what-is-a-url-parameter)
- [language](#language)
- [fs-translation-mode](#fs-translation-mode)
- [fake-user](#fake-user)
- [fs-enable-login](#fs-enable-login)
- [fs-search](#fs-search)
- [fs-background](#fs-background)
- [fs-filter](#fs-filter)
- [fs-welcome-message](#fs-welcome-message)
- [fs-community-index](#fs-community-index)
- [fs-iframe-popout](#fs-iframe-popout)
- [fs-more-quests](#fs-more-quests)
- [fs-share-screen](#fs-share-screen)
- [fs-geolocation](#fs-geolocation)
- [fs-all-questions](#fs-all-questions)
- [fs-export](#fs-export)
- [test](#test)
- [debug](#debug)
- [overpassUrl](#overpassurl)
- [overpassTimeout](#overpasstimeout)
- [overpassMaxZoom](#overpassmaxzoom)
- [osmApiTileSize](#osmapitilesize)
- [background](#background)
- [z](#z)
- [lat](#lat)
- [lon](#lon)
- [oauth_token](#oauth_token)
- [layer-public_bookcase](#layer-public_bookcase)
- [filter-public_bookcase-kid-books](#filter-public_bookcase-kid-books)
- [filter-public_bookcase-adult-books](#filter-public_bookcase-adult-books)
- [filter-public_bookcase-inside](#filter-public_bookcase-inside)
- [filter-public_bookcase-has_image](#filter-public_bookcase-has_image)
- [layer-note_import_public_bookcase](#layer-note_import_public_bookcase)
- [mode](#mode)
- [layer-<layer-id>](#layer-&ltlayer-id>)
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-)
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. [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:
- 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
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
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:
language
----------
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
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.
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
-------------------
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#L79)
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#L33)
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#L73)
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#L88)
The default value is _true_
The default value is _true_
fs-background
-------------
fs-background
---------------
Disables/Enables the background layer control
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_
The default value is _true_
fs-filter
---------
fs-filter
-----------
Disables/Enables the filter view
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_
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#L105)
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#L110)
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#L115)
The default value is _true_
The default value is _true_
fs-more-quests
--------------
fs-more-quests
----------------
Disables/Enables the 'More Quests'-tab in the welcome message
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_
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#L125)
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#L130)
The default value is _true_
The default value is _true_
fs-all-questions
----------------
fs-all-questions
------------------
Always show 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_
The default value is _false_
fs-export
---------
fs-export
-----------
Enable the export as GeoJSON and CSV button
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_
The default value is _true_
test
----
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
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_
The default value is _false_
debug
-----
debug
-------
If true, shows some extra debugging help such as all the available tags on every object
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_
The default value is _false_
overpassUrl
-----------
overpassUrl
-------------
Point mapcomplete to a different overpass-instance. Example: https://overpass-api.de/api/interpreter
Point mapcomplete to a different overpass-instance. Example: [https://overpass-api.de/api/interpreter](https://overpass-api.de/api/interpreter)
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L167)
The default value is _https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter_
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)_
overpassTimeout
---------------
overpassTimeout
-----------------
Set a different timeout (in seconds) for queries in overpass
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#L178)
The default value is _30_
The default value is _30_
overpassMaxZoom
---------------
overpassMaxZoom
-----------------
point to switch between OSM-api and overpass
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)
The default value is _16_
The default value is _16_
osmApiTileSize
--------------
osmApiTileSize
----------------
Tilesize when the OSM-API is used to fetch data within a BBOX
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#L194)
The default value is _17_
The default value is _17_
background
----------
background
------------
The id of the background layer to start with
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#L201)
No default value set
No default value set
z
-
The initial/current zoom level
z
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L28)
The default value is _1_
lat
---
The initial/current zoom level
The initial/current latitude
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L28)
The default value is _1_
The default value is _0_
lon
---
lat
-----
The initial/current latitude
The initial/current longitude of the app
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L28)
The default value is _0_
The default value is _0_
oauth\_token
------------
lon
-----
The initial/current longitude of the app
This documentation is defined in the source code at [InitialMapPositioning.ts](/src/Logic/Actors/InitialMapPositioning.ts#L28)
The default value is _0_
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#L171)
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#L105)
The default value is _true_
The default value is _true_
filter-public\_bookcase-kid-books
---------------------------------
filter-public_bookcase-kid-books
----------------------------------
State of filter 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_
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
----------------------------------
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
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'
mode
------
This documentation is defined in the source code at [generateDocs.ts](ervdvn/git/MapComplete/scripts/generateDocs.ts#L441)
The mode the application starts in, e.g. 'map', 'dashboard' or 'statistics'
The default value is _map_
This documentation is defined in the source code at [generateDocs.ts](ervdvn/git/MapComplete/scripts/generateDocs.ts#L422)
layer-<layer-id>
----------------
The default value is _map_
layer-&lt;layer-id&gt;
------------------------
Wether or not the layer with id <layer-id> is shown
Wether or not the layer with 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)