Skip to content

Commit

Permalink
feat: adjusted content and i18n support
Browse files Browse the repository at this point in the history
  • Loading branch information
verendi committed Nov 14, 2023
1 parent b419da7 commit 3f5efff
Show file tree
Hide file tree
Showing 45 changed files with 1,073 additions and 606 deletions.
471 changes: 0 additions & 471 deletions docs/admin-client/01-instance.md

This file was deleted.

80 changes: 0 additions & 80 deletions docs/admin-client/02-subject.md

This file was deleted.

17 changes: 0 additions & 17 deletions docs/admin-client/index.md

This file was deleted.

29 changes: 29 additions & 0 deletions docs/gis-client/01-header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Header
***
The header contains the logo and the title of the application on the left side.

The search bar is located in the middle of the header.

In the right-hand corner of the header the user icon with the option to log out of the application is located.

## Search bar

The search includes a location search based on NOMINATIM.

To initiate a search query, a search term must be entered in the search field. The search then starts automatically.

A search term that has already been entered can be removed using the gis-client icon at the end of the search bar. The search term and the results are reset.

If results are found for the search terms entered, the results display opens below the search bar.

By clicking on the title of a search result, the map zooms to the spatial extent of the result.

## User information

The user icon in the right corner gives the option to log out from the application.

It is also possible to get a version info for the system or to edit the user profile.




174 changes: 174 additions & 0 deletions docs/gis-client/02-toolbox.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
# Toolbox
***
Various functions are available in the toolbox on the left-hand side of the map, which are presented below:

## Measure

The measure tool is used to measure distances or areas.

![gis-client](/img/measure_tools.png)

The measure tool for the desired option can be activated by clicking on the corresponding button. When hovering over the main map with the mouse, you can now see at the mouse pointer that the measuring tool is active.

A line or an area can now be drawn on the map. Each click on the map adds a new base point to the measure object. The measure is completed by double-clicking on the map. The measure result is now displayed on the object:

![gis-client](/img/measure_area.png)
:::info

To deselect the tool press it again to untoggle it. The measurements in the map are then removed.

:::

<!-- <ReactPlayer controls width="max" height="max" url="/shogun-docs/videos/measure.mp4" /> -->

## Draw

The draw tools can be used to annotate the map, draw various geometries to highlight certain areas or can be downloaded as an area-of-interest.

![gis-client](/img/draw_tools.png)

It is possible to choose between the geometries `Point`, `Line`, `Polygon`, `Circle` or `Rectangle`. For text elements, `Annotation` can be used.

Every drawn object can be edited via the `Edit` option. To to this, activate this option and click on the desired drawn object. It will be activated for editing.

There is also the option to upload geoJSON files with the `Upload` option which will be visualized in the map after uploading them.

In the opposite way, all drawn objects in the map can be downloaded in geoJSON format. For this purpose, the `Export` option can be used.

To delete a drawn object from the map, the `Delete` option can be activated. A click on the desired draw object will remove it.

The `Modify color scheme` button can be used to modify the color of the different geometry types.

:::info

To deselect a draw option in the draw tool, you need to untoggle the selected option.

:::

<!-- <ReactPlayer controls width="max" height="max" url="/shogun-docs/videos/draw.mp4" /> -->

## Query map features / Feature Info

The "Query map features" tool can be used to query detailed information on the objects of the displayed layers in the map, provided that the topics are active in the map and are available for querying.

![gis-client](/img/query_tool.png)

Use the mouse to click on the desired layer object in the map. If information is found for this object, it will be displayed in the tool panel directly.

![gis-client](/img/query_result.png)

If objects from several layers are found at the clicked point on the map, the results for the individual layers are displayed in different tabs. These tabs can be clicked individually. In the example above, there was only one result found for the layer "Countries".

If several objects are hit on a clicked point within one layer, you can page through the individual hits in the corresponding layers tab:

![gis-client](/img/pager.png)

:::info

Be aware that the layers you want to query need to support additional information and need to be configured as queryable within the application.

:::

<!-- <ReactPlayer controls width="max" height="max" url="/shogun-docs/videos/getfeatureinfo.mp4" /> -->

## Export

This tool can be used to open the "Print" function in order to export a desired map section.

![gis-client](/img/print.png)

The desired details for the print output can be entered via the print form.

You can enter a title for the print output and a comment.

A4 landscape format and A4 portrait format are available as print templates. A scale and output quality/resolution as well as the format (PDF or PNG) can also be selected.

In the map, the area to be printed is defined by a frame. After clicking on this frame, it is marked with a red border and can be moved with the mouse or enlarged/reduced by moving the mouse over the 4 corner points.

Printing is triggered by clicking on the "Create print" button and the output file is offered for download after successful generation.

## Maps / Layertree

This menu item, which is called "Maps", contains the application's layertree. It contains all the layers configured for the application in a folder structure. The layertree organizes the layer hierarchy. Layers that are listed first in the layertree are displayed at the top level of the map.

![gis-client](/img/layertree.png)

Layers or folders can be activated or deactivated for the map using the checkbox in front of each element.

It is possible to adjust the transparency of an activated layer in the map using a slider. If the slider is moved to the right, the transparency increases.

