midgard/mapcomplete
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add small documentation improvements

Browse source
This commit is contained in:
Pieter Vander Vennet 2021-04-03 14:33:19 +02:00 committed by GitHub
parent 64a246390f
commit b2662b823c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
Customizations/JSON/TagRenderingConfigJson.ts
View file

@ -1,11 +1,16 @@
import {AndOrTagConfigJson} from "./TagConfigJson"; import {AndOrTagConfigJson} from "./TagConfigJson";
/**
* A TagRenderingConfigJson is a single piece of code which converts one ore more tags into a HTML-snippet.
* If the desired tags are missing and a question is defined, a question will be shown instead.
*
/
export interface TagRenderingConfigJson { export interface TagRenderingConfigJson {
/** /**
* Renders this value. Note that "{key}"-parts are substituted by the corresponding values of the element. * Renders this value. Note that "{key}"-parts are substituted by the corresponding values of the element.
* If neither 'textFieldQuestion' nor 'mappings' are defined, this text is simply shown as default value. * If neither 'textFieldQuestion' nor 'mappings' are defined, this text is simply shown as default value.
* *
* Note that this is a HTML-interpreted value, so you can add links as e.g. <a href='{website}'>{website}</a> * Note 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' />`
*/ */
render?: string | any, render?: string | any,
@ -139,4 +144,4 @@ export interface TagRenderingConfigJson {
* However, it will _only_ be shown if it matches the overpass-tags of the layer it was originally defined in. * However, it will _only_ be shown if it matches the overpass-tags of the layer it was originally defined in.
*/ */
roaming?: boolean roaming?: boolean
} }