mapcomplete/assets/questionabletagrenderingconfigmeta.json

[
  {
    "path": [],
    "type": "object",
    "description": "A QuestionableTagRenderingConfigJson is a single piece of code which converts one ore more tags into a HTML-snippet.\nIf the desired tags are missing and a question is defined, a question will be shown instead."
  },
  {
    "path": [
      "question"
    ],
    "description": "If it turns out that this tagRendering doesn't match _any_ value, then we show this question.\nIf undefined, the question is never asked and this tagrendering is read-only"
  },
  {
    "path": [
      "freeform"
    ],
    "type": "object",
    "description": "Allow freeform text input from the user"
  },
  {
    "path": [
      "freeform",
      "type"
    ],
    "type": "string",
    "description": "The type of the text-field, e.g. 'string', 'nat', 'float', 'date',...\nSee Docs/SpecialInputElements.md and UI/Input/ValidatedTextField.ts for supported values"
  },
  {
    "path": [
      "freeform",
      "placeholder"
    ],
    "description": "A (translated) text that is shown (as gray text) within the textfield"
  },
  {
    "path": [
      "freeform",
      "helperArgs"
    ],
    "type": "array",
    "description": "Extra parameters to initialize the input helper arguments.\nFor semantics, see the 'SpecialInputElements.md'"
  },
  {
    "path": [
      "freeform",
      "addExtraTags"
    ],
    "type": "array",
    "description": "If a value is added with the textfield, these extra tag is addded.\nUseful to add a 'fixme=freeform textfield used - to be checked'"
  },
  {
    "path": [
      "freeform",
      "inline"
    ],
    "type": "boolean",
    "description": "When set, influences the way a question is asked.\nInstead of showing a full-widht text field, the text field will be shown within the rendering of the question.\n\nThis combines badly with special input elements, as it'll distort the layout."
  },
  {
    "path": [
      "freeform",
      "default"
    ],
    "type": "string",
    "description": "default value to enter if no previous tagging is present.\nNormally undefined (aka do not enter anything)"
  },
  {
    "path": [
      "multiAnswer"
    ],
    "type": "boolean",
    "description": "If true, use checkboxes instead of radio buttons when asking the question"
  },
  {
    "path": [
      "mappings"
    ],
    "type": "array",
    "description": "Allows fixed-tag inputs, shown either as radiobuttons or as checkboxes"
  },
  {
    "path": [
      "mappings",
      "then"
    ],
    "typeHint": "rendered",
    "description": "Shown if the 'if is fulfilled\nType: rendered"
  },
  {
    "path": [
      "mappings",
      "icon"
    ],
    "typeHint": "icon",
    "type": [
      {
        "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"
      }
    ],
    "description": "An extra icon supporting the choice\nType: icon"
  },
  {
    "path": [
      "mappings",
      "icon",
      "path"
    ],
    "typeHint": "icon",
    "type": "string",
    "description": "The path to the  icon\nType: icon"
  },
  {
    "path": [
      "mappings",
      "icon",
      "class"
    ],
    "type": "string",
    "description": "Size of the image"
  },
  {
    "path": [
      "mappings",
      "hideInAnswer"
    ],
    "type": [
      {
        "$ref": "#/definitions/AndOrTagConfigJson"
      },
      {
        "type": [
          "string",
          "boolean"
        ]
      }
    ],
    "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}"
  },
  {
    "path": [
      "mappings",
      "ifnot"
    ],
    "type": [
      {
        "$ref": "#/definitions/AndOrTagConfigJson"
      },
      {
        "type": "string"
      }
    ],
    "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`"
  },
  {
    "path": [
      "mappings",
      "addExtraTags"
    ],
    "type": "array",
    "description": "If chosen as answer, these tags will be applied as well onto the object.\nNot compatible with multiAnswer"
  },
  {
    "path": [
      "id"
    ],
    "type": "string",
    "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)"
  },
  {
    "path": [
      "group"
    ],
    "type": "string",
    "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."
  },
  {
    "path": [
      "labels"
    ],
    "type": "array",
    "description": "A list of labels. These are strings that are used for various purposes, e.g. to filter them away"
  },
  {
    "path": [
      "render"
    ],
    "typeHint": "rendered",
    "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"
  },
  {
    "path": [
      "condition"
    ],
    "type": [
      {
        "$ref": "#/definitions/AndOrTagConfigJson"
      },
      {
        "type": "string"
      }
    ],
    "description": "Only show this tagrendering (or question) if the object also matches the following tags.\n\nThis is useful to ask a follow-up question. E.g. if there is a diaper table, then ask a follow-up question on diaper tables..."
  }
]