Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
hamiltoncj committed Oct 4, 2022
1 parent 83422a1 commit becc363
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 3 deletions.
Binary file added doc/gzd.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/gzd_algorithm.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/gzd_example.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/menu.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/settings.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 19 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
# MGRS Plugin

***MGRS*** provides zoom to and coordinate capture ability for MGRS coordinates separate from the ***Lat Lon Tools*** plugin. It was produced for users who want separate tools and to be able to have both ***MGRS*** and ***Lat Lon Tools*** windows displayed at the same time. If you need the ability to convert an attribute table with MGRS coordinates to a new point layer or convert a point layer to a new layer with an MGRS attribute string, then use ***Lat Lon Tools***. These are the MGRS tools as shown on the ***MGRS toolbar***.
***MGRS*** provides zoom to and coordinate capture ability for MGRS coordinates separate from the ***Lat Lon Tools*** plugin. It was produced for users who want separate tools and to be able to have both ***MGRS*** and ***Lat Lon Tools*** windows displayed at the same time. It also provides an algorithm to create an MGRS Grid Zone Designator layer. If you need the ability to convert an attribute table with MGRS coordinates to a new point layer or convert a point layer to a new layer with an MGRS attribute string, then use ***Lat Lon Tools***. The MGRS plugin is installed in the QGIS Plugins menu.

<div style="text-align:center"><img src="doc/menu.jpg" alt="MGRS menu"></div>

These are the MGRS tools as shown on the ***MGRS toolbar***.

<div style="text-align:center"><img src="doc/toolbar.jpg" alt="MGRS toolbar"></div>

Expand All @@ -10,16 +13,29 @@
* <img src="images/zoomToMgrs.svg" alt="Zoom-to"> ***Zoom to MGRS Coordinate*** - With this tool, type or paste an MGRS coordinate into the text area and press **Enter**. QGIS centers the map on the coordinate, highlights the location and creates a temporary marker at the location. The marker can be removed with the <img src="doc/cleartool.jpg" alt="Clear marker"> button. The following shows the dockable zoom to dialog box.

<div style="text-align:center"><img src="doc/zoomdialog.jpg" alt="Zoom Dialog box"></div>

* <img src="doc/gzd.jpg" width="24" alt="MGRS Grid Zone Designator"> ***MGRS Grid Zone Designator*** - This will create an MGRS Grid Zone Designator overlay layer.

<div style="text-align:center"><img src="doc/gzd_algorithm.jpg" alt="Grid Zone Designator Algorithm"></div>

* ***Include polar regions*** - If checked the polar grid zones A,B and Y,Z are included in the output.
* ***Automatically style output*** - If checked, the output layer will automatically be styled with colors from the **Settings** menu.

The output layer can be saved and reused without needing to run this processing algorithm again. This is an example of the output of the algorithm.

<div style="text-align:center"><img src="doc/gzd_example.jpg" alt="GZD example"></div>

## Settings

These are the available settings that are available from the QGIS menu ***Plugins->MGRS->Settings***
These are the settings that are available from the QGIS menu ***Plugins->MGRS->Settings***

<div style="text-align:center"><img src="doc/settings.jpg" alt="Settings"></div>

* ***MGRS precision*** - This determs the precision of the captured MGRS coordinate. It ranges from 0 to 5 with 5 being the highest resolution.
* ***Coordinate prefix*** - This text string is added to the beginning of the captured MGRS coordinate.
* ***Coordinate suffix*** - This text string is added to the end of the captured cMGRS oordinate.
* ***Coordinate suffix*** - This text string is added to the end of the captured MGRS oordinate.
* ***GZD line color*** - This is the outline color used when the MGRS Grid Zone Designator algorithm is executed.
* ***GZD font color*** - This is the font color used for the grid zone labels when the MGRS Grid Zone Designator algorithm is executed.
* ***Add spaces to MGRS coordinates*** - This will add spaces to an MGRS coordinate when checked. Unchecked it looks like "16TDL8016526461" and checked it looks like "16T DL 80165 26461".
* ***Use persistent zoom to marker*** - If this is checked, then when you zoom to an MGRS coordinate a persistent marker is displayed until you exit, zoom to another location, or click on the <img src="doc/cleartool.jpg" alt="Clear marker"> button.
* ***Show marker on QGIS map at the captured location*** - If checked, a temporary marker will be displayed at the location clicked on with the ***Copy/Display MGRS Coordinate*** tool.

0 comments on commit becc363

Please sign in to comment.