From 3edca23b904b76616088bf8706458a8c2ae9a942 Mon Sep 17 00:00:00 2001 From: pietervdvn Date: Sun, 3 Apr 2022 03:49:09 +0200 Subject: [PATCH] Regen docs --- Docs/BuiltinIndex.md | 2 ++ Docs/Layers/bicycle_rental.md | 28 ++++++++++++++-------------- Docs/Layers/bike_shop.md | 10 +++++----- Docs/Layers/playground.md | 18 ++++++++++++++++++ Docs/Layers/village_green.md | 2 +- Docs/SpecialRenderings.md | 24 ++++++++++++++++++------ Docs/URL_Parameters.md | 16 ++++++++++++++++ UI/i18n/Locale.ts | 21 ++++++++++----------- 8 files changed, 84 insertions(+), 37 deletions(-) diff --git a/Docs/BuiltinIndex.md b/Docs/BuiltinIndex.md index 45660d4cb..fce8d62d3 100644 --- a/Docs/BuiltinIndex.md +++ b/Docs/BuiltinIndex.md @@ -110,6 +110,7 @@ - food - nature_reserve - observation_tower + - playground - recycling @@ -155,6 +156,7 @@ - bicycle_library - bicycle_rental + - bike_shop - bike_themed_object - cafe_pub - food diff --git a/Docs/Layers/bicycle_rental.md b/Docs/Layers/bicycle_rental.md index a4da7fd78..a1dad6036 100644 --- a/Docs/Layers/bicycle_rental.md +++ b/Docs/Layers/bicycle_rental.md @@ -257,10 +257,10 @@ This is rendered with `{rental} is rented here` -The question is **How much [object Object] can be rented here? ** +The question is **How much city bikes can be rented here? ** This rendering asks information about the property [capacity:city_bike](https://wiki.openstreetmap.org/wiki/Key:capacity:city_bike) -This is rendered with `{capacity:city_bike} [object Object] can be rented here` +This is rendered with `{capacity:city_bike} city bikes can be rented here` @@ -278,10 +278,10 @@ _This tagrendering has no question and is thus read-only_ -The question is **How much [object Object] can be rented here? ** +The question is **How much electrical bikes can be rented here? ** This rendering asks information about the property [capacity:ebike](https://wiki.openstreetmap.org/wiki/Key:capacity:ebike) -This is rendered with `{capacity:ebike} [object Object] can be rented here` +This is rendered with `{capacity:ebike} electrical bikes can be rented here` @@ -299,10 +299,10 @@ _This tagrendering has no question and is thus read-only_ -The question is **How much [object Object] can be rented here? ** +The question is **How much bikes for children can be rented here? ** This rendering asks information about the property [capacity:kid_bike](https://wiki.openstreetmap.org/wiki/Key:capacity:kid_bike) -This is rendered with `{capacity:kid_bike} [object Object] can be rented here` +This is rendered with `{capacity:kid_bike} bikes for children can be rented here` @@ -320,10 +320,10 @@ _This tagrendering has no question and is thus read-only_ -The question is **How much [object Object] can be rented here? ** +The question is **How much BMX bikes can be rented here? ** This rendering asks information about the property [capacity:bmx](https://wiki.openstreetmap.org/wiki/Key:capacity:bmx) -This is rendered with `{capacity:bmx} [object Object] can be rented here` +This is rendered with `{capacity:bmx} BMX bikes can be rented here` @@ -341,10 +341,10 @@ _This tagrendering has no question and is thus read-only_ -The question is **How much [object Object] can be rented here? ** +The question is **How much mountainbike can be rented here? ** This rendering asks information about the property [capacity:mtb](https://wiki.openstreetmap.org/wiki/Key:capacity:mtb) -This is rendered with `{capacity:mtb} [object Object] can be rented here` +This is rendered with `{capacity:mtb} mountainbike can be rented here` @@ -362,10 +362,10 @@ _This tagrendering has no question and is thus read-only_ -The question is **How much [object Object] can be rented here? ** +The question is **How much bicycle panniers can be rented here? ** This rendering asks information about the property [capacity:bicycle_pannier](https://wiki.openstreetmap.org/wiki/Key:capacity:bicycle_pannier) -This is rendered with `{capacity:bicycle_pannier} [object Object] can be rented here` +This is rendered with `{capacity:bicycle_pannier} bicycle panniers can be rented here` @@ -383,10 +383,10 @@ _This tagrendering has no question and is thus read-only_ -The question is **How much [object Object] can be rented here? ** +The question is **How much tandem can be rented here? ** This rendering asks information about the property [capacity:tandem_bicycle](https://wiki.openstreetmap.org/wiki/Key:capacity:tandem_bicycle) -This is rendered with `{capacity:tandem_bicycle} [object Object] can be rented here` +This is rendered with `{capacity:tandem_bicycle} tandem can be rented here` diff --git a/Docs/Layers/bike_shop.md b/Docs/Layers/bike_shop.md index db81de920..4cbae7ee1 100644 --- a/Docs/Layers/bike_shop.md +++ b/Docs/Layers/bike_shop.md @@ -24,7 +24,7 @@ A shop specifically selling bicycles or related items + [bike_shop-website](#bike_shop-website) + [bike_shop-phone](#bike_shop-phone) + [bike_shop-email](#bike_shop-email) - + [bike_shop-opening_hours](#bike_shop-opening_hours) + + [opening_hours](#opening_hours) + [description](#description) + [bike_shop-access](#bike_shop-access) + [bike_repair_sells-bikes](#bike_repair_sells-bikes) @@ -169,14 +169,14 @@ This is rendered with `{email}` -### bike_shop-opening_hours +### opening_hours -The question is **When is this shop opened?** +The question is **What are the opening hours of {title()}?** This rendering asks information about the property [opening_hours](https://wiki.openstreetmap.org/wiki/Key:opening_hours) -This is rendered with `{opening_hours_table(opening_hours)}` +This is rendered with `

Opening hours

{opening_hours_table(opening_hours)}` @@ -198,7 +198,7 @@ This is rendered with `{description}` _This tagrendering has no question and is thus read-only_ This rendering asks information about the property [access](https://wiki.openstreetmap.org/wiki/Key:access) -This is rendered with `Enkel voor {access}` +This is rendered with `Only accessible to {access}` diff --git a/Docs/Layers/playground.md b/Docs/Layers/playground.md index fe3c54bc0..d12249fbb 100644 --- a/Docs/Layers/playground.md +++ b/Docs/Layers/playground.md @@ -25,6 +25,7 @@ Playgrounds + [playground-max_age](#playground-max_age) + [playground-operator](#playground-operator) + [playground-access](#playground-access) + + [website](#website) + [playground-email](#playground-email) + [playground-phone](#playground-phone) + [Playground-wheelchair](#playground-wheelchair) @@ -88,6 +89,7 @@ attribute | type | values which are supported by this layer [](https://taginfo.openstreetmap.org/keys/min_age#values) [min_age](https://wiki.openstreetmap.org/wiki/Key:min_age) | [pnat](../SpecialInputElements.md#pnat) | [](https://taginfo.openstreetmap.org/keys/max_age#values) [max_age](https://wiki.openstreetmap.org/wiki/Key:max_age) | [pnat](../SpecialInputElements.md#pnat) | [](https://taginfo.openstreetmap.org/keys/operator#values) [operator](https://wiki.openstreetmap.org/wiki/Key:operator) | [string](../SpecialInputElements.md#string) | +[](https://taginfo.openstreetmap.org/keys/website#values) [website](https://wiki.openstreetmap.org/wiki/Key:website) | [url](../SpecialInputElements.md#url) | [](https://taginfo.openstreetmap.org/keys/email#values) [email](https://wiki.openstreetmap.org/wiki/Key:email) | [email](../SpecialInputElements.md#email) | [](https://taginfo.openstreetmap.org/keys/phone#values) [phone](https://wiki.openstreetmap.org/wiki/Key:phone) | [phone](../SpecialInputElements.md#phone) | [](https://taginfo.openstreetmap.org/keys/wheelchair#values) [wheelchair](https://wiki.openstreetmap.org/wiki/Key:wheelchair) | Multiple choice | [yes](https://wiki.openstreetmap.org/wiki/Tag:wheelchair%3Dyes) [limited](https://wiki.openstreetmap.org/wiki/Tag:wheelchair%3Dlimited) [no](https://wiki.openstreetmap.org/wiki/Tag:wheelchair%3Dno) @@ -197,6 +199,22 @@ The question is **Is this playground accessible to the general public?** +### website + + + +The question is **What is the website of {title()}?** + +This rendering asks information about the property [website](https://wiki.openstreetmap.org/wiki/Key:website) +This is rendered with `{website}` + + + + - **{contact:website}** corresponds with contact:website~^..*$_This option cannot be chosen as answer_ + + + + ### playground-email diff --git a/Docs/Layers/village_green.md b/Docs/Layers/village_green.md index 0eadc8fbc..626b753d6 100644 --- a/Docs/Layers/village_green.md +++ b/Docs/Layers/village_green.md @@ -7,7 +7,7 @@ -A layer showing village-green (which are communal green areas, but not quite parks" +A layer showing village-green (which are communal green areas, but not quite parks) diff --git a/Docs/SpecialRenderings.md b/Docs/SpecialRenderings.md index 8ad63a77a..b268df998 100644 --- a/Docs/SpecialRenderings.md +++ b/Docs/SpecialRenderings.md @@ -5,9 +5,24 @@ +In a tagrendering, some special values are substituted by an advanced UI-element. This allows advanced features and visualizations to be reused by custom themes or even to query third-party API's. + +General usage is `{func_name()}`, `{func_name(arg, someotherarg)}` or `{func_name(args):cssStyle}`. Note that you _do not_ need to use quotes around your arguments, the comma is enough to separate them. This also implies you cannot use a comma in your args + + + +#### Using expanded syntax + + + +Instead of using `{"render": {"en": "{some_special_visualisation(some_arg, some other really long message, more args)} , "nl": "{some_special_visualisation(some_arg, een boodschap in een andere taal, more args)}}, one can also write + +{"render":{"special":{"type":"some_special_visualisation","argname":"some_arg","message":{"en":"some other really long message","nl":"een boodschap in een andere taal"},"other_arg_name":"more args"}}} + ## Table of contents 1. [Special tag renderings](#special-tag-renderings) + * [Using expanded syntax](#using-expanded-syntax) + [all_tags](#all_tags) * [Example usage of all_tags](#example-usage-of-all_tags) + [image_carousel](#image_carousel) @@ -65,10 +80,6 @@ -In a tagrendering, some special values are substituted by an advanced UI-element. This allows advanced features and visualizations to be reused by custom themes or even to query third-party API's. - -General usage is `{func_name()}`, `{func_name(arg, someotherarg)}` or `{func_name(args):cssStyle}`. Note that you _do not_ need to use quotes around your arguments, the comma is enough to separate them. This also implies you cannot use a comma in your args - ### all_tags @@ -87,7 +98,7 @@ General usage is `{func_name()}`, `{func_name(arg, someotherarg)}` or `{func_nam name | default | description ------ | --------- | ------------- -image key/prefix (multiple values allowed if comma-seperated) | image,mapillary,image,wikidata,wikimedia_commons,image,image | The keys given to the images, e.g. if image is given, the first picture URL will be added as image, the second as image:0, the third as image:1, etc... +image_key | image,mapillary,image,wikidata,wikimedia_commons,image,image | The keys given to the images, e.g. if image is given, the first picture URL will be added as image, the second as image:0, the third as image:1, etc... Multiple values are allowed if ';'-separated #### Example usage of image_carousel @@ -312,11 +323,12 @@ icon | ./assets/svg/addSmall.svg | A nice icon to show in the button snap_onto_layers | _undefined_ | If a way of the given layer(s) is closeby, will snap the new point onto this way (similar as preset might snap). To show multiple layers to snap onto, use a `;`-seperated list max_snap_distance | 5 | The maximum distance that the imported point will be moved to snap onto a way in an already existing layer (in meters). This is previewed to the contributor, similar to the 'add new point'-action of MapComplete note_id | _undefined_ | If given, this key will be read. The corresponding note on OSM will be closed, stating 'imported' +location_picker | photo | Chooses the background for the precise location picker, options are 'map', 'photo' or 'osmbasedmap' or 'none' if the precise input picker should be disabled #### Example usage of import_button - `{import_button(,,Import this data into OpenStreetMap,./assets/svg/addSmall.svg,,5,)}` + `{import_button(,,Import this data into OpenStreetMap,./assets/svg/addSmall.svg,,5,,photo)}` diff --git a/Docs/URL_Parameters.md b/Docs/URL_Parameters.md index c1eb48376..de23e4955 100644 --- a/Docs/URL_Parameters.md +++ b/Docs/URL_Parameters.md @@ -9,6 +9,8 @@ 1. [URL-parameters and URL-hash](#url-parameters-and-url-hash) - [What is a URL parameter?](#what-is-a-url-parameter) + - [language](#language) + - [fs-translation-mode](#fs-translation-mode) - [fs-userbadge](#fs-userbadge) - [fs-search](#fs-search) - [fs-background](#fs-background) @@ -60,6 +62,20 @@ Finally, the URL-hash is the part after the `#`. It is `node/1234` in this case. + language +---------- + + The language to display mapcomplete in. Will be ignored in case a logged-in-user did set their language before. If the specified language does not exist, it will default to the first language in the theme. No default value set + + + + fs-translation-mode +--------------------- + + If set, will show a translation button next to every string. The default value is _false_ + + + fs-userbadge -------------- diff --git a/UI/i18n/Locale.ts b/UI/i18n/Locale.ts index 21f950501..9fda1d07b 100644 --- a/UI/i18n/Locale.ts +++ b/UI/i18n/Locale.ts @@ -16,18 +16,17 @@ export default class Locale { window.setLanguage = function (language: string) { source.setData(language) } - source.syncWith( - QueryParameters.GetQueryParameter("language", undefined, "The language to display mapcomplete in. Will be ignored in case a logged-in-user did set their language before. If the specified language does not exist, it will default to the first language in the theme."), - true - ) - QueryParameters.GetBooleanQueryParameter("fs-translation-mode",false,"If set, will show the translation buttons") - .addCallbackAndRunD(tr => { - console.log("Query parameter for translation mode is", tr) - Locale.showLinkToWeblate.setData(Locale.showLinkToWeblate.data || tr); - }) - - } + source.syncWith( + QueryParameters.GetQueryParameter("language", undefined, "The language to display mapcomplete in. Will be ignored in case a logged-in-user did set their language before. If the specified language does not exist, it will default to the first language in the theme."), + true + ) + QueryParameters.GetBooleanQueryParameter("fs-translation-mode",false,"If set, will show a translation button next to every string.") + .addCallbackAndRunD(tr => { + Locale.showLinkToWeblate.setData(Locale.showLinkToWeblate.data || tr); + }) + + return source; } }