Skip to content

Commit

Permalink
Final touches to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexwero committed Jan 23, 2025
1 parent 23f6aa1 commit 8369ce8
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ AusMap is a QGIS plugin for visualising publicly available Australian geographic

- Access to a wide range of Australian geographic data from Geoscience Australia
- Seamless integration with QGIS, allowing easy search and display of map layers
- Extend the plugin with a custom layer defiition file (.QLR)
- Extend the plugin with a custom Layer Definition File (.QLR)

## Installation

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ permalink: /getting-started/

## Adding Map Layers

Once installed, the AusMap plugin appears in the menu bar.
Once installed, the AusMap plugin appears in the QGIS menu bar.

![QGIS menu bar](/assets/images/menu-bar.png)

Expand All @@ -19,6 +19,6 @@ The available map layers are arranged in alphabetically ordered categories.

## Search Functionality

You can search for the layer names provided by the AusMap plugin by using the locator bar in the bottom left corner of the QGIS interface. Clicking on a layer in the search results will add it to the map canvas.
You can search for the layers in AusMap by using the locator bar in the bottom left corner of the QGIS interface. Double-clicking on a layer in the search results will add it to the map canvas.

![Locator bar](/assets/images/search.png)
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: About
title: About AusMap
layout: home
nav_order: 1
permalink: /
---

# About
# About AusMap

AusMap is a QGIS plugin for visualising publicly available Australian geographic data. It gives quick access to a variety of feature sets and map layers provided by Geoscience Australia, the Google Maps Platform and OpenStreetMap. Selecting a desired layer from the AusMap menu will add it to the map canvas with styling and labelling applied. The layers are provided via WMS, WFS, WMTS and XYZ services, which all require an active internet connection.

Expand Down
2 changes: 1 addition & 1 deletion docs/license.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ permalink: /license/

# Credits and License

AusMap is developed and maintained by WMS Engineering and is licensed under the GNU General Public License (GPL) v3.0 or later. You are free to use, modify, and distribute this plugin under the terms of the [GNU GPL](https://www.gnu.org/licenses/) as published by the Free Software Foundation. This plugin is distributed in the hope that it will be useful, but without any warranty. See the GNU GPL for more details.
AusMap is developed and maintained by [WMS Engineering](https://wmseng.com.au/) and is licensed under the GNU General Public License (GPL) v3.0 or later. You are free to use, modify, and distribute this plugin under the terms of the [GNU GPL](https://www.gnu.org/licenses/) as published by the Free Software Foundation. This plugin is distributed in the hope that it will be useful, but without any warranty. See the GNU GPL for more details.

The design and functionality of AusMap draw inspiration from the [Dataforsyningen QGIS plugin](https://github.com/SDFIdk/Qgis-dataforsyningen). The map layers are provided by [Geoscience Australia](https://services.ga.gov.au/), the Google Maps Platform, and OpenStreetMap.
13 changes: 7 additions & 6 deletions docs/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,29 @@ permalink: /settings/

# Settings

The AusMap plugin can be extended with additional map layers saved in a Layer Definition File (QLR). The map layers in this file will be added to the AusMap menu and therefore easily accessible.
The AusMap plugin can be extended with additional map layers for easy access.
The map layers must be saved in a Layer Definition File (.QLR).

The QLR file must match the AusMap menu layout, meaning that the map layers must be grouped into one or more categories.
The .QLR file must match the AusMap menu layout, meaning that the map layers must be grouped into one or more categories.

See the example below.

## Example

The additional layers 1, 2 and 3 are grouped into two categories.
The *Additional layers* are grouped into two categories.

![Grouped map layers](/assets/images/grouped-layers.png)

Save the layers in a QLR file by selecting the groups, right-clicking, and choosing **Export** > **Save as Layer Definition File**.
Save the layers in a .QLR file by selecting the groups, right-clicking, and choosing **Export** > **Save as Layer Definition File**.

![Save QLR](/assets/images/save-qlr.png)

Navigate to the AusMap page in the options dialog (**Settings** > **Options** > **AusMap**), select the QLR file from your local machine and click **OK**.
Navigate to the AusMap page in the Options dialog (**Settings** > **Options** > **AusMap**), select the .QLR file from your local machine and click **OK**.

![AusMap options dialog](/assets/images/options-dialog.png)

The additional map layers will now appear in their respective groups inside the AusMap menu.

![Custom layers in menu](/assets/images/new_layers_in_menu.png)

To remove the layers from the menu, go back to the options dialog, delete the file path and save.
To remove the layers from the menu, go back to the Options dialog, delete the file path and save.

0 comments on commit 8369ce8

Please sign in to comment.