mapcomplete/assets/tagrenderingconfigmeta.json

[
  {
    "path": [],
    "required": false,
    "hints": {},
    "type": "object",
    "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"
  },
  {
    "path": [
      "classes"
    ],
    "required": false,
    "hints": {},
    "type": [
      {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      {
        "type": "string"
      }
    ],
    "description": "A list of css-classes to apply to the entire tagRendering if the answer is known (not applied on the question).\nThis is only for advanced users"
  },
  {
    "path": [
      "description"
    ],
    "required": false,
    "hints": {},
    "type": [
      {
        "$ref": "#/definitions/Record<string,string>"
      },
      {
        "type": "string"
      }
    ],
    "description": "A human-readable text explaining what this tagRendering does.\nMostly used for the shared tagrenderings"
  },
  {
    "path": [
      "render"
    ],
    "required": false,
    "hints": {
      "typehint": "rendered"
    },
    "type": [
      {
        "$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"
      }
    ],
    "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' />`"
  },
  {
    "path": [
      "condition"
    ],
    "required": false,
    "hints": {},
    "type": [
      {
        "$ref": "#/definitions/{and:TagConfigJson[];}"
      },
      {
        "$ref": "#/definitions/{or:TagConfigJson[];}"
      },
      {
        "type": "string"
      }
    ],
    "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```"
  },
  {
    "path": [
      "condition",
      "and"
    ],
    "required": false,
    "hints": {
      "typehint": "tag"
    },
    "type": [
      {
        "$ref": "#/definitions/{and:TagConfigJson[];}"
      },
      {
        "type": "object",
        "properties": {
          "or": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/TagConfigJson"
            }
          }
        },
        "required": [
          "or"
        ]
      },
      {
        "type": "string"
      }
    ],
    "description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation\n"
  },
  {
    "path": [
      "condition",
      "or"
    ],
    "required": false,
    "hints": {
      "typehint": "tag"
    },
    "type": [
      {
        "$ref": "#/definitions/{and:TagConfigJson[];}"
      },
      {
        "type": "object",
        "properties": {
          "or": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/TagConfigJson"
            }
          }
        },
        "required": [
          "or"
        ]
      },
      {
        "type": "string"
      }
    ],
    "description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation\n"
  },
  {
    "path": [
      "metacondition"
    ],
    "required": false,
    "hints": {},
    "type": [
      {
        "$ref": "#/definitions/{and:TagConfigJson[];}"
      },
      {
        "$ref": "#/definitions/{or:TagConfigJson[];}"
      },
      {
        "type": "string"
      }
    ],
    "description": "If set, this tag will be evaluated agains the _usersettings/application state_ table.\nEnable 'show debug info' in user settings to see available options.\nNote that values with an underscore depicts _application state_ (including metainfo about the user) whereas values without an underscore depict _user settings_"
  },
  {
    "path": [
      "metacondition",
      "and"
    ],
    "required": false,
    "hints": {
      "typehint": "tag"
    },
    "type": [
      {
        "$ref": "#/definitions/{and:TagConfigJson[];}"
      },
      {
        "type": "object",
        "properties": {
          "or": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/TagConfigJson"
            }
          }
        },
        "required": [
          "or"
        ]
      },
      {
        "type": "string"
      }
    ],
    "description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation\n"
  },
  {
    "path": [
      "metacondition",
      "or"
    ],
    "required": false,
    "hints": {
      "typehint": "tag"
    },
    "type": [
      {
        "$ref": "#/definitions/{and:TagConfigJson[];}"
      },
      {
        "type": "object",
        "properties": {
          "or": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/TagConfigJson"
            }
          }
        },
        "required": [
          "or"
        ]
      },
      {
        "type": "string"
      }
    ],
    "description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation\n"
  },
  {
    "path": [
      "freeform"
    ],
    "required": false,
    "hints": {},
    "type": "object",
    "description": "Allow freeform text input from the user"
  },
  {
    "path": [
      "freeform",
      "key"
    ],
    "required": true,
    "hints": {},
    "type": "string",
    "description": "If this key is present, then 'render' is used to display the value.\nIf this is undefined, the rendering is _always_ shown"
  },
  {
    "path": [
      "mappings"
    ],
    "required": false,
    "hints": {},
    "type": "array",
    "description": "Allows fixed-tag inputs, shown either as radiobuttons or as checkboxes"
  },
  {
    "path": [
      "mappings",
      "if"
    ],
    "required": true,
    "hints": {
      "typehint": "tag"
    },
    "type": [
      {
        "$ref": "#/definitions/{and:TagConfigJson[];}"
      },
      {
        "type": "object",
        "properties": {
          "or": {
            "type": "array",
            "items": {
              "$ref": "#/definitions/TagConfigJson"
            }
          }
        },
        "required": [
          "or"
        ]
      },
      {
        "type": "string"
      }
    ],
    "description": "The main representation of Tags.\nSee https://github.com/pietervdvn/MapComplete/blob/develop/Docs/Tags_format.md for more documentation\n"
  },
  {
    "path": [
      "mappings",
      "then"
    ],
    "required": true,
    "hints": {
      "typehint": "rendered"
    },
    "type": [
      {
        "$ref": "#/definitions/Record<string,string>"
      },
      {
        "type": "string"
      }
    ],
    "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"
  },
  {
    "path": [
      "mappings",
      "icon"
    ],
    "required": false,
    "hints": {
      "typehint": "icon"
    },
    "type": [
      {
        "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"
      }
    ],
    "description": "An icon supporting this mapping; typically shown pretty small"
  },
  {
    "path": [
      "mappings",
      "icon",
      "path"
    ],
    "required": true,
    "hints": {
      "typehint": "icon"
    },
    "type": "string",
    "description": "The path to the icon"
  },
  {
    "path": [
      "mappings",
      "icon",
      "class"
    ],
    "required": false,
    "hints": {},
    "type": "string",
    "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)"
  }
]