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

Improve metadata in configmeta.json

Browse source
This commit is contained in:
pietervdvn 2022-05-17 01:46:59 +02:00
parent 2247f004cc
commit 504cb92e3b
5 changed files with 1698 additions and 794 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
Models/ThemeConfig/Json/LayerConfigJson.ts
View file

@ -53,11 +53,15 @@ export interface LayerConfigJson {
*/
maxCacheAge?: number
}) &
({ /* # Query OSM Via the overpass API with a custom script
* source: {overpassScript: "<custom overpass tags>"} when you want to do special things. _This should be really rare_.
* This means that the data will be pulled from overpass with this script, and will ignore the osmTags for the query
* However, for the rest of the pipeline, the OsmTags will _still_ be used. This is important to enable layers etc...
*/
({
/**
* If set, this custom overpass-script will be used instead of building one by using the OSM-tags.
* Specifying OSM-tags is still obligatory and will still hide non-matching items and they will be used for the rest of the pipeline.
* _This should be really rare_.
*
* For example, write `"source": {"overpassScript": "way[\"leisure\"=\"park\"];node(w);is_in;area._[\"leisure\"=\"park\"];(way(area)[\"landuse\"=\"grass\"]; node(w); );", "osmTags": "access=yes"}`
* when you want to fetch all grass-areas in parks and which are marked as publicly accessible.
*/
overpassScript?: string
} |
{
@ -203,10 +207,10 @@ export interface LayerConfigJson {
presets?: {
/**
* The title - shown on the 'add-new'-button.
*
*
* This should include the article of the noun, e.g. 'a hydrant', 'a bicycle pump'.
* This text will be inserted into `Add {category} here`, becoming `Add a hydrant here`.
*
*
* Do _not_ indicate 'new': 'add a new shop here' is incorrect, as the shop might have existed forever, it could just be unmapped!
*/
title: string | any,
@ -267,7 +271,7 @@ export interface LayerConfigJson {
* If one or more questions have a 'group' or 'label' set, select all the entries with the corresponding group or label with `otherlayer.*group`
* Remark: if a tagRendering is 'lent' from another layer, the 'source'-tags are copied and added as condition.
* If they are not wanted, remove them with an override
*
*
* A special value is 'questions', which indicates the location of the questions box. If not specified, it'll be appended to the bottom of the featureInfobox.
*
* At last, one can define a group of renderings where parts of all strings will be replaced by multiple other strings.
@ -349,7 +353,7 @@ export interface LayerConfigJson {
/**
* If set, a 'split this way' button is shown on objects rendered as LineStrings, e.g. highways.
*
*
* If the way is part of a relation, MapComplete will attempt to update this relation as well
*/
allowSplit?: boolean

2343
assets/layoutconfigmeta.json
View file

File diff suppressed because it is too large Load diff

69
assets/questionabletagrenderingconfigmeta.json
View file

@ -1,78 +1,90 @@
[
{
"path": [],
"type": "object"
"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"
"type": "object",
"description": "Allow freeform text input from the user"
},
{
"path": [
"freeform",
"type"
],
"type": "string"
"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"
"type": "array",
"description": "Extra parameters to initialize the input helper arguments.\nFor semantics, see the 'SpecialInputElements.md'"
},
{
"path": [
"freeform",
"addExtraTags"
],
"type": "array"
"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"
"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"
"type": "string",
"description": "default value to enter if no previous tagging is present.\nNormally undefined (aka do not enter anything)"
},
{
"path": [
"multiAnswer"
],
"type": "boolean"
"type": "boolean",
"description": "If true, use checkboxes instead of radio buttons when asking the question"
},
{
"path": [
"mappings"
],
"type": "array"
"type": "array",
"description": "Allows fixed-tag inputs, shown either as radiobuttons or as checkboxes"
},
{
"path": [
"mappings",
"then"
],
"typeHint": "rendered"
"typeHint": "rendered",
"description": "Shown if the 'if is fulfilled\nType: rendered"
},
{
"path": [
@ -101,7 +113,8 @@
{
"type": "string"
}
]
],
"description": "An extra icon supporting the choice\nType: icon"
},
{
"path": [
@ -110,7 +123,8 @@
"path"
],
"typeHint": "icon",
"type": "string"
"type": "string",
"description": "The path to the icon\nType: icon"
},
{
"path": [
@ -118,7 +132,8 @@
"icon",
"class"
],
"type": "string"
"type": "string",
"description": "Size of the image"
},
{
"path": [
@ -135,7 +150,8 @@
"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": [
@ -149,38 +165,44 @@
{
"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"
"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"
"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"
"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"
"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"
"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": [
@ -193,6 +215,7 @@
{
"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..."
}
]

42
assets/tagrenderingconfigmeta.json
View file

@ -1,31 +1,36 @@
[
{
"path": [],
"type": "object"
"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": [
"id"
],
"type": "string"
"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"
"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"
"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"
"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": [
@ -38,26 +43,30 @@
{
"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..."
},
{
"path": [
"freeform"
],
"type": "object"
"type": "object",
"description": "Allow freeform text input from the user"
},
{
"path": [
"freeform",
"key"
],
"type": "string"
"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"
],
"type": "array"
"type": "array",
"description": "Allows fixed-tag inputs, shown either as radiobuttons or as checkboxes"
},
{
"path": [
@ -71,14 +80,16 @@
{
"type": "string"
}
]
],
"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}'}"
},
{
"path": [
"mappings",
"then"
],
"typeHint": "rendered"
"typeHint": "rendered",
"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"
},
{
"path": [
@ -107,7 +118,8 @@
{
"type": "string"
}
]
],
"description": "An icon supporting this mapping; typically shown pretty small\nType: icon"
},
{
"path": [
@ -116,7 +128,8 @@
"path"
],
"typeHint": "icon",
"type": "string"
"type": "string",
"description": "The path to the icon\nType: icon"
},
{
"path": [
@ -124,6 +137,7 @@
"icon",
"class"
],
"type": "string"
"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)"
}
]

16
scripts/fixSchemas.ts
View file

@ -1,12 +1,16 @@
import ScriptUtils from "./ScriptUtils";
import {readFileSync, writeFileSync} from "fs";
/**
* Extracts the data from the scheme file and writes them in a flatter structure
*/
interface JsonSchema {
description?: string,
type?: string,
properties?: any,
items?: JsonSchema,
allOf?: JsonSchema[],
anyOf: JsonSchema[],
enum: JsonSchema[],
"$ref": string
@ -19,11 +23,12 @@ function WalkScheme<T>(
path: string[] = [],
isHandlingReference = []
): { path: string[], t: T }[] {
const results: { path: string[], t: T } [] = []
if (scheme === undefined) {
return []
}
if (scheme["$ref"] !== undefined) {
const ref = scheme["$ref"]
const prefix = "#/definitions/"
@ -59,15 +64,17 @@ function WalkScheme<T>(
if (scheme === undefined) {
return
}
scheme.forEach(v => walk(v))
}
{
walkEach(scheme.enum)
walkEach(scheme.anyOf)
walkEach(scheme.allOf)
if (Array.isArray(scheme.items)) {
walkEach(<any>scheme.items)
} else {
@ -93,7 +100,7 @@ function extractMeta(typename: string, path: string) {
.find(line => line.trim().toLocaleLowerCase().startsWith("type:"))
?.substr("type:".length)?.trim()
const type = schemePart.items?.anyOf ?? schemePart.type ?? schemePart.anyOf;
return {typeHint, type}
return {typeHint, type, description: schemePart.description}
}, themeSchema)
const paths = withTypes.map(({
@ -118,7 +125,6 @@ function main() {
for (const key in parsed.definitions) {
const def = parsed.definitions[key]
console.log("Patching ", key)
if (def.type === "object") {
def["additionalProperties"] = false
}