Skip to content

Commit 8f2a094

Browse files
authored
Simple docs (#25)
* Simple docs Signed-off-by: Daniel Kastl <[email protected]>
1 parent 5f6ebbe commit 8f2a094

10 files changed

+68
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,13 @@ More information on installing (and uninstalling) Redmine plugins can be found h
4949

5050
## How to use
5151

52-
[Settings, screenshots, etc.]
52+
1. Go to plugin configuration for global settings
53+
2. Configure at least one tile source
54+
3. Enable `GTT` module in a project
55+
4. Define the project boundary in `GTT` project settings
56+
5. Create a new issue with a point, line or polygon
57+
58+
For more information with screenshots see the [Getting Started](doc/getting-started.md) guide.
5359

5460
## Contributing and Support
5561

197 KB
Loading
177 KB
Loading

doc/My account - Redmine.png

174 KB
Loading
60.3 KB
Loading
319 KB
Loading

doc/New project - Redmine.png

45.5 KB
Loading
51.2 KB
Loading
229 KB
Loading

doc/getting-started.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# Getting Started with GTT plugin
2+
3+
The following is a brief overview of the most important settings of the GTT plugin.
4+
5+
## Plugin Settings
6+
7+
Global settings can be specified in the plugin configuration `/settings/plugin/redmine_gtt`:
8+
9+
![Plugin Settings](Redmine%20GTT%20plugin%20-%20Plugins%20-%20Redmine.png)
10+
11+
**Note:** Geocoder options missing. TBD.
12+
13+
## Tile Source
14+
15+
At least one tile source needs to be configured to be used as a base map. The GTT plugin uses [OpenLayers](https://openlayers.org/) and accepts common OpenLayers layer types and layer options.
16+
17+
![Tile Source](New%20Tile%20Source%20-%20Tile%20Sources%20-%20Redmine.png)
18+
19+
### Example OSM base map
20+
21+
* **Type**: `ol.source.OSM`
22+
* **Options**:
23+
24+
```
25+
{
26+
"url": "https://tile.openstreetmap.jp/{z}/{x}/{y}.png",
27+
"custom": "19/34.74701/135.35740",
28+
"crossOrigin": null,
29+
"attributions": "<a href=\"https://www.openstreetmap.org/copyright\">OpenStreetMap</a>"
30+
}
31+
```
32+
33+
## My Account
34+
35+
A user can set their own location on the user page `/my/account`:
36+
37+
![My Account](My%20account%20-%20Redmine.png)
38+
39+
## Project Settings
40+
41+
To use GTT in a project the `GTT` module must be enabled `/projects/new`:
42+
43+
![GTT module](New%20project%20-%20Redmine.png)
44+
45+
In the `GTT` tab of the project settings the project boundaries can be specified as a polygon:
46+
47+
![Project settings](Settings%20-%20GTT%20Project%20-%20Redmine.png)
48+
49+
## Creating Issues
50+
51+
Create an issue with a location as `point`, `line` or `polygon`:
52+
53+
![New issue](New%20issue%20-%20GTT%20Project%20-%20Redmine.png)
54+
55+
Changes to an issue, including geometry updates, are available in the issue history:
56+
57+
![History](Issue%201%20-%20GTT%20Project%20-%20Redmine.png)
58+
59+
All issues can be displayed on the projects issues list together with a map:
60+
61+
![All issues](Issues%20-%20GTT%20Project%20-%20Redmine.png)

0 commit comments

Comments
 (0)