Layers can be moved within the layertree using drag & drop to change the layer order in the map. These changes are not persistent and are therefore only valid for the current session.

The ![gis-client](/img/context_layer.png) icon behind each layer can be used to open an additional context menu for each layer. Depending on the configuration of the layer, this menu may contain the following functions:

* the option to zoom the map to the default scale of the theme ("Zoom to layer extent")
* the option to show the legend; the legend is then displayed below the transparency slider of the layer and can also be deactivated again using the same method in the context menu ("Hide legend")
* the option to download the theme, if configured
* the option to edit the theme, if configured
* the option to see the properties for the layer

Furthermore, it is possible to add new WMS services to the layertree.

The `Add WMS` button can be found below the layertree.

Clicking on the button opens the corresponding window.

First, a valid WMS URL must be entered or copied into the text field. The baseUrl of the WMS ist sufficient, it is not necessary to insert the SERVICE, VERSION and REQUEST parameters to the URL. They are automatically added. The user can then either click on the "magnifying glass" icon behind the text field or press the Enter key to obtain a list of available layers.

If the service URL is not valid and/or no layers could be read, the user is informed via an error message.

If the WMS URL is valid and the available layers could be read, these are displayed in a selection list below the text field.

![gis-client](/img/add_wms.png)

The user now has the option of selecting the desired layers by clicking into the respective checkbox in order to add them to the map. The desired layers are loaded into the map via the "Add selected" button and are available in the layertree in the "External services" folder. The "Add all" button can also be used to add all layers from the WMS service without preselection. The window closes automatically after adding the desired layers to the map.

:::info

Added external layers are only available within the current session.

:::

The `Upload data` button can also be found below the layertree.

Clicking on the button opens the corresponding window.

![gis-client](/img/upload.png)

It is possible to add a shapefile as a zipfile or a GeoTIFF. After successfully uploading the data, it will be displayed in the map.

:::info

Uploaded data are only available within the current session.

:::

## Share

The share function is used to share the current state of an Web-GIS instance. A new URL will be created that stores information about:

- the zoom level
- the map section
- selected layers

As long as the layers are available under their URL or within the internal GeoServer the Permalink URL will be valid.

The permalink can be copied to the clipboard by clicking on the button behind the link.

:::info

A layer order changed by the user is not transported into the permalink.

:::

:::info

Beware that you need to be logged in to open the URL and have granted access to the specific application.

:::

<!-- <ReactPlayer controls width="max" height="max" url="/shogun-docs/videos/share.mp4" /> -->

## Language selector

The language selector can be used to switch the applications language.
16 changes: 16 additions & 0 deletions docs/gis-client/03-footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Footer
***
Various information is available in the footer of the application.

## Scale information

Information on the scale of the map is displayed in the footer on the left, firstly as a scale bar and secondly as a numerical indication of the currently active scale. Here the user has the option of selecting a different value from the drop-down list by clicking on the number. It is also possible to enter the desired scale by typing it directly into the text field. Please note that only the scale number at the back, e.g. 50,000, must be entered without the leading "1 :". Only the available scales from the drop-down list are available as input scales.

## Reference system and current mouse position

In addition to the scale information in the footer, the reference system and the current mouse position are displayed if the mouse is positioned in an area of the main map.

## Contact, imprint and privacy policy

In the right-hand corner of the footer you will find the links for contact, imprint and privacy policy. Click on one of the links to open the desired content in a new browser page.

40 changes: 35 additions & 5 deletions docs/gis-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,44 @@
id: GIS-Client
title: GIS-Client
description: GIS-Client
sidebar_position: 4
sidebar_position: 1
sidebar_label: GIS-Client
---

# GIS-Client
***
The [GIS-Client](https://shogun2022.intranet.terrestris.de/client) is basically the interface for all users of the **SHOGun** Web-GIS application. There can be an undefinable number of individual applications, each of which can be accessed via an individual URL. The individual applications can be created and defined in the **Admin-Client**.

![gis-client](../../static/img/gis-client.png)
## Overview

Users with the role **USER** and **Admin** have full access to all functionalities within the Web-GIS application. This includes all tools selected in the admin client. Unauthorized users have no access to the applications.
The basic structure of a GIS client application is shown in the following illustration:

![gis-client](/img/application_overview.png)

## Header

The header is always visible in an application. The header contains the following information and tools:

The logo and the title of the application are displayed on the left.

The search bar is located in the middle of the header.

In the right-hand corner of the header the user icon with the option to log out of the application is located.

## Toolbox

In the top left of the main content area, the toolbox is displayed. Various tools are offered here. Further information on the functions in the toolbox can be found [here](../gis-client/toolbox).

## Map

The map is displayed in the content area of the application between the header and footer.

The copyright information for the activated maps is displayed in the bottom right-hand corner. The display is initially collapsed, but can be expanded by clicking on the i.

## Footer

The footer is always visible in an application. The footer contains the following information and tools:

On the left the scale bar is located, followed by a scale selection menu.

This is followed by the display of the reference system and the current mouse position if the mouse is positioned in an area of the main map.

In the right-hand corner of the footer you will find the links for contact, imprint and privacy policy.
19 changes: 0 additions & 19 deletions docs/overview/index.md

This file was deleted.

Loading

0 comments on commit 3f5efff

Please sign in to comment.