Skip to content

Commit

Permalink
Improve GeoJSON layer documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
simonpoole committed Jan 24, 2025
1 parent db8e2df commit 882025e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
12 changes: 10 additions & 2 deletions documentation/docs/help/en/Main map display.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The layer dialog supports the following actions on the layer entries:
Starting recording by the "Start GPX track" item in the GPS menu will add a layer for the recording. Layers for GPX files and downloaded tracks from the OSM API can be added via the __+__ button, see below.
* __Change style__ Show the layer styling dialog.
* __Reset style__ Reset the style to the default.
* __Info__ Display some information on the contents.
* __Info__ Display some summary information on the layer.
* __Go to start of GPX track__ Center the display on the start of the track. *(not available on the recording layer)*
* __Go to first waypoint__ Center the display on the first waypoint. *(not available on the recording layer)*
* __Upload GPX track__ Upload the track to the OSM API. Note: the OSM API only accepts tracks with valid time stamps for each track point, if they are missing a time stamp corresponding to the UNIX epoch date will be added.
Expand Down Expand Up @@ -115,7 +115,9 @@ The layer dialog supports the following actions on the layer entries:
Custom tile layers, including on device MBTile containers can be added in the [preferences](Preferences.md)
or as decribed above..

### Highlighting of data issues
### Layer specific information

#### Highlighting of issues on the data layer

The included map styles highlight certain data issues, these are

Expand All @@ -129,6 +131,12 @@ The included map styles highlight certain data issues, these are

The colours can be changed in the [data style](http://vespucci.io/tutorials/data_styling/#validation-styling).

#### GeoJSON layer

Clicked GeoJSON objects will display a modal with its details. Further you can copy the attributes from the object to the clipboard and paste them as tags in to an OSM element, or you can directly create an OSM element from the object.

_Note_ GeoJSON Polygon objects that consist of a single ring will be converted to a OSM closed way if the ring has less than 2000 vertices (the limit for an OSM way element), all other Polygons and Multipolygons will be converted to OSM multipolygon relations. Nodes in GeoJSON GeometryCollections will not be merged with the vertices of linear and area elements in OSM. You might want to do the later manually.


## Available Actions

Expand Down
8 changes: 6 additions & 2 deletions src/main/assets/help/en/Main map display.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h3>Layer control</h3>
<ul>
<li><strong>Change style</strong> Show the layer styling dialog.</li>
<li><strong>Reset style</strong> Reset the style to the default.</li>
<li><strong>Info</strong> Display some information on the contents.</li>
<li><strong>Info</strong> Display some summary information on the layer.</li>
<li><strong>Go to start of GPX track</strong> Center the display on the start of the track. <em>(not available on the recording layer)</em></li>
<li><strong>Go to first waypoint</strong> Center the display on the first waypoint. <em>(not available on the recording layer)</em></li>
<li><strong>Upload GPX track</strong> Upload the track to the OSM API. Note: the OSM API only accepts tracks with valid time stamps for each track point, if they are missing a time stamp corresponding to the UNIX epoch date will be added.</li>
Expand Down Expand Up @@ -139,7 +139,8 @@ <h3>Layer control</h3>
</li>
</ul>
<p>Custom tile layers, including on device MBTile containers can be added in the <a href="Preferences.md">preferences</a> or as decribed above..</p>
<h3>Highlighting of data issues</h3>
<h3>Layer specific information</h3>
<h4>Highlighting of issues on the data layer</h4>
<p>The included map styles highlight certain data issues, these are</p>
<ul>
<li>objects with 'fixme' and 'todo' tags (case insensitive) <em>magenta</em></li>
Expand All @@ -151,6 +152,9 @@ <h3>Highlighting of data issues</h3>
<li>unconnected highway end nodes, if the end nodes a near to a highway object that they could be connected to, the node is highlighted <em>magenta</em></li>
</ul>
<p>The colours can be changed in the <a href="http://vespucci.io/tutorials/data_styling/#validation-styling">data style</a>.</p>
<h4>GeoJSON layer</h4>
<p>Clicked GeoJSON objects will display a modal with its details. Further you can copy the attributes from the object to the clipboard and paste them as tags in to an OSM element, or you can directly create an OSM element from the object.</p>
<p><em>Note</em> GeoJSON Polygon objects that consist of a single ring will be converted to a OSM closed way if the ring has less than 2000 vertices (the limit for an OSM way element), all other Polygons and Multipolygons will be converted to OSM multipolygon relations. Nodes in GeoJSON GeometryCollections will not be merged with the vertices of linear and area elements in OSM. You might want to do the later manually.</p>
<h2>Available Actions</h2>
<h3><img src="../images/undolist_undo.png" alt="Undo" /> Undo</h3>
<p>Tapping the icon once will undo the last operation. A long press will display a list of the operations since the last save, if you have undone anything a corresponding &quot;redo&quot; checkpoint will be displayed. <em>Some operations consist of multiple simpler actions that will be listed as individual items.</em></p>
Expand Down

0 comments on commit 882025e

Please sign in to comment.