Robin-van-der-Linde/MapComplete
1
0
Fork 0
forked from MapComplete/MapComplete
Code Pull requests Activity

Regenerate documentation

Browse source
This commit is contained in:
pietervdvn 2021-12-03 02:30:25 +01:00
parent ea5bc7cbf4
commit 51459d6fe2
20 changed files with 108 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

44
Docs/BuiltinLayers.md
View file

@ -14,6 +14,7 @@
+ [type_node](#type_node)
+ [conflation](#conflation)
+ [left_right_style](#left_right_style)
+ [split_point](#split_point)
1. [Frequently reused layers](#frequently-reused-layers)
+ [bicycle_library](#bicycle_library)
* [Themes using this layer](#themes-using-this-layer)
@ -23,6 +24,8 @@
* [Themes using this layer](#themes-using-this-layer)
+ [map](#map)
* [Themes using this layer](#themes-using-this-layer)
+ [walls_and_buildings](#walls_and_buildings)
* [Themes using this layer](#themes-using-this-layer)
+ [all_streets](#all_streets)
* [Themes using this layer](#themes-using-this-layer)
@ -40,6 +43,7 @@
- [type_node](#type_node)
- [conflation](#conflation)
- [left_right_style](#left_right_style)
- [split_point](#split_point)
### gps_location
@ -138,6 +142,19 @@ Special meta-style which will show one single line, either on the left or on the
- This layer can **not** be included in a theme. It is solely used by [special renderings](SpecialRenderings.md) showing a minimap with custom data.
### split_point
Layer rendering the little scissors for the minimap in the 'splitRoadWizard'
[Go to the source code](../assets/layers/split_point/split_point.json)
- This layer can **not** be included in a theme. It is solely used by [special renderings](SpecialRenderings.md) showing a minimap with custom data.
@ -150,6 +167,7 @@ Special meta-style which will show one single line, either on the left or on the
- [drinking_water](#drinking_water)
- [food](#food)
- [map](#map)
- [walls_and_buildings](#walls_and_buildings)
- [all_streets](#all_streets)
@ -250,6 +268,32 @@ A map, meant for tourists which is permanently installed in the public space
- [nature](https://mapcomplete.osm.be/nature)
### walls_and_buildings
Special builtin layer providing all walls and buildings. This layer is useful in presets for objects which can be placed against walls (e.g. AEDs, postboxes, entrances, addresses, surveillance cameras, ...). This layer is invisible by default and not toggleable by the user.
[Go to the source code](../assets/layers/walls_and_buildings/walls_and_buildings.json)
- Not visible in the layer selection by default. If you want to make this layer toggable, override `name`
- Not rendered on the map by default. If you want to rendering this on the map, override `mapRenderings`
#### Themes using this layer
- [aed](https://mapcomplete.osm.be/aed)
- [surveillance](https://mapcomplete.osm.be/surveillance)
### all_streets

6
Docs/Schemas/LayerConfigJson.schema.json
View file

@ -114,6 +114,10 @@
"description": "The minimum needed zoomlevel required before loading of the data start\nDefault: 0",
"type": "number"
},
"shownByDefault": {
"description": "Indicates if this layer is shown by default;\ncan be used to hide a layer from start, or to load the layer but only to show it where appropriate (e.g. for snapping to it)",
"type": "boolean"
},
"minzoomVisible": {
"description": "The zoom level at which point the data is hidden again\nDefault: 100 (thus: always visible",
"type": "number"
@ -442,7 +446,7 @@
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

6
Docs/Schemas/LayerConfigJsonJSC.ts
View file

@ -114,6 +114,10 @@ export default {
"description": "The minimum needed zoomlevel required before loading of the data start\nDefault: 0",
"type": "number"
},
"shownByDefault": {
"description": "Indicates if this layer is shown by default;\ncan be used to hide a layer from start, or to load the layer but only to show it where appropriate (e.g. for snapping to it)",
"type": "boolean"
},
"minzoomVisible": {
"description": "The zoom level at which point the data is hidden again\nDefault: 100 (thus: always visible",
"type": "number"
@ -440,7 +444,7 @@ export default {
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

6
Docs/Schemas/LayoutConfigJson.schema.json
View file

@ -348,7 +348,7 @@
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {
@ -955,6 +955,10 @@
"description": "The minimum needed zoomlevel required before loading of the data start\nDefault: 0",
"type": "number"
},
"shownByDefault": {
"description": "Indicates if this layer is shown by default;\ncan be used to hide a layer from start, or to load the layer but only to show it where appropriate (e.g. for snapping to it)",
"type": "boolean"
},
"minzoomVisible": {
"description": "The zoom level at which point the data is hidden again\nDefault: 100 (thus: always visible",
"type": "number"

6
Docs/Schemas/LayoutConfigJsonJSC.ts
View file

@ -346,7 +346,7 @@ export default {
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {
@ -945,6 +945,10 @@ export default {
"description": "The minimum needed zoomlevel required before loading of the data start\nDefault: 0",
"type": "number"
},
"shownByDefault": {
"description": "Indicates if this layer is shown by default;\ncan be used to hide a layer from start, or to load the layer but only to show it where appropriate (e.g. for snapping to it)",
"type": "boolean"
},
"minzoomVisible": {
"description": "The zoom level at which point the data is hidden again\nDefault: 100 (thus: always visible",
"type": "number"

2
Docs/Schemas/LineRenderingConfigJson.schema.json
View file

@ -160,7 +160,7 @@
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

2
Docs/Schemas/LineRenderingConfigJsonJSC.ts
View file

@ -158,7 +158,7 @@ export default {
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

2
Docs/Schemas/PointRenderingConfigJson.schema.json
View file

@ -172,7 +172,7 @@
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

2
Docs/Schemas/PointRenderingConfigJsonJSC.ts
View file

@ -170,7 +170,7 @@ export default {
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

2
Docs/Schemas/TagRenderingConfigJson.schema.json
View file

@ -3,7 +3,7 @@
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

2
Docs/Schemas/TagRenderingConfigJsonJSC.ts
View file

@ -3,7 +3,7 @@ export default {
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

2
Docs/Schemas/TilesourceConfigJson.schema.json
View file

@ -111,7 +111,7 @@
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

2
Docs/Schemas/TilesourceConfigJsonJSC.ts
View file

@ -109,7 +109,7 @@ export default {
"type": "object",
"properties": {
"id": {
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise",
"description": "The id of the tagrendering, should be an unique string.\nUsed to keep the translations in sync. Only used in the tagRenderings-array of a layerConfig, not requered otherwise.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
"type": "string"
},
"group": {

2
Docs/TagInfo/mapcomplete_aed.json
View file

@ -87,7 +87,7 @@
},
{
"key": "defibrillator",
"description": "Layer 'Defibrillators' shows defibrillator~^$ with a fixed text, namely 'This is a special type of defibrillator: {defibrillator}' (in the MapComplete.osm.be theme 'Open AED Map')"
"description": "Layer 'Defibrillators' shows defibrillator~^..*$ with a fixed text, namely 'This is a special type of defibrillator: {defibrillator}' (in the MapComplete.osm.be theme 'Open AED Map')"
},
{
"key": "level",

15
assets/layers/defibrillator/defibrillator.json
View file

@ -42,11 +42,22 @@
"it": "Defibrillatore",
"ru": "Дефибриллятор"
},
"tags": [
"emergency=defibrillator"
]
},
{
"title": {
"en": "defibrillator mounted on a wall",
"nl": "defibrillator die aan een muur hangt"
},
"tags": [
"emergency=defibrillator"
],
"preciseInput": {
"preferredBackground": "map"
"preferredBackground": "map",
"snapToLayer": "walls_and_buildings",
"maxSnapDistance": 5
}
}
],
@ -228,7 +239,7 @@
}
},
{
"if": "defibrillator~",
"if": "defibrillator~*",
"then": {
"en": "This is a special type of defibrillator: {defibrillator}"
},

2
assets/layers/split_point/split_point.json
View file

@ -13,7 +13,7 @@
"point",
"centroid"
],
"icon": "circle:white;./assets/svg/scissors.svg",
"icon": "circle:white;./assets/svg/scissors.svg",
"iconSize": "30,30,center"
}
]

17
assets/layers/surveillance_camera/surveillance_camera.json
View file

@ -459,7 +459,22 @@
"man_made=surveillance",
"surveillance:type=camera"
],
"title": "Surveillance camera"
"title": {
"en":"surveillance camera"
}
},
{
"tags": [
"man_made=surveillance",
"surveillance:type=camera",
"camera:mount=wall"
],
"title": {
"en":"surveillance camera mounted on a wall"
},
"preciseInput": {
"snapToLayer": "walls_and_buildings"
}
}
],
"mapRendering": [

1
assets/themes/aed/aed.json
View file

@ -60,6 +60,7 @@
"startLon": 0,
"startZoom": 12,
"layers": [
"walls_and_buildings",
"defibrillator"
]
}

4
assets/themes/aed/aed_brugge.json
View file

@ -16,6 +16,7 @@
"startLon": 3.195682,
"startZoom": 12,
"layers": [
"walls_and_buildings",
"defibrillator",
{
"id": "Brugge",
@ -80,7 +81,8 @@
},
"iconSize": "20,20,center",
"location": [
"point","centroid"
"point",
"centroid"
]
}
]

1
assets/themes/surveillance/surveillance.json
View file

@ -49,6 +49,7 @@
"socialImage": "",
"defaultBackgroundId": "osm",
"layers": [
"walls_and_buildings",
"direction",
"surveillance_camera"
]