323 lines
No EOL
13 KiB
JSON
323 lines
No EOL
13 KiB
JSON
{
|
|
"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": {
|
|
"render": {
|
|
"description": "question: What text should be rendered?\n\nThis piece of text will be shown in the infobox.\nIn this text, values within braces (such as {braced(key)}) are replaced by the corresponding `value` in the object.\nFor example, if the object contains tags `amenity=school; name=Windy Hill School`, the render string `This school is named {name}` will be shown to the user as `This school is named Windy Hill School`\n\nThis text will be shown if:\n- there is no mapping which matches (or there are no matches)\n- no question, no mappings and no 'freeform' is set\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\nifunset: No text is shown if no predefined options match.",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"special": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string|Record<string,string>>"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"type"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"special"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"icon": {
|
|
"description": "question: what icon should be shown next to the 'render' value?\nAn icon shown next to the rendering; typically shown pretty small\nThis is only shown next to the \"render\" value\nType: icon\nifunset: No additional icon is shown next to the always shown text",
|
|
"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": [
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"condition": {
|
|
"description": "question: When should this item be shown?\ntype: tag\nifunset: No specific condition set; always show this tagRendering or show this question if unknown\n\nOnly 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/{and:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/{or:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"metacondition": {
|
|
"description": "question: When should this item be shown (including special conditions)?\ntype: tag\nifunset: No specific metacondition set which is evaluated against the <i>usersettings/application state</i>; always show this tagRendering or show this question if unknown\n\nIf set, this tag will be evaluated against the _usersettings/application state_ table.\nEnable 'show debug info' in user settings to see available options (at the settings-tab).\nNote that values with an underscore depicts _application state_ (including metainfo about the user) whereas values without an underscore depict _user settings_",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/{and:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/{or:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"freeform": {
|
|
"description": "question: Should a freeform text field be shown?\nAllow freeform text input from the user\nifunset: Do not add a freeform text field",
|
|
"type": "object",
|
|
"properties": {
|
|
"key": {
|
|
"description": "What attribute should be filled out\nIf this key is present in the feature, then 'render' is used to display the value.\nIf this is undefined, the rendering is _always_ shown",
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"mappings": {
|
|
"description": "Allows fixed-tag inputs, shown either as radiobuttons or as checkboxes",
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"if": {
|
|
"$ref": "#/definitions/TagConfigJson",
|
|
"description": "question: When should this single mapping match?\n\nIf 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": "question: What text should be shown?\n\nIf 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",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"icon": {
|
|
"description": "question: What icon should be added to this mapping?\nifunset: Do not show an extra icon next to the render value\n\nAn icon supporting this mapping; typically shown pretty small.\nThis can be used to show a e.g. 'phone'-icon next to the phone number\n\nThis supports patterns, you can e.g. have `close:red;some/other/icon.svg`\n\ninline: <img src='{icon}' class=\"w-8 h-8\" /> {icon}\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": [
|
|
"path"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"required": [
|
|
"if",
|
|
"then"
|
|
]
|
|
}
|
|
},
|
|
"description": {
|
|
"description": "A human-readable text explaining what this tagRendering does.\nMostly used for the shared tagrenderings",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"classes": {
|
|
"description": "question: What css-classes should be applied to showing this attribute?\n\nA list of css-classes to apply to the entire tagRendering.\nThese classes are applied in 'answer'-mode, not in question mode\nThis is only for advanced users.\n\nValues are split on ` ` (space)",
|
|
"type": "string"
|
|
},
|
|
"filter": {
|
|
"description": "This tagRendering can introduce this builtin filter",
|
|
"anyOf": [
|
|
{
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"enum": [
|
|
true
|
|
],
|
|
"type": "boolean"
|
|
}
|
|
]
|
|
}
|
|
},
|
|
"definitions": {
|
|
"TagConfigJson": {
|
|
"description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation\n\ntype: tag",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/{and:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"properties": {
|
|
"or": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TagConfigJson"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"or"
|
|
]
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"{and:TagConfigJson[];}": {
|
|
"type": "object",
|
|
"properties": {
|
|
"and": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TagConfigJson"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"and"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"Record<string,string>": {
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"{or:TagConfigJson[];}": {
|
|
"type": "object",
|
|
"properties": {
|
|
"or": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/TagConfigJson"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"or"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"FilterConfigOptionJson": {
|
|
"type": "object",
|
|
"properties": {
|
|
"question": {
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/Record<string,string>"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"searchTerms": {
|
|
"$ref": "#/definitions/Record<string,string[]>"
|
|
},
|
|
"emoji": {
|
|
"type": "string"
|
|
},
|
|
"icon": {
|
|
"type": "string"
|
|
},
|
|
"osmTags": {
|
|
"description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation\n\ntype: tag",
|
|
"anyOf": [
|
|
{
|
|
"$ref": "#/definitions/{and:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"$ref": "#/definitions/{or:TagConfigJson[];}"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
]
|
|
},
|
|
"default": {
|
|
"type": "boolean"
|
|
},
|
|
"fields": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"properties": {
|
|
"name": {
|
|
"description": "If name is `search`, use \"_first_comment~.*{search}.*\" as osmTags",
|
|
"type": "string"
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": [
|
|
"name"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"question"
|
|
],
|
|
"additionalProperties": false
|
|
},
|
|
"Record<string,string[]>": {
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
},
|
|
"Record<string,string|Record<string,string>>": {
|
|
"type": "object",
|
|
"additionalProperties": false
|
|
}
|
|
},
|
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
"additionalProperties": false
|
|
} |