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

Merge pull request #1688 from ka1bi4/update/docs-some-fix-improves

Browse source 
Update docs and fix som typo.
This commit is contained in:
Pieter Vander Vennet 2023-10-26 23:09:03 +02:00 committed by GitHub
commit 57af2116de
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 13 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
Docs/Architecture.md
View file

@ -1,7 +1,7 @@
Architecture 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. everything fits together.
Servers? Servers?
@ -59,7 +59,7 @@ There are some basic elements, such as:
- `List` - `List`
There is one special component: the `VariableUIElement` There is one special component: the `VariableUIElement`
The `VariableUIElement` takes a `UIEventSource<string|BaseUIElement>` and will dynamicaly show whatever the `UIEventSource` contains at the moment. The `VariableUIElement` takes a `UIEventSource<string|BaseUIElement>` and will dynamically show whatever the `UIEventSource` contains at the moment.
For example: For example:
@ -107,7 +107,7 @@ If Tailwind is not enough, use `baseUiElement.SetStyle("background: red; someOth
### An example ### 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 1. closed
2. opened as usual 2. opened as usual

6
Docs/CalculatedTags.md
View file

@ -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 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 ### 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}[]` The result is a list of features: `{feat: Polygon}[]`
This function will never return the feature itself. 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 ### 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. 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. 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 ### closest

2
Docs/LanguagePicker.md
View file

@ -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. 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? 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?

2
Docs/Layers/all_vending_machine.md
View file

@ -175,7 +175,7 @@ The question is *Which methods of payment are accepted here?*
- Unselecting this answer will add <a href='https://wiki.openstreetmap.org/wiki/Key:payment:qr_code' target='_blank'>payment:qr_code</a>=<a href='https://wiki.openstreetmap.org/wiki/Tag:payment:qr_code%3Dno' target='_blank'>no</a> - Unselecting this answer will add <a href='https://wiki.openstreetmap.org/wiki/Key:payment:qr_code' target='_blank'>payment:qr_code</a>=<a href='https://wiki.openstreetmap.org/wiki/Tag:payment:qr_code%3Dno' target='_blank'>no</a>
- *Coins are accepted here* corresponds with `payment:coins=yes` - *Coins are accepted here* corresponds with `payment:coins=yes`
- Unselecting this answer will add <a href='https://wiki.openstreetmap.org/wiki/Key:payment:coins' target='_blank'>payment:coins</a>=<a href='https://wiki.openstreetmap.org/wiki/Tag:payment:coins%3Dno' target='_blank'>no</a> - Unselecting this answer will add <a href='https://wiki.openstreetmap.org/wiki/Key:payment:coins' target='_blank'>payment:coins</a>=<a href='https://wiki.openstreetmap.org/wiki/Tag:payment:coins%3Dno' target='_blank'>no</a>
- *Bank notes are accepted here* corresponds with `payment:notes=yes` - *Banknotes are accepted here* corresponds with `payment:notes=yes`
- Unselecting this answer will add <a href='https://wiki.openstreetmap.org/wiki/Key:payment:notes' target='_blank'>payment:notes</a>=<a href='https://wiki.openstreetmap.org/wiki/Tag:payment:notes%3Dno' target='_blank'>no</a> - Unselecting this answer will add <a href='https://wiki.openstreetmap.org/wiki/Key:payment:notes' target='_blank'>payment:notes</a>=<a href='https://wiki.openstreetmap.org/wiki/Tag:payment:notes%3Dno' target='_blank'>no</a>
- *Debit cards are accepted here* corresponds with `payment:debit_cards=yes` - *Debit cards are accepted here* corresponds with `payment:debit_cards=yes`
- Unselecting this answer will add <a href='https://wiki.openstreetmap.org/wiki/Key:payment:debit_cards' target='_blank'>payment:debit_cards</a>=<a href='https://wiki.openstreetmap.org/wiki/Tag:payment:debit_cards%3Dno' target='_blank'>no</a> - Unselecting this answer will add <a href='https://wiki.openstreetmap.org/wiki/Key:payment:debit_cards' target='_blank'>payment:debit_cards</a>=<a href='https://wiki.openstreetmap.org/wiki/Tag:payment:debit_cards%3Dno' target='_blank'>no</a>

6
Docs/SpecialRenderings.md
View file

@ -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 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. 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. 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'. 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. 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 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. 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. 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. 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'. 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. 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 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. 4. When importing ways, the theme creator is also responsible of avoiding overlapping ways.

2
Docs/Sponsors.md
View file

@ -11,7 +11,7 @@ NL-Net is currently sponsoring Pietervdvn as well [for specific improvements](ht
## Historical sponsors ## 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. As these projects are finished, they have no relation with the project anymore.
Most recent projects are first: Most recent projects are first:

3
Docs/URL_Parameters.md
View file

@ -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: 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: