forked from MapComplete/MapComplete
Docs: fix multiline issues in docs
This commit is contained in:
parent
0c4d81916f
commit
d875dffe1c
284 changed files with 484 additions and 19532 deletions
|
|
@ -54,37 +54,25 @@ This document gives an overview of which URL-parameters can be used to influence
|
|||
|
||||
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)
|
||||
|
||||
|
||||
|
||||
### 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`
|
||||
|
|
@ -107,8 +95,6 @@ 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#L53)
|
||||
|
||||
|
||||
|
||||
No default value set
|
||||
|
||||
## fs-translation-mode
|
||||
|
|
@ -117,8 +103,6 @@ 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#L92)
|
||||
|
||||
|
||||
|
||||
The default value is _false_
|
||||
|
||||
## fake-user
|
||||
|
|
@ -127,8 +111,6 @@ 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#L40)
|
||||
|
||||
|
||||
|
||||
The default value is _false_
|
||||
|
||||
## fs-enable-login
|
||||
|
|
@ -137,8 +119,6 @@ Disables/Enables logging in and thus disables editing all together. This effecti
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L104)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-search
|
||||
|
|
@ -147,8 +127,6 @@ Disables/Enables the search bar
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L119)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-background
|
||||
|
|
@ -157,8 +135,6 @@ Disables/Enables the background layer control where a user can enable e.g. aeria
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L124)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-filter
|
||||
|
|
@ -167,8 +143,6 @@ Disables/Enables the filter view where a user can enable/disable MapComplete-lay
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L130)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-welcome-message
|
||||
|
|
@ -177,8 +151,6 @@ Disables/enables the help menu or welcome message
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L136)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-community-index
|
||||
|
|
@ -187,8 +159,6 @@ 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#L141)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-iframe-popout
|
||||
|
|
@ -197,8 +167,6 @@ Disables/Enables the extraLink button. By default, if in iframe mode and the wel
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L146)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-homepage-link
|
||||
|
|
@ -207,8 +175,6 @@ Disables/Enables the various links which go back to the index page with the them
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L151)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-share-screen
|
||||
|
|
@ -217,8 +183,6 @@ 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#L156)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-geolocation
|
||||
|
|
@ -227,8 +191,6 @@ Disables/Enables the geolocation button
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L161)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-layers-enabled
|
||||
|
|
@ -237,8 +199,6 @@ If set to false, all layers will be disabled - except the explicitly enabled lay
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L167)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-all-questions
|
||||
|
|
@ -247,8 +207,6 @@ Always show all questions
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L172)
|
||||
|
||||
|
||||
|
||||
The default value is _false_
|
||||
|
||||
## fs-export
|
||||
|
|
@ -257,8 +215,6 @@ Enable the export as GeoJSON and CSV button
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L178)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## fs-cache
|
||||
|
|
@ -267,8 +223,6 @@ Enable/disable caching from localStorage
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L184)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
## test
|
||||
|
|
@ -277,8 +231,6 @@ If true, 'dryrun' mode is activated. The app will behave as normal, except that
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L199)
|
||||
|
||||
|
||||
|
||||
The default value is _false_
|
||||
|
||||
## debug
|
||||
|
|
@ -287,8 +239,6 @@ If true, shows some extra debugging help such as all the available tags on every
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L205)
|
||||
|
||||
|
||||
|
||||
The default value is _false_
|
||||
|
||||
## moreprivacy
|
||||
|
|
@ -297,8 +247,6 @@ If true, the location distance indication will not be written to the changeset a
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L211)
|
||||
|
||||
|
||||
|
||||
The default value is _false_
|
||||
|
||||
## overpassUrl
|
||||
|
|
@ -307,8 +255,6 @@ Point mapcomplete to a different overpass-instance. Example: https://overpass-ap
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L217)
|
||||
|
||||
|
||||
|
||||
The default value is _https://overpass-api.de/api/interpreter,https://overpass.kumi.systems/api/interpreter,https://overpass.openstreetmap.ru/cgi/interpreter_
|
||||
|
||||
## overpassTimeout
|
||||
|
|
@ -317,8 +263,6 @@ 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#L228)
|
||||
|
||||
|
||||
|
||||
The default value is _30_
|
||||
|
||||
## overpassMaxZoom
|
||||
|
|
@ -327,8 +271,6 @@ The default value is _30_
|
|||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L236)
|
||||
|
||||
|
||||
|
||||
The default value is _16_
|
||||
|
||||
## osmApiTileSize
|
||||
|
|
@ -337,8 +279,6 @@ 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#L244)
|
||||
|
||||
|
||||
|
||||
The default value is _17_
|
||||
|
||||
## background
|
||||
|
|
@ -364,8 +304,6 @@ If one of the following values is used, this parameter will be interpreted as a
|
|||
|
||||
One can use the [ID of an ELI-layer](./ELI-overview.md) or use one of the global, builtin layers:
|
||||
|
||||
|
||||
|
||||
- protomaps.sunny ⭐
|
||||
- protomaps.white
|
||||
- protomaps.light
|
||||
|
|
@ -389,12 +327,8 @@ One can use the [ID of an ELI-layer](./ELI-overview.md) or use one of the global
|
|||
- carto.dark_matter_no_labels
|
||||
- carto.voyager_no_labels
|
||||
|
||||
|
||||
|
||||
This documentation is defined in the source code at [FeatureSwitchState.ts](/src/Logic/State/FeatureSwitchState.ts#L251)
|
||||
|
||||
|
||||
|
||||
No default value set
|
||||
|
||||
## z
|
||||
|
|
@ -403,8 +337,6 @@ 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_
|
||||
|
||||
## lat
|
||||
|
|
@ -413,8 +345,6 @@ 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_
|
||||
|
||||
## lon
|
||||
|
|
@ -423,8 +353,6 @@ 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_
|
||||
|
||||
## oauth_token
|
||||
|
|
@ -433,8 +361,6 @@ Used to complete the login
|
|||
|
||||
This documentation is defined in the source code at [ThemeViewState.ts](/src/Models/ThemeViewState.ts#L177)
|
||||
|
||||
|
||||
|
||||
No default value set
|
||||
|
||||
## layer-public_bookcase
|
||||
|
|
@ -443,8 +369,6 @@ 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_
|
||||
|
||||
## filter-public_bookcase-kid-books
|
||||
|
|
@ -453,8 +377,6 @@ State of filter kid-books
|
|||
|
||||
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L167)
|
||||
|
||||
|
||||
|
||||
The default value is _false_
|
||||
|
||||
## filter-public_bookcase-adult-books
|
||||
|
|
@ -463,8 +385,6 @@ State of filter adult-books
|
|||
|
||||
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L167)
|
||||
|
||||
|
||||
|
||||
The default value is _false_
|
||||
|
||||
## filter-public_bookcase-inside
|
||||
|
|
@ -473,8 +393,6 @@ State of filter inside
|
|||
|
||||
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L167)
|
||||
|
||||
|
||||
|
||||
The default value is _0_
|
||||
|
||||
## filter-public_bookcase-has_image
|
||||
|
|
@ -483,8 +401,6 @@ State of filter has_image
|
|||
|
||||
This documentation is defined in the source code at [FilterConfig.ts](/src/Models/ThemeConfig/FilterConfig.ts#L167)
|
||||
|
||||
|
||||
|
||||
The default value is _0_
|
||||
|
||||
## layer-note_import_public_bookcase
|
||||
|
|
@ -493,8 +409,6 @@ 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_
|
||||
|
||||
## mode
|
||||
|
|
@ -503,8 +417,6 @@ 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#L434)
|
||||
|
||||
|
||||
|
||||
The default value is _map_
|
||||
|
||||
## layer-<layer-id>
|
||||
|
|
@ -513,8 +425,6 @@ Whether the layer with id <layer-id> is shown
|
|||
|
||||
This documentation is defined in the source code at [QueryParameterDocumentation.ts](/src/UI/QueryParameterDocumentation.ts#L58)
|
||||
|
||||
|
||||
|
||||
The default value is _true_
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue