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

Documentation update

Browse source
This commit is contained in:
Pieter Vander Vennet 2021-06-08 17:00:54 +02:00
parent 2383d204d7
commit d86801ebed
2 changed files with 21 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

32
Docs/URL_Parameters.md
View file

@ -18,11 +18,11 @@ the URL-parameters are stated in the part between the `?` and the `#`. There are
Finally, the URL-hash is the part after the `#`. It is `node/1234` in this case.
custom-css
custom-css (broken)
------------
If specified, the custom css from the given link will be loaded additionaly
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
@ -34,7 +34,6 @@ The layout to load into MapComplete
userlayout
------------
If not 'false', a custom (non-official) theme is loaded. This custom layout can be done in multiple ways:
- The hash of the URL contains a base64-encoded .json-file containing the theme definition
@ -42,8 +41,6 @@ If not 'false', a custom (non-official) theme is loaded. This custom layout can
- The parameter itself is an URL, in which case that URL will be downloaded. It should point to a .json of a theme
The default value is _false_
The default value is _false_
layer-control-toggle
----------------------
Whether or not the layer control is shown
@ -57,17 +54,17 @@ The default value is _0_
z
---
The initial/current zoom level
The default value is set by the loaded theme
The default value is set by the theme
lat
-----
The initial/current latitude
The default value is set by the loaded theme
The default value is set by the theme
lon
-----
The initial/current longitude of the app
The default value is set by the loaded theme
The default value is set by the theme
fs-userbadge
--------------
@ -114,11 +111,21 @@ fs-geolocation
Disables/Enables the geolocation button
The default value is _true_
fs-all-questions
------------------
Always show all questions
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_
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_
oauth_token
-------------
Used to complete the login
@ -127,10 +134,9 @@ No default value set
background
------------
The id of the background layer to start with
The default value is set by the loaded theme
The default value is _OSM_ (overridden by the theme)
layer-<layer-id>
-----------------
Wether or not layer with _<layer-id>_ is shown
layer-<layerid>
--------------
Wether or not layer with layer-id is shown
The default value is _true_

4
State.ts
View file

@ -210,8 +210,8 @@ export default class State {
"If true, shows some extra debugging help such as all the available tags on every object")
.map(str => str === "true", [], b => "" + b)
this.featureSwitchApiURL = QueryParameters.GetQueryParameter("backend","https://openstreetmap.org",
"The OSM backend to use - can be used to redirect mapcomplete to a testing backend or e.g. openHistoricalMap")
this.featureSwitchApiURL = QueryParameters.GetQueryParameter("backend","osm",
"The OSM backend to use - can be used to redirect mapcomplete to the testing backend when using 'osm-test'")
}