forked from MapComplete/MapComplete
300 lines
16 KiB
TypeScript
300 lines
16 KiB
TypeScript
|
export default {
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"if": {
|
||
|
|
"$ref": "#/definitions/TagConfigJson",
|
||
|
|
"description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation"
|
||
|
|
},
|
||
|
|
"then": {
|
||
|
|
"description": "Shown if the 'if is fulfilled\nType: rendered"
|
||
|
|
},
|
||
|
|
"icon": {
|
||
|
|
"description": "An extra icon supporting the choice\nType: icon",
|
||
|
|
"anyOf": [
|
||
|
|
{
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"path": {
|
||
|
|
"description": "The path to the icon\nType: icon",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"class": {
|
||
|
|
"description": "Size of the image",
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"class",
|
||
|
|
"path"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"hideInAnswer": {
|
||
|
|
"description": "In some cases, multiple taggings exist (e.g. a default assumption, or a commonly mapped abbreviation and a fully written variation).\n\nIn the latter case, a correct text should be shown, but only a single, canonical tagging should be selectable by the user.\nIn this case, one of the mappings can be hiden by setting this flag.\n\nTo demonstrate an example making a default assumption:\n\nmappings: [\n {\n if: \"access=\", -- no access tag present, we assume accessible\n then: \"Accessible to the general public\",\n hideInAnswer: true\n },\n {\n if: \"access=yes\",\n then: \"Accessible to the general public\", -- the user selected this, we add that to OSM\n },\n {\n if: \"access=no\",\n then: \"Not accessible to the public\"\n }\n]\n\n\nFor example, for an operator, we have `operator=Agentschap Natuur en Bos`, which is often abbreviated to `operator=ANB`.\nThen, we would add two mappings:\n{\n if: \"operator=Agentschap Natuur en Bos\" -- the non-abbreviated version which should be uploaded\n then: \"Maintained by Agentschap Natuur en Bos\"\n},\n{\n if: \"operator=ANB\", -- we don't want to upload abbreviations\n then: \"Maintained by Agentschap Natuur en Bos\"\n hideInAnswer: true\n}\n\nHide in answer can also be a tagsfilter, e.g. to make sure an option is only shown when appropriate.\nKeep in mind that this is reverse logic: it will be hidden in the answer if the condition is true, it will thus only show in the case of a mismatch\n\ne.g., for toilets: if \"wheelchair=no\", we know there is no wheelchair dedicated room.\nFor the location of the changing table, the option \"in the wheelchair accessible toilet is weird\", so we write:\n\n{\n \"question\": \"Where is the changing table located?\"\n \"mappings\": [\n {\"if\":\"changing_table:location=female\",\"then\":\"In the female restroom\"},\n {\"if\":\"changing_table:location=male\",\"then\":\"In the male restroom\"},\n {\"if\":\"changing_table:location=wheelchair\",\"then\":\"In the wheelchair accessible restroom\", \"hideInAnswer\": \"wheelchair=no\"},\n \n ]\n}\n\nAlso have a look for the meta-tags\n{\n if: \"operator=Agentschap Natuur en Bos\",\n then: \"Maintained by Agentschap Natuur en Bos\",\n hideInAnswer: \"_country!=be\"\n}",
|
||
|
|
"anyOf": [
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/AndTagConfigJson",
|
||
|
|
"description": "Chain many tags, to match, a single of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/OrTagConfigJson",
|
||
|
|
"description": "Chain many tags, to match, all of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": [
|
||
|
|
"string",
|
||
|
|
"boolean"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"ifnot": {
|
||
|
|
"description": "Only applicable if 'multiAnswer' is set.\nThis is for situations such as:\n`accepts:coins=no` where one can select all the possible payment methods. However, we want to make explicit that some options _were not_ selected.\nThis can be done with `ifnot`\nNote that we can not explicitly render this negative case to the user, we cannot show `does _not_ accept coins`.\nIf this is important to your usecase, consider using multiple radiobutton-fields without `multiAnswer`",
|
||
|
|
"anyOf": [
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/AndTagConfigJson",
|
||
|
|
"description": "Chain many tags, to match, a single of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/OrTagConfigJson",
|
||
|
|
"description": "Chain many tags, to match, all of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"addExtraTags": {
|
||
|
|
"description": "If chosen as answer, these tags will be applied as well onto the object.\nNot compatible with multiAnswer",
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"searchTerms": {
|
||
|
|
"description": "If there are many options, the mappings-radiobuttons will be replaced by an element with a searchfunction\n\nSearchterms (per language) allow to easily find an option if there are many options",
|
||
|
|
"$ref": "#/definitions/Record<string,string[]>"
|
||
|
|
},
|
||
|
|
"priorityIf": {
|
||
|
|
"description": "If the searchable selector is picked, mappings with this item will have priority and show up even if the others are hidden\nUse this sparingly",
|
||
|
|
"anyOf": [
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/AndTagConfigJson",
|
||
|
|
"description": "Chain many tags, to match, a single of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/OrTagConfigJson",
|
||
|
|
"description": "Chain many tags, to match, all of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"if",
|
||
|
|
"then"
|
||
|
|
],
|
||
|
|
"definitions": {
|
||
|
|
"TagConfigJson": {
|
||
|
|
"description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation",
|
||
|
|
"anyOf": [
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/AndTagConfigJson"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"description": "Chain many tags, to match, all of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation",
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"or": {
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"$ref": "#/definitions/TagConfigJson"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"or"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"AndTagConfigJson": {
|
||
|
|
"description": "Chain many tags, to match, a single of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation",
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"and": {
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"$ref": "#/definitions/TagConfigJson"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"and"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"OrTagConfigJson": {
|
||
|
|
"description": "Chain many tags, to match, all of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation",
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"or": {
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"$ref": "#/definitions/TagConfigJson"
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"or"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"ApplicableUnitJson": {
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"canonicalDenomination": {
|
||
|
|
"description": "The canonical value which will be added to the value in OSM.\ne.g. \"m\" for meters\nIf the user inputs '42', the canonical value will be added and it'll become '42m'.\n\nImportant: often, _no_ canonical values are expected, e.g. in the case of 'maxspeed' where 'km/h' is the default.\nIn this case, an empty string should be used",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"canonicalDenominationSingular": {
|
||
|
|
"description": "The canonical denomination in the case that the unit is precisely '1'",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"alternativeDenomination": {
|
||
|
|
"description": "A list of alternative values which can occur in the OSM database - used for parsing.",
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"human": {
|
||
|
|
"description": "The value for humans in the dropdown. This should not use abbreviations and should be translated, e.g.\n{\n \"en\": \"meter\",\n \"fr\": \"metre\"\n}"
|
||
|
|
},
|
||
|
|
"humanSingular": {
|
||
|
|
"description": "The value for humans in the dropdown. This should not use abbreviations and should be translated, e.g.\n{\n \"en\": \"minute\",\n \"nl\": \"minuut\"x²\n}"
|
||
|
|
},
|
||
|
|
"prefix": {
|
||
|
|
"description": "If set, then the canonical value will be prefixed instead, e.g. for '€'\nNote that if all values use 'prefix', the dropdown might move to before the text field",
|
||
|
|
"type": "boolean"
|
||
|
|
},
|
||
|
|
"default": {
|
||
|
|
"description": "The default interpretation - only one can be set.\nIf none is set, the first unit will be considered the default interpretation of a value without a unit",
|
||
|
|
"type": "boolean"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"canonicalDenomination"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"TagRenderingConfigJson": {
|
||
|
|
"description": "A TagRenderingConfigJson is a single piece of code which converts one ore more tags into a HTML-snippet.\nFor an _editable_ tagRendering, use 'QuestionableTagRenderingConfigJson' instead, which extends this one",
|
||
|
|
"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.\n\nUse 'questions' to trigger the question box of this group (if a group is defined)",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"group": {
|
||
|
|
"description": "If 'group' is defined on many tagRenderings, these are grouped together when shown. The questions are grouped together as well.\nThe first tagRendering of a group will always be a sticky element.",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"labels": {
|
||
|
|
"description": "A list of labels. These are strings that are used for various purposes, e.g. to filter them away",
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"render": {
|
||
|
|
"description": "Renders this value. Note that \"{key}\"-parts are substituted by the corresponding values of the element.\nIf neither 'textFieldQuestion' nor 'mappings' are defined, this text is simply shown as default value.\n\nNote that this is a HTML-interpreted value, so you can add links as e.g. '<a href='{website}'>{website}</a>' or include images such as `This is of type A <br><img src='typeA-icon.svg' />`\ntype: rendered"
|
||
|
|
},
|
||
|
|
"condition": {
|
||
|
|
"description": "Only show this tagrendering (or ask the question) if the selected object also matches the tags specified as `condition`.\n\nThis is useful to ask a follow-up question.\nFor example, within toilets, asking _where_ the diaper changing table is is only useful _if_ there is one.\nThis can be done by adding `\"condition\": \"changing_table=yes\"`\n\nA full example would be:\n```json\n {\n \"question\": \"Where is the changing table located?\",\n \"render\": \"The changing table is located at {changing_table:location}\",\n \"condition\": \"changing_table=yes\",\n \"freeform\": {\n \"key\": \"changing_table:location\",\n \"inline\": true\n },\n \"mappings\": [\n {\n \"then\": \"The changing table is in the toilet for women.\",\n \"if\": \"changing_table:location=female_toilet\"\n },\n {\n \"then\": \"The changing table is in the toilet for men.\",\n \"if\": \"changing_table:location=male_toilet\"\n },\n {\n \"if\": \"changing_table:location=wheelchair_toilet\",\n \"then\": \"The changing table is in the toilet for wheelchair users.\",\n },\n {\n \"if\": \"changing_table:location=dedicated_room\",\n \"then\": \"The changing table is in a dedicated room. \",\n }\n ],\n \"id\": \"toilet-changing_table:location\"\n },\n```",
|
||
|
|
"anyOf": [
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/AndTagConfigJson",
|
||
|
|
"description": "Chain many tags, to match, a single of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"$ref": "#/definitions/OrTagConfigJson",
|
||
|
|
"description": "Chain many tags, to match, all of these should be true\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for documentation"
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"freeform": {
|
||
|
|
"description": "Allow freeform text input from the user",
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"key": {
|
||
|
|
"description": "If this key is present, then 'render' is used to display the value.\nIf this is undefined, the rendering is _always_ shown",
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"key"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
"mappings": {
|
||
|
|
"description": "Allows fixed-tag inputs, shown either as radiobuttons or as checkboxes",
|
||
|
|
"type": "array",
|
||
|
|
"items": {
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"if": {
|
||
|
|
"$ref": "#/definitions/TagConfigJson",
|
||
|
|
"description": "If this condition is met, then the text under `then` will be shown.\nIf no value matches, and the user selects this mapping as an option, then these tags will be uploaded to OSM.\n\nFor example: {'if': 'diet:vegetarion=yes', 'then':'A vegetarian option is offered here'}\n\nThis can be an substituting-tag as well, e.g. {'if': 'addr:street:={_calculated_nearby_streetname}', 'then': '{_calculated_nearby_streetname}'}"
|
||
|
|
},
|
||
|
|
"then": {
|
||
|
|
"description": "If the condition `if` is met, the text `then` will be rendered.\nIf not known yet, the user will be presented with `then` as an option\nType: rendered"
|
||
|
|
},
|
||
|
|
"icon": {
|
||
|
|
"description": "An icon supporting this mapping; typically shown pretty small\nType: icon",
|
||
|
|
"anyOf": [
|
||
|
|
{
|
||
|
|
"type": "object",
|
||
|
|
"properties": {
|
||
|
|
"path": {
|
||
|
|
"description": "The path to the icon\nType: icon",
|
||
|
|
"type": "string"
|
||
|
|
},
|
||
|
|
"class": {
|
||
|
|
"description": "A hint to mapcomplete on how to render this icon within the mapping.\nThis is translated to 'mapping-icon-<classtype>', so defining your own in combination with a custom CSS is possible (but discouraged)",
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"class",
|
||
|
|
"path"
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"type": "string"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"required": [
|
||
|
|
"if",
|
||
|
|
"then"
|
||
|
|
]
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"Record<string,string[]>": {
|
||
|
|
"type": "object"
|
||
|
|
}
|
||
|
|
},
|
||
|
|
"$schema": "http://json-schema.org/draft-07/schema#"
|
||
|
|
}
|