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

Merge pull request #786 from tordans/fix-theme-template

Browse source 
Fix validation issues with the theme-template
This commit is contained in:
Pieter Vander Vennet 2022-04-29 09:53:25 +02:00 • committed by GitHub
commit 68c6b6b090
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

48
Docs/theme-template.json
View file

@ -1,16 +1,16 @@
{ {
"#": "This JSON file is a small template to get you started developing a theme", "#1": "This JSON file is a small template to get you started developing a theme",
"#": "All lines starting with '#' are comments and can be removed in the theme if you don't need the explanation anymore", "#2": "All lines starting with '#' are comments and can be removed in the theme if you don't need the explanation anymore",
"#": "Make sure to join our chat channel at https://app.element.io/#/room/#MapComplete:matrix.org for questions, sharing your theme, ...", "#3": "Make sure to join our chat channel at https://app.element.io/#/room/#MapComplete:matrix.org for questions, sharing your theme, ...",
"#": "To actually load your theme: on linux: run a local webserver (e.g. `webfsd`) and go to https://mapcomplete.osm.be/theme?userlayout=http://127.0.0.1:8080/path-to-your-theme.json", "#4": "To actually load your theme: on linux: run a local webserver (e.g. `webfsd`) and go to https://mapcomplete.osm.be/theme?userlayout=http://127.0.0.1:8080/path-to-your-theme.json",
"#": "If you don't know how to run a webserver: go to https://www.base64encode.org/ , copy paste this entire document in the 'encode' field and encode it;", "#5": "If you don't know how to run a webserver: go to https://www.base64encode.org/ , copy paste this entire document in the 'encode' field and encode it;",
"#": "Then, go to https://mapcomplete.osm.be/theme?userlayout=true#your-base64-encoded-file", "#6": "Then, go to https://mapcomplete.osm.be/theme?userlayout=true#your-base64-encoded-file",
"id": "template", "id": "template",
"maintainer": "Write your name here", "maintainer": "Write your name here",
"version": "2022-03-12", "version": "2022-03-12",
"title": { "title": {
"en": "Title of your theme", "en": "Title of your theme",
"#": "You can add extra languages here (and in all translation blocks), but make sure 'en' is everywhere" "#1": "You can add extra languages here (and in all translation blocks), but make sure 'en' is everywhere"
}, },
"description": { "description": {
"en": "The welcome message goes here" "en": "The welcome message goes here"
@ -19,14 +19,14 @@
"startZoom": 0, "startZoom": 0,
"startLat": 0, "startLat": 0,
"startLon": 0, "startLon": 0,
"#": "For more options and configuration, see the documentation in LayoutConfig.json", "#7": "For more options and configuration, see the documentation in LayoutConfig.json",
"#layers": "The list of layers is where most of the content will be. Either reuse an already existing layer by simply calling it's ID or define a whole new layer. An overview of builtin layers is at https://github.com/pietervdvn/MapComplete/blob/develop/Docs/BuiltinLayers.md#normal-layers", "#8": "`layers` is where most of the content will be. Either reuse an already existing layer by simply calling it's ID or define a whole new layer. An overview of builtin layers is at https://github.com/pietervdvn/MapComplete/blob/develop/Docs/BuiltinLayers.md#normal-layers",
"layers": [ "layers": [
{ {
"id": "a singular noun describing the feature, in english", "id": "a singular noun describing the feature, in english",
"source": { "source": {
"osmTags": { "osmTags": {
"#": "For a description on which tags are possible, see https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md", "#1": "For a description on which tags are possible, see https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md",
"and": [ "and": [
"key0=value0", "key0=value0",
"key1=value1", "key1=value1",
@ -41,7 +41,7 @@
] ]
} }
}, },
"#": "Minzoom: only download and show if zoom >= minzoom", "#4": "Minzoom: only download and show if zoom >= minzoom",
"minzoom": 12, "minzoom": 12,
"name": { "name": {
"en": "Name of the layer, as shown in the layer selection" "en": "Name of the layer, as shown in the layer selection"
@ -54,12 +54,12 @@
{ {
"if": "name~*", "if": "name~*",
"then": { "then": {
"#": "If name is given, use name instead as popup title. Note that the translation here uses '*' instead of 'en', which'll be shown in every language", "#1": "If name is given, use name instead as popup title. Note that the translation here uses '*' instead of 'en', which'll be shown in every language",
"*": "{name}" "*": "{name}"
} }
} }
], ],
"#": "Note that this is a tagRendering, but doesn't have a question field" "#1": "Note that this is a tagRendering, but doesn't have a question field"
}, },
"allowMove": true, "allowMove": true,
"deletion": { "deletion": {
@ -67,17 +67,17 @@
"disused:key:={key}" "disused:key:={key}"
] ]
}, },
"#": "The maprenderings describe how a feature is shown on the map", "#2": "The maprenderings describe how a feature is shown on the map",
"mapRendering": [ "mapRendering": [
{ {
"#": "Rendering block of a mapping which is shown for points AND at the center point of a line/area", "#1": "Rendering block of a mapping which is shown for points AND at the center point of a line/area",
"location": [ "location": [
"point", "point",
"centroid" "centroid"
], ],
"icon": "circle:white;URL or path to icon.svg", "icon": "circle:white;URL or path to icon.svg",
"iconSize": "30,30,center" "iconSize": "30,30,center",
"#": "Note: all these values can be tagrenderings too, e.g.:", "#2": "Note: all these values can be tagrenderings too, e.g.:",
"label": { "label": {
"render": { "render": {
"en": "Item" "en": "Item"
@ -93,12 +93,12 @@
} }
}, },
{ {
"#": "Rendering of a line", "#1": "Rendering of a line",
"color": "#ff0", "color": "#ff0",
"width": 5 "width": 5
} }
], ],
"#": "Presets describe which new items can be added on click. Delete this block if adding a new point is not relevant", "#3": "Presets describe which new items can be added on click. Delete this block if adding a new point is not relevant",
"presets": [ "presets": [
{ {
"title": { "title": {
@ -116,7 +116,7 @@
] ]
} }
], ],
"#": "The tagrenderings are everything that must be shown and/or asked. Use a full tag-rendering section OR a single string to call a builtin tagrendering (see https://github.com/pietervdvn/MapComplete/blob/develop/Docs/BuiltinQuestions.md)", "#1": "The tagrenderings are everything that must be shown and/or asked. Use a full tag-rendering section OR a single string to call a builtin tagrendering (see https://github.com/pietervdvn/MapComplete/blob/develop/Docs/BuiltinQuestions.md)",
"tagRenderings": [ "tagRenderings": [
{ {
"render": { "render": {
@ -143,7 +143,7 @@
}, },
"freeform": { "freeform": {
"key": "some_osm_key", "key": "some_osm_key",
"#": "Types can be found at https://github.com/pietervdvn/MapComplete/blob/develop/Docs/SpecialInputElements.md", "#1": "Types can be found at https://github.com/pietervdvn/MapComplete/blob/develop/Docs/SpecialInputElements.md",
"type": "nat" "type": "nat"
}, },
"mappings": [ "mappings": [
@ -152,7 +152,7 @@
"then": { "then": {
"en": "Text on radio button which also is shown if somekey=some_value is present on the object" "en": "Text on radio button which also is shown if somekey=some_value is present on the object"
}, },
"#": "If this option is picked as answer, these tags will be added additionally. However, if 'somekey=some_value' is present, the above rendering will be shown", "#1": "If this option is picked as answer, these tags will be added additionally. However, if 'somekey=some_value' is present, the above rendering will be shown",
"addExtraTags": [ "addExtraTags": [
"extrakey=extravalue" "extrakey=extravalue"
] ]
@ -169,9 +169,9 @@
"icon": { "icon": {
"path": "/path/to/extra-icon.svg OR url", "path": "/path/to/extra-icon.svg OR url",
"class": "medium", "class": "medium",
"#": "An extra icon supporting this option" "#1": "An extra icon supporting this option"
}, },
"#": "If this option is picked as answer, these tags will be added additionally. However, if 'somekey=some_value' is present, the above rendering will be shown", "#1": "If this option is picked as answer, these tags will be added additionally. However, if 'somekey=some_value' is present, the above rendering will be shown",
"addExtraTags": [ "addExtraTags": [
"extrakey=extravalue" "extrakey=extravalue"
] ]