forked from MapComplete/MapComplete
Partial update of the docs
This commit is contained in:
parent
ee8dbbcf7d
commit
43aeb9d191
210 changed files with 5787 additions and 1201 deletions
|
|
@ -48,14 +48,28 @@ In other words: use `{ "before": ..., "after": ..., "special": {"type": ..., "ar
|
|||
|
||||
1. [Special tag renderings](#special-tag-renderings)
|
||||
* [Using expanded syntax](#using-expanded-syntax)
|
||||
+ [questions](#questions)
|
||||
* [Example usage of questions](#example-usage-of-questions)
|
||||
+ [add_new_point](#add_new_point)
|
||||
* [Example usage of add_new_point](#example-usage-of-add_new_point)
|
||||
+ [user_profile](#user_profile)
|
||||
* [Example usage of user_profile](#example-usage-of-user_profile)
|
||||
+ [language_picker](#language_picker)
|
||||
* [Example usage of language_picker](#example-usage-of-language_picker)
|
||||
+ [logout](#logout)
|
||||
* [Example usage of logout](#example-usage-of-logout)
|
||||
+ [histogram](#histogram)
|
||||
* [Example usage of histogram](#example-usage-of-histogram)
|
||||
+ [steal](#steal)
|
||||
* [Example usage of steal](#example-usage-of-steal)
|
||||
+ [minimap](#minimap)
|
||||
* [Example usage of minimap](#example-usage-of-minimap)
|
||||
+ [sided_minimap](#sided_minimap)
|
||||
* [Example usage of sided_minimap](#example-usage-of-sided_minimap)
|
||||
+ [split_button](#split_button)
|
||||
* [Example usage of split_button](#example-usage-of-split_button)
|
||||
+ [move_button](#move_button)
|
||||
* [Example usage of move_button](#example-usage-of-move_button)
|
||||
+ [delete_button](#delete_button)
|
||||
* [Example usage of delete_button](#example-usage-of-delete_button)
|
||||
+ [share_link](#share_link)
|
||||
* [Example usage of share_link](#example-usage-of-share_link)
|
||||
+ [upload_to_osm](#upload_to_osm)
|
||||
|
|
@ -66,20 +80,26 @@ In other words: use `{ "before": ..., "after": ..., "special": {"type": ..., "ar
|
|||
* [Example usage of export_as_gpx](#example-usage-of-export_as_gpx)
|
||||
+ [add_note_comment](#add_note_comment)
|
||||
* [Example usage of add_note_comment](#example-usage-of-add_note_comment)
|
||||
+ [open_note](#open_note)
|
||||
* [Example usage of open_note](#example-usage-of-open_note)
|
||||
+ [close_note](#close_note)
|
||||
* [Example usage of close_note](#example-usage-of-close_note)
|
||||
+ [plantnet_detection](#plantnet_detection)
|
||||
* [Example usage of plantnet_detection](#example-usage-of-plantnet_detection)
|
||||
+ [tag_apply](#tag_apply)
|
||||
* [Example usage of tag_apply](#example-usage-of-tag_apply)
|
||||
+ [import_button](#import_button)
|
||||
* [Example usage of import_button](#example-usage-of-import_button)
|
||||
+ [import_way_button](#import_way_button)
|
||||
* [Example usage of import_way_button](#example-usage-of-import_way_button)
|
||||
+ [conflate_button](#conflate_button)
|
||||
* [Example usage of conflate_button](#example-usage-of-conflate_button)
|
||||
+ [tag_apply](#tag_apply)
|
||||
* [Example usage of tag_apply](#example-usage-of-tag_apply)
|
||||
+ [close_note](#close_note)
|
||||
* [Example usage of close_note](#example-usage-of-close_note)
|
||||
+ [nearby_images](#nearby_images)
|
||||
* [Example usage of nearby_images](#example-usage-of-nearby_images)
|
||||
+ [wikipedia](#wikipedia)
|
||||
* [Example usage of wikipedia](#example-usage-of-wikipedia)
|
||||
+ [wikidata_label](#wikidata_label)
|
||||
* [Example usage of wikidata_label](#example-usage-of-wikidata_label)
|
||||
+ [mapillary_link](#mapillary_link)
|
||||
* [Example usage of mapillary_link](#example-usage-of-mapillary_link)
|
||||
+ [language_chooser](#language_chooser)
|
||||
|
|
@ -90,10 +110,6 @@ In other words: use `{ "before": ..., "after": ..., "special": {"type": ..., "ar
|
|||
* [Example usage of image_carousel](#example-usage-of-image_carousel)
|
||||
+ [image_upload](#image_upload)
|
||||
* [Example usage of image_upload](#example-usage-of-image_upload)
|
||||
+ [wikipedia](#wikipedia)
|
||||
* [Example usage of wikipedia](#example-usage-of-wikipedia)
|
||||
+ [wikidata_label](#wikidata_label)
|
||||
* [Example usage of wikidata_label](#example-usage-of-wikidata_label)
|
||||
+ [reviews](#reviews)
|
||||
* [Example usage of reviews](#example-usage-of-reviews)
|
||||
+ [opening_hours_table](#opening_hours_table)
|
||||
|
|
@ -124,6 +140,8 @@ In other words: use `{ "before": ..., "after": ..., "special": {"type": ..., "ar
|
|||
* [Example usage of statistics](#example-usage-of-statistics)
|
||||
+ [send_email](#send_email)
|
||||
* [Example usage of send_email](#example-usage-of-send_email)
|
||||
+ [link](#link)
|
||||
* [Example usage of link](#example-usage-of-link)
|
||||
+ [multi](#multi)
|
||||
* [Example usage of multi](#example-usage-of-multi)
|
||||
+ [auto_apply](#auto_apply)
|
||||
|
|
@ -133,6 +151,62 @@ In other words: use `{ "before": ..., "after": ..., "special": {"type": ..., "ar
|
|||
|
||||
|
||||
|
||||
### questions
|
||||
|
||||
The special element which shows the questions which are unkown. Added by default if not yet there
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
labels | _undefined_ | One or more ';'-separated labels. If these are given, only questions with these labels will be given. Use `unlabeled` for all questions that don't have an explicit label. If none given, all questions will be shown
|
||||
blacklisted-labels | _undefined_ | One or more ';'-separated labels of questions which should _not_ be included
|
||||
|
||||
|
||||
#### Example usage of questions
|
||||
|
||||
`{questions(,)}`
|
||||
|
||||
|
||||
|
||||
### add_new_point
|
||||
|
||||
An element which allows to add a new point on the 'last_click'-location. Only makes sense in the layer `last_click`
|
||||
|
||||
#### Example usage of add_new_point
|
||||
|
||||
`{add_new_point()}`
|
||||
|
||||
|
||||
|
||||
### user_profile
|
||||
|
||||
A component showing information about the currently logged in user (username, profile description, profile picture + link to edit them). Mostly meant to be used in the 'user-settings'
|
||||
|
||||
#### Example usage of user_profile
|
||||
|
||||
`{user_profile()}`
|
||||
|
||||
|
||||
|
||||
### language_picker
|
||||
|
||||
A component to set the language of the user interface
|
||||
|
||||
#### Example usage of language_picker
|
||||
|
||||
`{language_picker()}`
|
||||
|
||||
|
||||
|
||||
### logout
|
||||
|
||||
Shows a button where the user can log out
|
||||
|
||||
#### Example usage of logout
|
||||
|
||||
`{logout()}`
|
||||
|
||||
|
||||
|
||||
### histogram
|
||||
|
||||
Create a histogram for a list of given values, read from the properties.
|
||||
|
|
@ -147,7 +221,7 @@ colors* | _undefined_ | (Matches all resting arguments - optional) Matches a reg
|
|||
|
||||
#### Example usage of histogram
|
||||
|
||||
`{histogram('some_key')}` with properties being `{some_key: ['a','b','a','c']} to create a histogram
|
||||
`{histogram('some_key')}` with properties being `{some_key: ["a","b","a","c"]} to create a histogram
|
||||
|
||||
|
||||
|
||||
|
|
@ -183,18 +257,33 @@ idKey | id | (Matches all resting arguments) This argument should be the key of
|
|||
|
||||
|
||||
|
||||
### sided_minimap
|
||||
### split_button
|
||||
|
||||
A small map showing _only one side_ the selected feature. *This features requires to have linerenderings with offset* as only linerenderings with a postive or negative offset will be shown. Note: in most cases, this map will be automatically introduced
|
||||
Adds a button which allows to split a way
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
side | _undefined_ | The side to show, either `left` or `right`
|
||||
|
||||
#### Example usage of split_button
|
||||
|
||||
#### Example usage of sided_minimap
|
||||
`{split_button()}`
|
||||
|
||||
`{sided_minimap(left)}`
|
||||
|
||||
|
||||
### move_button
|
||||
|
||||
Adds a button which allows to move the object to another location. The config will be read from the layer config
|
||||
|
||||
#### Example usage of move_button
|
||||
|
||||
`{move_button()}`
|
||||
|
||||
|
||||
|
||||
### delete_button
|
||||
|
||||
Adds a button which allows to delete the object at this location. The config will be read from the layer config
|
||||
|
||||
#### Example usage of delete_button
|
||||
|
||||
`{delete_button()}`
|
||||
|
||||
|
||||
|
||||
|
|
@ -267,6 +356,36 @@ Id-key | id | The property name where the ID of the note to close can be found
|
|||
|
||||
|
||||
|
||||
### open_note
|
||||
|
||||
Creates a new map note on the given location. This options is placed in the 'last_click'-popup automatically if the 'notes'-layer is enabled
|
||||
|
||||
#### Example usage of open_note
|
||||
|
||||
`{open_note()}`
|
||||
|
||||
|
||||
|
||||
### close_note
|
||||
|
||||
Button to close a note. A predifined text can be defined to close the note with. If the note is already closed, will show a small text.
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
text | _undefined_ | Text to show on this button
|
||||
icon | checkmark.svg | Icon to show
|
||||
idkey | id | The property name where the ID of the note to close can be found
|
||||
comment | _undefined_ | Text to add onto the note when closing
|
||||
minZoom | _undefined_ | If set, only show the closenote button if zoomed in enough
|
||||
zoomButton | _undefined_ | Text to show if not zoomed in enough
|
||||
|
||||
|
||||
#### Example usage of close_note
|
||||
|
||||
`{close_note(,checkmark.svg,id,,,)}`
|
||||
|
||||
|
||||
|
||||
### plantnet_detection
|
||||
|
||||
Sends the images linked to the current object to plantnet.org and asks it what plant species is shown on it. The user can then select the correct species; the corresponding wikidata-identifier will then be added to the object (together with `source:species:wikidata=plantnet.org AI`).
|
||||
|
|
@ -282,6 +401,37 @@ image_key | image,mapillary,image,wikidata,wikimedia_commons,image,image | The k
|
|||
|
||||
|
||||
|
||||
### tag_apply
|
||||
|
||||
Shows a big button; clicking this button will apply certain tags onto the feature.
|
||||
|
||||
The first argument takes a specification of which tags to add.
|
||||
These can either be a tag to add, such as `amenity=fast_food` or can use a substitution, e.g. `addr:housenumber=$number`.
|
||||
This new point will then have the tags `amenity=fast_food` and `addr:housenumber` with the value that was saved in `number` in the original feature.
|
||||
|
||||
If a value to substitute is undefined, empty string will be used instead.
|
||||
|
||||
This supports multiple values, e.g. `ref=$source:geometry:type/$source:geometry:ref`
|
||||
|
||||
Remark that the syntax is slightly different then expected; it uses '$' to note a value to copy, followed by a name (matched with `[a-zA-Z0-9_:]*`). Sadly, delimiting with `{}` as these already mark the boundaries of the special rendering...
|
||||
|
||||
Note that these values can be prepare with javascript in the theme by using a [calculatedTag](calculatedTags.md#calculating-tags-with-javascript)
|
||||
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
tags_to_apply | _undefined_ | A specification of the tags to apply
|
||||
message | _undefined_ | The text to show to the contributor
|
||||
image | _undefined_ | An image to show to the contributor on the button
|
||||
id_of_object_to_apply_this_one | _undefined_ | If specified, applies the the tags onto _another_ object. The id will be read from properties[id_of_object_to_apply_this_one] of the selected object. The tags are still calculated based on the tags of the _selected_ element
|
||||
|
||||
|
||||
#### Example usage of tag_apply
|
||||
|
||||
`{tag_apply(survey_date=$_now:date, Surveyed today!)}`, `{tag_apply(addr:street=$addr:street, Apply the address, apply_icon.svg, _closest_osm_id)
|
||||
|
||||
|
||||
|
||||
### import_button
|
||||
|
||||
This button will copy the point from an external dataset into OpenStreetMap
|
||||
|
|
@ -477,57 +627,6 @@ way_to_conflate | _undefined_ | The key, of which the corresponding value is the
|
|||
|
||||
|
||||
|
||||
### tag_apply
|
||||
|
||||
Shows a big button; clicking this button will apply certain tags onto the feature.
|
||||
|
||||
The first argument takes a specification of which tags to add.
|
||||
These can either be a tag to add, such as `amenity=fast_food` or can use a substitution, e.g. `addr:housenumber=$number`.
|
||||
This new point will then have the tags `amenity=fast_food` and `addr:housenumber` with the value that was saved in `number` in the original feature.
|
||||
|
||||
If a value to substitute is undefined, empty string will be used instead.
|
||||
|
||||
This supports multiple values, e.g. `ref=$source:geometry:type/$source:geometry:ref`
|
||||
|
||||
Remark that the syntax is slightly different then expected; it uses '$' to note a value to copy, followed by a name (matched with `[a-zA-Z0-9_:]*`). Sadly, delimiting with `{}` as these already mark the boundaries of the special rendering...
|
||||
|
||||
Note that these values can be prepare with javascript in the theme by using a [calculatedTag](calculatedTags.md#calculating-tags-with-javascript)
|
||||
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
tags_to_apply | _undefined_ | A specification of the tags to apply
|
||||
message | _undefined_ | The text to show to the contributor
|
||||
image | _undefined_ | An image to show to the contributor on the button
|
||||
id_of_object_to_apply_this_one | _undefined_ | If specified, applies the the tags onto _another_ object. The id will be read from properties[id_of_object_to_apply_this_one] of the selected object. The tags are still calculated based on the tags of the _selected_ element
|
||||
|
||||
|
||||
#### Example usage of tag_apply
|
||||
|
||||
`{tag_apply(survey_date=$_now:date, Surveyed today!)}`, `{tag_apply(addr:street=$addr:street, Apply the address, apply_icon.svg, _closest_osm_id)
|
||||
|
||||
|
||||
|
||||
### close_note
|
||||
|
||||
Button to close a note. A predifined text can be defined to close the note with. If the note is already closed, will show a small text.
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
text | _undefined_ | Text to show on this button
|
||||
icon | checkmark.svg | Icon to show
|
||||
idkey | id | The property name where the ID of the note to close can be found
|
||||
comment | _undefined_ | Text to add onto the note when closing
|
||||
minZoom | _undefined_ | If set, only show the closenote button if zoomed in enough
|
||||
zoomButton | _undefined_ | Text to show if not zoomed in enough
|
||||
|
||||
|
||||
#### Example usage of close_note
|
||||
|
||||
`{close_note(,checkmark.svg,id,,,)}`
|
||||
|
||||
|
||||
|
||||
### nearby_images
|
||||
|
||||
A component showing nearby images loaded from various online services such as Mapillary. In edit mode and when used on a feature, the user can select an image to add to the feature
|
||||
|
|
@ -548,6 +647,36 @@ mapillary | true | If 'true', includes a link to mapillary on this location.
|
|||
|
||||
|
||||
|
||||
### wikipedia
|
||||
|
||||
A box showing the corresponding wikipedia article - based on the wikidata tag
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
keyToShowWikipediaFor | wikidata;wikipedia | Use the wikidata entry from this key to show the wikipedia article for. Multiple keys can be given (separated by ';'), in which case the first matching value is used
|
||||
|
||||
|
||||
#### Example usage of wikipedia
|
||||
|
||||
`{wikipedia()}` is a basic example, `{wikipedia(name:etymology:wikidata)}` to show the wikipedia page of whom the feature was named after. Also remember that these can be styled, e.g. `{wikipedia():max-height: 10rem}` to limit the height
|
||||
|
||||
|
||||
|
||||
### wikidata_label
|
||||
|
||||
Shows the label of the corresponding wikidata-item
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
keyToShowWikidataFor | wikidata | Use the wikidata entry from this key to show the label
|
||||
|
||||
|
||||
#### Example usage of wikidata_label
|
||||
|
||||
`{wikidata_label()}` is a basic example, `{wikipedia(name:etymology:wikidata)}` to show the label itself
|
||||
|
||||
|
||||
|
||||
### mapillary_link
|
||||
|
||||
Adds a button to open mapillary on the specified location
|
||||
|
|
@ -625,36 +754,6 @@ label | Add image | The text to show on the button
|
|||
|
||||
|
||||
|
||||
### wikipedia
|
||||
|
||||
A box showing the corresponding wikipedia article - based on the wikidata tag
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
keyToShowWikipediaFor | wikidata;wikipedia | Use the wikidata entry from this key to show the wikipedia article for. Multiple keys can be given (separated by ';'), in which case the first matching value is used
|
||||
|
||||
|
||||
#### Example usage of wikipedia
|
||||
|
||||
`{wikipedia()}` is a basic example, `{wikipedia(name:etymology:wikidata)}` to show the wikipedia page of whom the feature was named after. Also remember that these can be styled, e.g. `{wikipedia():max-height: 10rem}` to limit the height
|
||||
|
||||
|
||||
|
||||
### wikidata_label
|
||||
|
||||
Shows the label of the corresponding wikidata-item
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
keyToShowWikidataFor | wikidata | Use the wikidata entry from this key to show the label
|
||||
|
||||
|
||||
#### Example usage of wikidata_label
|
||||
|
||||
`{wikidata_label()}` is a basic example, `{wikipedia(name:etymology:wikidata)}` to show the label itself
|
||||
|
||||
|
||||
|
||||
### reviews
|
||||
|
||||
Adds an overview of the mangrove-reviews of this object. Mangrove.Reviews needs - in order to identify the reviewed object - a coordinate and a name. By default, the name of the object is given, but this can be overwritten
|
||||
|
|
@ -876,6 +975,23 @@ button_text | _undefined_ | The text shown on the button in the UI
|
|||
|
||||
|
||||
|
||||
### link
|
||||
|
||||
Construct a link. By using the 'special' visualisation notation, translation should be easier
|
||||
|
||||
name | default | description
|
||||
------ | --------- | -------------
|
||||
text | _undefined_ | Text to be shown
|
||||
href | _undefined_ | The URL to link to
|
||||
class | _undefined_ | CSS-classes to add to the element
|
||||
|
||||
|
||||
#### Example usage of link
|
||||
|
||||
`{link(,,)}`
|
||||
|
||||
|
||||
|
||||
### multi
|
||||
|
||||
Given an embedded tagRendering (read only) and a key, will read the keyname as a JSON-list. Every element of this list will be considered as tags and rendered with the tagRendering
|
||||
|
|
@ -908,7 +1024,7 @@ tagrendering | _undefined_ | An entire tagRenderingConfig
|
|||
|
||||
A button to run many actions for many features at once. To effectively use this button, you'll need some ingredients:
|
||||
|
||||
- A target layer with features for which an action is defined in a tag rendering. The following special visualisations support an autoAction: import_way_button, tag_apply
|
||||
- A target layer with features for which an action is defined in a tag rendering. The following special visualisations support an autoAction: tag_apply, import_way_button
|
||||
- A host feature to place the auto-action on. This can be a big outline (such as a city). Another good option for this is the layer
|
||||
- [current_view](./BuiltinLayers.md#current_view)
|
||||
- Then, use a calculated tag on the host feature to determine the overlapping object ids
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue