From aa12634395e0aaddbc937c491af72a7ee1eb1cfb Mon Sep 17 00:00:00 2001 From: Roman Zhukov Date: Fri, 27 Oct 2023 00:05:34 +0300 Subject: [PATCH] Update docs and fix som typo. --- Docs/Architecture.md | 6 +++--- Docs/CalculatedTags.md | 6 +++--- Docs/LanguagePicker.md | 2 +- Docs/Layers/all_vending_machine.md | 2 +- Docs/SpecialRenderings.md | 6 +++--- Docs/Sponsors.md | 2 +- Docs/URL_Parameters.md | 3 +-- 7 files changed, 13 insertions(+), 14 deletions(-) diff --git a/Docs/Architecture.md b/Docs/Architecture.md index 36d0585c8..94ac0d25a 100644 --- a/Docs/Architecture.md +++ b/Docs/Architecture.md @@ -1,7 +1,7 @@ Architecture ============ -This document aims to give an architectural overview of how MapCompelte is built. It should give some feeling on how +This document aims to give an architectural overview of how MapComplete is built. It should give some feeling on how everything fits together. Servers? @@ -59,7 +59,7 @@ There are some basic elements, such as: - `List` There is one special component: the `VariableUIElement` -The `VariableUIElement` takes a `UIEventSource` and will dynamicaly show whatever the `UIEventSource` contains at the moment. +The `VariableUIElement` takes a `UIEventSource` and will dynamically show whatever the `UIEventSource` contains at the moment. For example: @@ -107,7 +107,7 @@ If Tailwind is not enough, use `baseUiElement.SetStyle("background: red; someOth ### An example -For example: the user should input wether or not a shop is closed during public holidays. There are three options: +For example: the user should input whether or not a shop is closed during public holidays. There are three options: 1. closed 2. opened as usual diff --git a/Docs/CalculatedTags.md b/Docs/CalculatedTags.md index d23c29204..7ffa0d21a 100644 --- a/Docs/CalculatedTags.md +++ b/Docs/CalculatedTags.md @@ -319,7 +319,7 @@ For example to get all objects which overlap or embed from a layer, use `_contai Also see [enclosingFeatures](#enclosingFeatures) which can be used to get all objects which fully contain this feature - 0. ...layerIds - one or more layer ids of the layer from which every feature is checked for overlap) + 0. ...layerIds - one or more layer ids of the layer from which every feature is checked for overlap ### enclosingFeatures @@ -329,7 +329,7 @@ Also see [enclosingFeatures](#enclosingFeatures) which can be used to get all ob The result is a list of features: `{feat: Polygon}[]` This function will never return the feature itself. - 0. ...layerIds - one or more layer ids of the layer from which every feature is checked for overlap) + 0. ...layerIds - one or more layer ids of the layer from which every feature is checked for overlap ### intersectionsWith @@ -341,7 +341,7 @@ Returns a `{feat: GeoJson, intersections: [number,number][]}` where `feat` is th If the current feature is a point, this function will return an empty list. Points from other layers are ignored - even if the points are parts of the current linestring. - 0. ...layerIds - one or more layer ids of the layer from which every feature is checked for intersection) + 0. ...layerIds - one or more layer ids of the layer from which every feature is checked for intersection ### closest diff --git a/Docs/LanguagePicker.md b/Docs/LanguagePicker.md index b73b93f7b..aaf1e1f3d 100644 --- a/Docs/LanguagePicker.md +++ b/Docs/LanguagePicker.md @@ -5,7 +5,7 @@ In my [little OpenStreetMap-editor](https://mapcomplete.org) translations are provided by contributors on [hosted weblate](https://hosted.weblate.org/projects/mapcomplete/), where thousands of text snippets have been translated already in the past year - which is awesome. -However, the language picker was a bit dry: it used to have codes for every langauge, e.g. `nl`, `en`, `ja`, 'pt_BR', 'zh_Hant'... Quite boring and not really user-friendly - but easy to implement. +However, the language picker was a bit dry: it used to have codes for every language, e.g. `nl`, `en`, `ja`, 'pt_BR', 'zh_Hant'... Quite boring and not really user-friendly - but easy to implement. Today, I decided to give these an overhaul. I wanted to show proper language names in them. But: in which _language_ should we show the language overview? diff --git a/Docs/Layers/all_vending_machine.md b/Docs/Layers/all_vending_machine.md index 6d7e4f02f..bcbd67380 100644 --- a/Docs/Layers/all_vending_machine.md +++ b/Docs/Layers/all_vending_machine.md @@ -175,7 +175,7 @@ The question is *Which methods of payment are accepted here?* - Unselecting this answer will add payment:qr_code=no - *Coins are accepted here* corresponds with `payment:coins=yes` - Unselecting this answer will add payment:coins=no - - *Bank notes are accepted here* corresponds with `payment:notes=yes` + - *Banknotes are accepted here* corresponds with `payment:notes=yes` - Unselecting this answer will add payment:notes=no - *Debit cards are accepted here* corresponds with `payment:debit_cards=yes` - Unselecting this answer will add payment:debit_cards=no diff --git a/Docs/SpecialRenderings.md b/Docs/SpecialRenderings.md index 2fcbcadf7..866f2d07b 100644 --- a/Docs/SpecialRenderings.md +++ b/Docs/SpecialRenderings.md @@ -5,7 +5,7 @@ -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. +In a tag rendering, 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 @@ -539,7 +539,7 @@ There are also some technicalities in your theme to keep in mind: 1. The new feature will be added and will flow through the program as any other new point as if it came from OSM. This means that there should be a layer which will match the new tags and which will display it. 2. The original feature from your geojson layer will gain the tag '_imported=yes'. - This should be used to change the appearance or even to hide it (eg by changing the icon size to zero) + This should be used to change the appearance or even to hide it (e.g. by changing the icon size to zero) 3. There should be a way for the theme to detect previously imported points, even after reloading. A reference number to the original dataset is an excellent way to do this 4. When importing ways, the theme creator is also responsible of avoiding overlapping ways. @@ -607,7 +607,7 @@ There are also some technicalities in your theme to keep in mind: 1. The new feature will be added and will flow through the program as any other new point as if it came from OSM. This means that there should be a layer which will match the new tags and which will display it. 2. The original feature from your geojson layer will gain the tag '_imported=yes'. - This should be used to change the appearance or even to hide it (eg by changing the icon size to zero) + This should be used to change the appearance or even to hide it (e.g. by changing the icon size to zero) 3. There should be a way for the theme to detect previously imported points, even after reloading. A reference number to the original dataset is an excellent way to do this 4. When importing ways, the theme creator is also responsible of avoiding overlapping ways. diff --git a/Docs/Sponsors.md b/Docs/Sponsors.md index 0637889af..5e0ef0e11 100644 --- a/Docs/Sponsors.md +++ b/Docs/Sponsors.md @@ -11,7 +11,7 @@ NL-Net is currently sponsoring Pietervdvn as well [for specific improvements](ht ## Historical sponsors -The following organisations ordered a theme to Pieter Vander Vennet and thus sponsered the project. +The following organisations ordered a theme to Pieter Vander Vennet and thus sponsored the project. As these projects are finished, they have no relation with the project anymore. Most recent projects are first: diff --git a/Docs/URL_Parameters.md b/Docs/URL_Parameters.md index a55211fd9..7ae525b85 100644 --- a/Docs/URL_Parameters.md +++ b/Docs/URL_Parameters.md @@ -43,8 +43,7 @@ This document gives an overview of which URL-parameters can be used to influence -------------------------- - -"URL-parameters are extra parts of the URL used to set the state. +URL-parameters are extra parts of the URL used to set the state. For example, if the url is `https://mapcomplete.org/cyclofix?lat=51.0&lon=4.3&z=5&test=true#node/1234`, the URL-parameters are stated in the part between the `?` and the `#`. There are multiple, all separated by `&`, namely: