Improve documentation

This commit is contained in:
Pieter Vander Vennet 2022-04-06 16:12:01 +02:00
parent d80cc64f77
commit db2b14cd95
124 changed files with 4450 additions and 4088 deletions

View file

@ -101,13 +101,12 @@ Meta layer showing the current location of the user. Add this to your theme and
- This layer is shown at zoomlevel **0** and higher
- **This layer is included automatically in every theme. This layer might contain no points**
- This layer cannot be toggled in the filter view. If you import this layer in your theme, override `title` to make this toggleable.
- Not visible in the layer selection by default. If you want to make this layer toggable, override `name`
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/gps_location/gps_location.json)
Basic tags for this layer
@ -145,14 +144,13 @@ Meta layer which contains the previous locations of the user as single points. T
- This layer is shown at zoomlevel **0** and higher
- **This layer is included automatically in every theme. This layer might contain no points**
- This layer cannot be toggled in the filter view. If you import this layer in your theme, override `title` to make this toggleable.
- Not visible in the layer selection by default. If you want to make this layer toggable, override `name`
- Not rendered on the map by default. If you want to rendering this on the map, override `mapRenderings`
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/gps_location_history/gps_location_history.json)
Basic tags for this layer
@ -190,13 +188,12 @@ Meta layer showing the home location of the user. The home location can be set i
- This layer is shown at zoomlevel **0** and higher
- **This layer is included automatically in every theme. This layer might contain no points**
- This layer cannot be toggled in the filter view. If you import this layer in your theme, override `title` to make this toggleable.
- Not visible in the layer selection by default. If you want to make this layer toggable, override `name`
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/home_location/home_location.json)
Basic tags for this layer
@ -234,13 +231,12 @@ Meta layer showing the previous locations of the user as single line. Add this t
- This layer is shown at zoomlevel **0** and higher
- **This layer is included automatically in every theme. This layer might contain no points**
- This layer is not visible by default and must be enabled in the filter by the user.
- Not rendered on the map by default. If you want to rendering this on the map, override `mapRenderings`
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/gps_track/gps_track.json)
Basic tags for this layer
@ -328,11 +324,10 @@ This is a priviliged meta_layer which exports _every_ point in OSM. This only wo
- This layer is shown at zoomlevel **18** and higher
- Not rendered on the map by default. If you want to rendering this on the map, override `mapRenderings`
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/type_node/type_node.json)
Basic tags for this layer
@ -370,11 +365,10 @@ This layer shows notes on OpenStreetMap. Having this layer in your theme will tr
- This layer is shown at zoomlevel **10** and higher
- <img src='../warning.svg' height='1rem'/> This layer is loaded from an external source, namely `https://api.openstreetmap.org/api/0.6/notes.json?limit=10000&closed=7&bbox={x_min},{y_min},{x_max},{y_max}`
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/note/note.json)
Basic tags for this layer
@ -462,11 +456,10 @@ Layer used in the importHelper
- This layer is shown at zoomlevel **0** and higher
- Not visible in the layer selection by default. If you want to make this layer toggable, override `name`
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/import_candidate/import_candidate.json)
Basic tags for this layer
@ -514,11 +507,10 @@ If the import-button moves OSM points, the imported way points or conflates, a p
- This layer is shown at zoomlevel **1** and higher
- This layer can **not** be included in a theme. It is solely used by [special renderings](SpecialRenderings.md) showing a minimap with custom data.
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/conflation/conflation.json)
Basic tags for this layer
@ -556,11 +548,10 @@ Special meta-style which will show one single line, either on the left or on the
- This layer is shown at zoomlevel **0** and higher
- This layer can **not** be included in a theme. It is solely used by [special renderings](SpecialRenderings.md) showing a minimap with custom data.
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/left_right_style/left_right_style.json)
Basic tags for this layer
@ -598,11 +589,10 @@ Layer rendering the little scissors for the minimap in the 'splitRoadWizard'
- This layer is shown at zoomlevel **1** and higher
- This layer can **not** be included in a theme. It is solely used by [special renderings](SpecialRenderings.md) showing a minimap with custom data.
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/split_point/split_point.json)
Basic tags for this layer
@ -642,11 +632,10 @@ The icon on the button is the default icon of the layer, but can be customized b
- This layer is shown at zoomlevel **0** and higher
- This layer can **not** be included in a theme. It is solely used by [special renderings](SpecialRenderings.md) showing a minimap with custom data.
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/current_view/current_view.json)
Basic tags for this layer
@ -684,11 +673,10 @@ The default rendering for a locationInput which snaps onto another object
- This layer is shown at zoomlevel **0** and higher
- This layer can **not** be included in a theme. It is solely used by [special renderings](SpecialRenderings.md) showing a minimap with custom data.
[Go to the source code](https://github.com/pietervdvn/MapComplete/blob/develop/assets/layers/matchpoint/matchpoint.json)
Basic tags for this layer