Skip to content

Commit

Permalink
Documentation typo fix and some more linking
Browse files Browse the repository at this point in the history
  • Loading branch information
simonpoole committed Nov 3, 2024
1 parent a53554c commit bbe8345
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 6 deletions.
6 changes: 4 additions & 2 deletions documentation/docs/help/en/Main map display.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,11 +177,11 @@ To reposition or remove the "on-map" GPS button use the "Follow position button

Select either the transfer icon ![Transfer](../images/menu_transfer.png) or the "Transfer" menu item. This will display seven or eight options:

* **Upload data to OSM server...** - review and upload changes to OpenStreetMap, the entry is disabled if you haven't changed anything yet, or there is no network available *(requires authentication)* *(requires network connectivity)*
* **Upload data to OSM server...** - review and upload changes to OpenStreetMap, the entry is disabled if you haven't changed anything yet, or there is no network available. See [Uploading your changes](Uploading%20your%20changes.md) for more information *(requires authentication)* *(requires network connectivity)*
* **Review changes...** - review current changes
* **Download current view** - download the area visible on the screen and merge it with existing data *(requires network connectivity)*
* **Clear and download current view** - clear any data in memory and then download the area visible on the screen *(requires network connectivity)*
* **Query Overpass...** - run a query against a Overpass API server, for more information see _Overpass queries_ below. *(requires network connectivity)*
* **Query Overpass...** - run a query against a Overpass API server, see [Overpass queries](#overpass_queries). *(requires network connectivity)*
* **Close current changeset** - manually close the current changeset *(only available if a changeset is open)*
* **Location based auto download** - download an area around the current location automatically *(requires network connectivity)* *(requires GPS)*
* **Pan and zoom auto download** - download the area shown in the current screen automatically *(requires network connectivity)*
Expand Down Expand Up @@ -239,6 +239,8 @@ Search for a location and pan to it with the OpenStreetMap Nominatim or Photon s

Search for OSM objects in the loaded data using JOSMs search/filter expressions. See [JOSM filter documentation](http://vespucci.io/tutorials/object_search/) for more information. Besides searching in the loaded data alternatively you can create a Overpass API query and use that to download data.

<a id="overpass_queries"></a>

#### Overpass queries

The queries will be run against the Overpass server set in the "Advanced preferences". The standard behaviour is to replace the current data with the results of the query,
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/help/en/Uploading your changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ If you have pending edits and for whatever reason cannot authorize, Vespucci rel

## Uploading

To upload your edits you can either select _Upload data to OSM server_ from the [Transfer menu](Main%20map%20display.md#trasfer), or select _Upload element_ from the overflow menu in any of the element selection modes or multi-select. The later will only upload the selected elements.
To upload your edits you can either select _Upload data to OSM server_ from the [Transfer menu](Main%20map%20display.md#transfer), or select _Upload element_ from the overflow menu in any of the element selection modes or multi-select. The later will only upload the selected elements.

The _Upload changes_ dialog display two tabs _Changes_ and _Properties_. The _Changes_ tab displays a list of all the OSM elements that will be affected by the upload, the type of change and an information button that allows you to view further information on the element and jump to it to make corrections. The _Properties_ tab allows you to set a _comment_
for this upload and document that _source_ that was used to create the changes (for example _survey_ if you were personally present at the location in question). Prior entries in both
Expand Down
5 changes: 3 additions & 2 deletions src/main/assets/help/en/Main map display.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,11 @@ <h3><img src="../images/menu_gps.png" alt="Location" /> Location</h3>
<h3><img src="../images/menu_transfer.png" alt="Transfer" /> Transfer</h3>
<p>Select either the transfer icon <img src="../images/menu_transfer.png" alt="Transfer" /> or the &quot;Transfer&quot; menu item. This will display seven or eight options:</p>
<ul>
<li><strong>Upload data to OSM server...</strong> - review and upload changes to OpenStreetMap, the entry is disabled if you haven't changed anything yet, or there is no network available <em>(requires authentication)</em> <em>(requires network connectivity)</em></li>
<li><strong>Upload data to OSM server...</strong> - review and upload changes to OpenStreetMap, the entry is disabled if you haven't changed anything yet, or there is no network available. See <a href="Uploading%20your%20changes.md">Uploading your changes</a> for more information <em>(requires authentication)</em> <em>(requires network connectivity)</em></li>
<li><strong>Review changes...</strong> - review current changes</li>
<li><strong>Download current view</strong> - download the area visible on the screen and merge it with existing data <em>(requires network connectivity)</em></li>
<li><strong>Clear and download current view</strong> - clear any data in memory and then download the area visible on the screen <em>(requires network connectivity)</em></li>
<li><strong>Query Overpass...</strong> - run a query against a Overpass API server, for more information see <em>Overpass queries</em> below. <em>(requires network connectivity)</em></li>
<li><strong>Query Overpass...</strong> - run a query against a Overpass API server, see <a href="#overpass_queries">Overpass queries</a>. <em>(requires network connectivity)</em></li>
<li><strong>Close current changeset</strong> - manually close the current changeset <em>(only available if a changeset is open)</em></li>
<li><strong>Location based auto download</strong> - download an area around the current location automatically <em>(requires network connectivity)</em> <em>(requires GPS)</em></li>
<li><strong>Pan and zoom auto download</strong> - download the area shown in the current screen automatically <em>(requires network connectivity)</em></li>
Expand Down Expand Up @@ -253,6 +253,7 @@ <h3><img src="../images/ic_menu_search_holo_light.png" alt="Find" /> Find</h3>
<p>Search for a location and pan to it with the OpenStreetMap Nominatim or Photon service <em>(requires network connectivity)</em></p>
<h3>Search for objects</h3>
<p>Search for OSM objects in the loaded data using JOSMs search/filter expressions. See <a href="http://vespucci.io/tutorials/object_search/">JOSM filter documentation</a> for more information. Besides searching in the loaded data alternatively you can create a Overpass API query and use that to download data.</p>
<p><a id="overpass_queries"></a></p>
<h4>Overpass queries</h4>
<p>The queries will be run against the Overpass server set in the &quot;Advanced preferences&quot;. The standard behaviour is to replace the current data with the results of the query, if you have unsaved changes the query will not run except if you select the <em>Merge result</em> check box (this will merge the results of the query with the existing data). If <em>Select result</em> is checked, any results (with the exception of way nodes) will be selected and the app will zoom to the data.</p>
<p>Note: if you are generating the query from the JOSM query language you need to add an <em>inview</em> term otherwise the query will be executed for the whole world, if you are manually creating a query you should add <em>({{bbox}})</em> terms for the same reason.</p>
Expand Down
2 changes: 1 addition & 1 deletion src/main/assets/help/en/Uploading your changes.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ <h2>Authorization</h2>
<p>During the authorization process you will be connected to openstreetmap.org and asked to login to your account, you then need to confirm the authorization and will be returned back to Vespuccis map map display.</p>
<p>If you have pending edits and for whatever reason cannot authorize, Vespucci reliably saves your edits on your device until you upload them or explicitly delete them. If you want to be extra safe you can <a href="Main%20map%20display.md#file">save them to a local file</a> in OCS or (J)OSM format that you can read with Vespucci or import in to JOSM.</p>
<h2>Uploading</h2>
<p>To upload your edits you can either select <em>Upload data to OSM server</em> from the <a href="Main%20map%20display.md#trasfer">Transfer menu</a>, or select <em>Upload element</em> from the overflow menu in any of the element selection modes or multi-select. The later will only upload the selected elements.</p>
<p>To upload your edits you can either select <em>Upload data to OSM server</em> from the <a href="Main%20map%20display.md#transfer">Transfer menu</a>, or select <em>Upload element</em> from the overflow menu in any of the element selection modes or multi-select. The later will only upload the selected elements.</p>
<p>The <em>Upload changes</em> dialog display two tabs <em>Changes</em> and <em>Properties</em>. The <em>Changes</em> tab displays a list of all the OSM elements that will be affected by the upload, the type of change and an information button that allows you to view further information on the element and jump to it to make corrections. The <em>Properties</em> tab allows you to set a <em>comment</em> for this upload and document that <em>source</em> that was used to create the changes (for example <em>survey</em> if you were personally present at the location in question). Prior entries in both fields are retained and can be used when appropriate.</p>
<p>It is considered best practice to provide meaningful information for other mappers in these fields. However Vespucci will automatically include a summary of your changes (starting with version 20.2) and a list of all imagery layers used for the current set of changes. If you leave the comment field empty it will include text pointing to the automatically generated summary.</p>
<h2>Upload options</h2>
Expand Down

0 comments on commit bbe8345

Please sign in to comment.