forked from MapComplete/MapComplete
		
	Update docs
This commit is contained in:
		
							parent
							
								
									8d52bbc637
								
							
						
					
					
						commit
						af18870bf8
					
				
					 3 changed files with 79 additions and 76 deletions
				
			
		| 
						 | 
				
			
			@ -14,6 +14,14 @@ A string, but allows input of longer strings more comfortably (a text area)
 | 
			
		|||
 | 
			
		||||
A date
 | 
			
		||||
 | 
			
		||||
## direction
 | 
			
		||||
 | 
			
		||||
A geographical direction, in degrees. 0° is north, 90° is east, ... Will return a value between 0 (incl) and 360 (excl)
 | 
			
		||||
 | 
			
		||||
## length
 | 
			
		||||
 | 
			
		||||
A geographical length in meters (rounded at two points). Will give an extra minimap with a measurement tool. Arguments: [ zoomlevel, preferredBackgroundMapType (comma seperated) ], e.g. `["21", "map,photo"]
 | 
			
		||||
 | 
			
		||||
## wikidata
 | 
			
		||||
 | 
			
		||||
A wikidata identifier, e.g. Q42
 | 
			
		||||
| 
						 | 
				
			
			@ -30,10 +38,6 @@ A positive number or zero
 | 
			
		|||
 | 
			
		||||
A strict positive number
 | 
			
		||||
 | 
			
		||||
## direction
 | 
			
		||||
 | 
			
		||||
A geographical direction, in degrees. 0° is north, 90° is east, ... Will return a value between 0 (incl) and 360 (excl)
 | 
			
		||||
 | 
			
		||||
## float
 | 
			
		||||
 | 
			
		||||
A decimal
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -588,6 +588,25 @@
 | 
			
		|||
   "description": "Layer 'Bike stations (repair, pump or both)' shows manometer=broken with a fixed text, namely 'There is manometer but it is broken' and allows to pick this as a default answer (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')",
 | 
			
		||||
   "value": "broken"
 | 
			
		||||
  },
 | 
			
		||||
  {
 | 
			
		||||
   "key": "level",
 | 
			
		||||
   "description": "Layer 'Bike stations (repair, pump or both)' shows and asks freeform values for key 'level' (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')"
 | 
			
		||||
  },
 | 
			
		||||
  {
 | 
			
		||||
   "key": "location",
 | 
			
		||||
   "description": "Layer 'Bike stations (repair, pump or both)' shows location=underground with a fixed text, namely 'Located underground' (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')",
 | 
			
		||||
   "value": "underground"
 | 
			
		||||
  },
 | 
			
		||||
  {
 | 
			
		||||
   "key": "level",
 | 
			
		||||
   "description": "Layer 'Bike stations (repair, pump or both)' shows level=0 with a fixed text, namely 'Located on the ground floor' and allows to pick this as a default answer (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')",
 | 
			
		||||
   "value": "0"
 | 
			
		||||
  },
 | 
			
		||||
  {
 | 
			
		||||
   "key": "level",
 | 
			
		||||
   "description": "Layer 'Bike stations (repair, pump or both)' shows level=1 with a fixed text, namely 'Located on the first floor' and allows to pick this as a default answer (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')",
 | 
			
		||||
   "value": "1"
 | 
			
		||||
  },
 | 
			
		||||
  {
 | 
			
		||||
   "key": "service:bicycle:cleaning:charge",
 | 
			
		||||
   "description": "Layer 'Bike stations (repair, pump or both)' shows and asks freeform values for key 'service:bicycle:cleaning:charge' (in the MapComplete.osm.be theme 'Cyclofix - an open map for cyclists')"
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -20,34 +20,6 @@ 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.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
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_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
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 The default value is _false_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
layout
 | 
			
		||||
--------
 | 
			
		||||
 | 
			
		||||
The layout to load into MapComplete The default value is __
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
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
 | 
			
		||||
- The hash of the URL contains a lz-compressed .json-file, as generated by the custom theme generator
 | 
			
		||||
- 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_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 layer-control-toggle 
 | 
			
		||||
----------------------
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -63,19 +35,19 @@ The tab that is shown in the welcome-message. 0 = the explanation of the theme,1
 | 
			
		|||
 z 
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
The initial/current zoom level The default value is _14_
 | 
			
		||||
 The initial/current zoom level The default value is _0_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 lat 
 | 
			
		||||
-----
 | 
			
		||||
 | 
			
		||||
The initial/current latitude The default value is _51.2095_
 | 
			
		||||
 The initial/current latitude The default value is _0_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 lon 
 | 
			
		||||
-----
 | 
			
		||||
 | 
			
		||||
The initial/current longitude of the app The default value is _3.2228_
 | 
			
		||||
 The initial/current longitude of the app The default value is _0_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 fs-userbadge 
 | 
			
		||||
| 
						 | 
				
			
			@ -144,6 +116,12 @@ fs-export
 | 
			
		|||
 If set, enables the 'download'-button to download everything as geojson The default value is _false_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 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 The default value is _false_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 fake-user 
 | 
			
		||||
-----------
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -156,6 +134,12 @@ 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_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
 custom-css 
 | 
			
		||||
------------
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			@ -168,10 +152,6 @@ background
 | 
			
		|||
 The id of the background layer to start with The default value is _osm_
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
oauth_token
 | 
			
		||||
-------------
 | 
			
		||||
 | 
			
		||||
Used to complete the login No default value set
 | 
			
		||||
 layer-<layer-id> 
 | 
			
		||||
------------------
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue