forked from MapComplete/MapComplete
Chore: regen docs
This commit is contained in:
parent
e51bc34749
commit
7a7439b161
266 changed files with 8503 additions and 14470 deletions
|
|
@ -1,16 +1,7 @@
|
|||
[//]: # (WARNING: this file is automatically generated. Please find the sources at the bottom and edit those sources)
|
||||
|
||||
|
||||
|
||||
Available types for text fields
|
||||
=================================
|
||||
|
||||
|
||||
|
||||
The listed types here trigger a special input element. Use them in `tagrendering.freeform.type` of your tagrendering to activate them
|
||||
|
||||
|
||||
### Table of contents
|
||||
# Available types for text fields
|
||||
The listed types here trigger a special input element. Use them in `tagrendering.freeform.type` of your tagrendering to activate them### Table of contents
|
||||
|
||||
1. [string](#string)
|
||||
2. [text](#text)
|
||||
|
|
@ -47,70 +38,25 @@ The listed types here trigger a special input element. Use them in `tagrendering
|
|||
33. [Helper arguments](#helper-arguments)
|
||||
34. [currency](#currency)
|
||||
|
||||
### string
|
||||
|
||||
|
||||
|
||||
### string
|
||||
A simple piece of text
|
||||
|
||||
|
||||
|
||||
### text
|
||||
|
||||
|
||||
|
||||
### text
|
||||
A longer piece of text. Uses an textArea instead of a textField
|
||||
|
||||
|
||||
|
||||
### date
|
||||
|
||||
|
||||
|
||||
### date
|
||||
A date with date picker
|
||||
|
||||
|
||||
|
||||
### nat
|
||||
|
||||
|
||||
|
||||
### nat
|
||||
A whole, positive number or zero
|
||||
|
||||
|
||||
|
||||
### int
|
||||
|
||||
|
||||
|
||||
### int
|
||||
A whole number, either positive, negative or zero
|
||||
|
||||
|
||||
|
||||
### distance
|
||||
|
||||
|
||||
|
||||
### distance
|
||||
A geographical distance in meters (rounded at two points). Will give an extra minimap with a measurement tool. Arguments: [ zoomlevel, preferredBackgroundMapType (comma separated) ], e.g. `["21", "map,photo"]
|
||||
|
||||
|
||||
|
||||
### direction
|
||||
|
||||
|
||||
|
||||
### direction
|
||||
A geographical direction, in degrees. 0° is north, 90° is east, ... Will return a value between 0 (incl) and 360 (excl).
|
||||
|
||||
### Input helper
|
||||
|
||||
This element has an input helper showing a map and 'viewport' indicating the direction. By default, this map is zoomed to zoomlevel 17, but this can be changed with the first argument
|
||||
|
||||
|
||||
|
||||
### wikidata
|
||||
|
||||
|
||||
|
||||
### wikidata
|
||||
A wikidata identifier, e.g. Q42.
|
||||
|
||||
### Helper arguments
|
||||
|
|
@ -122,12 +68,15 @@ name | doc
|
|||
key | the value of this tag will initialize search (default: name). This can be a ';'-separated list in which case every key will be inspected. The non-null value will be used as search
|
||||
options | A JSON-object of type `{ removePrefixes: string[], removePostfixes: string[] }`.
|
||||
|
||||
subarg \| doc
|
||||
-------- \| -----
|
||||
removePrefixes \| remove these snippets of text from the start of the passed string to search. This is either a list OR a hash of languages to a list. The individual strings are interpreted as case ignoring regexes
|
||||
removePostfixes \| remove these snippets of text from the end of the passed string to search. This is either a list OR a hash of languages to a list. The individual strings are interpreted as case ignoring regexes.
|
||||
instanceOf \| A list of Q-identifier which indicates that the search results _must_ be an entity of this type, e.g. [`Q5`](https://www.wikidata.org/wiki/Q5) for humans
|
||||
notInstanceof \| A list of Q-identifiers which indicates that the search results _must not_ be an entity of this type, e.g. [`Q79007`](https://www.wikidata.org/wiki/Q79007) to filter away all streets from the search results
|
||||
\| subarg \| doc \|
|
||||
-----\|----- \|
|
||||
\| removePrefixes \| remove these snippets of text from the start of the passed string to search. This is either a list OR a hash of languages to a list. The individual strings are interpreted as case ignoring regexes \|
|
||||
\| removePostfixes \| remove these snippets of text from the end of the passed string to search. This is either a list OR a hash of languages to a list. The individual strings are interpreted as case ignoring regexes. \|
|
||||
\| instanceOf \| A list of Q-identifier which indicates that the search results _must_ be an entity of this type, e.g. [`Q5`](https://www.wikidata.org/wiki/Q5) for humans \|
|
||||
\| notInstanceof \| A list of Q-identifiers which indicates that the search results _must not_ be an entity of this type, e.g. [`Q79007`](https://www.wikidata.org/wiki/Q79007) to filter away all streets from the search results \|
|
||||
\| multiple \| If 'yes' or 'true', will allow to select multiple values at once \|
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
|
@ -175,61 +124,19 @@ Another example is to search for species and trees:
|
|||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
### pnat
|
||||
|
||||
|
||||
|
||||
### pnat
|
||||
A strict positive number
|
||||
|
||||
|
||||
|
||||
### float
|
||||
|
||||
|
||||
|
||||
### float
|
||||
A decimal number
|
||||
|
||||
|
||||
|
||||
### pfloat
|
||||
|
||||
|
||||
|
||||
### pfloat
|
||||
A positive decimal number or zero
|
||||
|
||||
|
||||
|
||||
### email
|
||||
|
||||
|
||||
|
||||
### email
|
||||
An email adress
|
||||
|
||||
|
||||
|
||||
### url
|
||||
|
||||
|
||||
|
||||
### url
|
||||
The validatedTextField will format URLs to always be valid and have a https://-header (even though the 'https'-part will be hidden from the user. Furthermore, some tracking parameters will be removed
|
||||
|
||||
|
||||
|
||||
### phone
|
||||
|
||||
|
||||
|
||||
### phone
|
||||
A phone number
|
||||
|
||||
|
||||
|
||||
### opening_hours
|
||||
|
||||
|
||||
|
||||
### opening_hours
|
||||
Has extra elements to easily input when a POI is opened.
|
||||
|
||||
### Helper arguments
|
||||
|
|
@ -266,101 +173,29 @@ postfix \| Piece of text that will always be added to the end of the generated o
|
|||
```
|
||||
|
||||
*Don't forget to pass the prefix and postfix in the rendering as well*: `{opening_hours_table(opening_hours,yes @ &LPARENS, &RPARENS )`
|
||||
|
||||
|
||||
|
||||
### color
|
||||
|
||||
|
||||
|
||||
### color
|
||||
Shows a color picker
|
||||
|
||||
|
||||
|
||||
### image
|
||||
|
||||
|
||||
|
||||
### image
|
||||
Same as the URL-parameter, except that it checks that the URL ends with `.jpg`, `.png` or some other typical image format
|
||||
|
||||
|
||||
|
||||
### simple_tag
|
||||
|
||||
|
||||
|
||||
### simple_tag
|
||||
A simple tag of the format `key=value` where `key` conforms to a normal key `
|
||||
|
||||
|
||||
|
||||
### tag
|
||||
|
||||
|
||||
|
||||
### tag
|
||||
A simple tag of the format `key=value` OR a tagExpression
|
||||
|
||||
|
||||
|
||||
### key
|
||||
|
||||
|
||||
|
||||
### key
|
||||
Validates a key, mostly that no weird characters are used
|
||||
|
||||
|
||||
|
||||
### translation
|
||||
|
||||
|
||||
|
||||
### translation
|
||||
Makes sure the the string is of format `Record<string, string>`
|
||||
|
||||
|
||||
|
||||
### icon
|
||||
|
||||
|
||||
|
||||
### icon
|
||||
Makes sure that a valid .svg-path is added
|
||||
|
||||
|
||||
|
||||
### fediverse
|
||||
|
||||
|
||||
|
||||
### fediverse
|
||||
Validates fediverse addresses and normalizes them into `@username@server`-format
|
||||
|
||||
|
||||
|
||||
### id
|
||||
|
||||
|
||||
|
||||
### id
|
||||
Checks for valid identifiers for layers, will automatically replace spaces and uppercase
|
||||
|
||||
|
||||
|
||||
### slope
|
||||
|
||||
|
||||
|
||||
### slope
|
||||
Validates that the slope is a valid number.The accompanying input element uses the gyroscope and the compass to determine the correct incline. The sign of the incline will be set automatically. The bearing of the way is compared to the bearing of the compass, as such, the device knows if it is measuring in the forward or backward direction.
|
||||
|
||||
|
||||
|
||||
### velopark
|
||||
|
||||
|
||||
|
||||
### velopark
|
||||
A special URL-validator that checks the domain name and rewrites to the correct velopark format.
|
||||
|
||||
|
||||
|
||||
### nsi
|
||||
|
||||
|
||||
|
||||
### nsi
|
||||
Gives a list of possible suggestions for a brand or operator tag.
|
||||
|
||||
### Helper arguments
|
||||
|
|
@ -377,13 +212,8 @@ main \| The main tag to give suggestions for, e.g. `amenity=restaurant`.
|
|||
addExtraTags \| Extra tags to add to the suggestions, e.g. `nobrand=yes`.
|
||||
|
||||
|
||||
### currency
|
||||
Validates monetary amounts
|
||||
|
||||
|
||||
|
||||
### currency
|
||||
|
||||
|
||||
|
||||
Validates monetary amounts
|
||||
|
||||
This document is autogenerated from [src/UI/InputElement/Validators.ts](https://github.com/pietervdvn/MapComplete/blob/develop/src/UI/InputElement/Validators.ts)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue