diff --git a/docs/admin-client/01-instance.md b/docs/admin-client/01-instance.md deleted file mode 100644 index 01c33f2..0000000 --- a/docs/admin-client/01-instance.md +++ /dev/null @@ -1,471 +0,0 @@ -# Application -*** -Under the heading **Application** you will find the possibility to create new Web-GIS applications or to edit existing ones. By selecting an application, the edit menu opens. - -![admin-client](../../static/img/application.png) - -As soon as an application entry is filled with all required information, it can be saved via the button ![Save Admin Application](../../static/img/save_instance.png). - -The ![Reset Admin Application](../../static/img/reset_instance.png) button can be used to reset the application input form. All changes since the last saving are discarded. - -When creating/editing an application, the fields *Client configuration* and *Layer tree* must be filled in addition to the name for the application. - -## Client configuration - -This field stores the configuration of the application in JSON format. Every application can be modified by editing the JSON format parameters, for example the initial zoom level, the title, or the color-scheme: - -
-Client configuration as JSON -
- 
-  {
-  JSON.stringify(
-  {
-   'mapView': {
-    'zoom': 3,
-    'center': [
-      11.4717964,
-      48.155004
-    ],
-    'extent': null,
-    'projection': 'EPSG:3857',
-    'resolutions': [
-      8920,
-      4480,
-      2240,
-      1120,
-      560,
-      350,
-      280,
-      140,
-      70,
-      28,
-      14,
-      7,
-      2.8,
-      1.4,
-      0.7,
-      0.28,
-      0.07
-    ]
-  },
-  'description': 'This is the Web GIS 1',
-  'theme': {
-    'primaryColor': '#555555',
-    'secondaryColor': '#73b3fb',
-    'complementaryColor': '#ffffff',
-    'logoPath': 'null'
-  }
-  }, null, '  ')
-  }
-
-
-
- -This is a full list of parameters that can be edited: - - - -| Key | Description | Example | Required | -|---|---|---|---| -| `defaultLanguage` | The default language of the application [(ISO 639-1)](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). | 'de' | false | -| `description` | Description of the application to be displayed on the start page. | 'My Web-GIS' | false | -| `legal -> imprint` | URL pointing to imprint page/section. | '/imprint' | false | -| `legal -> imprint` | URL pointing to contact details. | '/imprint' | false | -| `legal -> privacy` | URL pointing to data privacy. | '/privacy' | false | -| `mapView -> zoom` | The initial zoom level of the map. | 7 | false | -| `mapView -> center` | The initial center of the map (in WGS84). | 'center': [7,51] | true | -| `mapView -> extent` | The maximum extent of the map (in WGS84). | `[2.5683045738288137, 45.429089001638076, 19.382621082401887, 57.283993958205926]` | false | -| `mapView -> projection` | Coordinate reference system of the map (EPSG-Code). | 'EPSG:3857' | false | -| `mapView → crsDefinitions` | The list of CRS definitions in proj4 format that should be registered in the application additionally. | {
'crsCode': 'EPSG:25832',
'definition': '+proj=utm +zone=32 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs +type=crs'
} | false | -| `mapView -> resolutions` | The list of resolutions of the map. | `[2445.9849047851562, 1222.9924523925781, 611.4962261962891]` | false | -| `theme -> primaryColor` | Defines the background color of the header and footer element. | '#444444' | false | -| `theme -> secondaryColor` | Defines the hovering color of text elements and buttons. | '#ffc0cb' | false | -| `theme -> complementaryColor` | Defines the font color of text elements within header and footer component. | '#000000' | false | -| `theme -> logoPath` | URL of the logo which is displayed in the header component. | 'https://my-logo.de/img/my-logo.png' | false | - - - -## Layer tree - -This field stores the configuration for the application's layer tree in JSON format: - -
-Layer tree configuration as JSON -
- 
-  {
-  JSON.stringify(
-  {
-  'title': 'root',
-  'children': [
-    {
-      'title': 'Copernicus Services',
-      'checked': false,
-      'children': [
-        {
-          'title': 'Land - VHR Mosaic',
-          'checked': false,
-          'children': [
-            {
-              'title': 'VHR 2018',
-              'checked': false,
-              'layerId': 23
-            },
-            {
-              'title': 'VHR 2012',
-              'checked': false,
-              'layerId': 22
-            }
-          ]
-        },
-        {
-          'title': 'Surfaceobservation - ESA WorldCover',
-          'checked': false,
-          'children': [
-            {
-              'title': 'Worldcover 2020',
-              'checked': false,
-              'layerId': 26
-            }
-          ]
-        }
-      ]
-    },
-    {
-      'title': 'Community Contributions',
-      'checked': true,
-      'children': [
-        {
-          'title': 'Incora',
-          'checked': true,
-          'children': [
-            {
-              'title': 'Land Cover 2016',
-              'checked': false,
-              'layerId': 19
-            },
-            {
-              'title': 'Land Cover 2019',
-              'checked': false,
-              'layerId': 20
-            },
-            {
-              'title': 'Land Cover 2020',
-              'checked': true,
-              'layerId': 21
-            }
-          ]
-        },
-        {
-          'title': 'Building Height Map (DE)',
-          'checked': false,
-          'layerId': 27
-        },
-        {
-          'title': 'Land Cover Fraction Map (DE)',
-          'checked': false,
-          'layerId': 25
-        }
-      ]
-    },
-    {
-      'title': 'Backgroundlayer',
-      'checked': true,
-      'children': [
-        {
-          'title': 'GEBCO',
-          'checked': false,
-          'layerId': 28
-        },
-        {
-          'title': 'OSM-WMS',
-          'checked': false,
-          'layerId': 24
-        },
-        {
-          'title': 'OSM-WMS (gray)',
-          'checked': true,
-          'layerId': 16
-        }
-      ]
-    }
-  ]
-  }, null, '  ')
-  }
-
-
-
- -The layer tree consists of two different elements `Layer` and `Layer group` which are defined in the JSON document. A `Layer` has the following structure: -``` -'title': 'My Layer', -'checked': false, -'layerId': 42 -``` -One or more layers can be part of a `Layer group`. In this case they need to be added to the `children`-array as follow: -``` -'title': 'My Layer group', -'checked': true, -'children': [ - { - 'title': 'Layer 1', - 'checked': true, - 'layerId': 12 - }, - { - 'title': 'Layer 2', - 'checked': true, - 'layerId': 24 - }, - { - 'title': 'Layer 3', - 'checked': true, - 'layerId': 16 - } -] -``` -A `Layer group` can also be part of the `children`-array. In this case another hierarchy level will be added. - -:::caution - -The layerId has to be corresponding to the *[Subject](../admin-client/02-subject.md)s*-layerId! - -::: - -This is a full list of parameters that can be edited: - -|Key|Description|Example|Required| -|---|---|---|---| -|`title`|Layer- or group name displayed within the layer tree. If not set, the layer name of the internal geoserver will be used|'My base layers'|false| -|`checked`|Defines whether a layer or all layers within a layer group shall be visible initially|true|false| -|`children`|Array of layer and layer group|[{'title': 'layer 1', 'checked': true, 'layerId':1 }]|false| -|`layerId`|LayerId corresponding to the LayerId of the [Subject](../admin-client/02-subject.md)|1|true| - - - -## Layer configuration - -Within the layer configuration window, predefined layer settings from the [Subjects](../admin-client/02-subject.md) section can be overwritten and customized for the particular application. - -Each layer to be modified is an object within a array: -``` -[ - { - 'layerId': 1, - 'clientConfig': { - 'opacity': 0.5 - } - }, - { - 'layerId': 2, - 'clientConfig': { - 'hoverable': true - } - }, - { - 'layerId': 3, - 'sourceConfig': { - 'useBearerToken': true - } - } -] -``` - -This is a full list of parameters that can be edited: - -|Key|Description|Example|Required| -|---|---|---|---| -|`layerId`|LayerId corresponding to the LayerId of the [Subject](../admin-client/02-subject.md)|1|true| -|`clientConfig -> hoverable`|see [Client Configuration](../admin-client/02-subject.md)| -|`clientConfig -> maxResolution`|see [Client Configuration](../admin-client/02-subject.md)| -|`clientConfig -> minResolution`|see [Client Configuration](../admin-client/02-subject.md)| -|`clientConfig -> opacity`|see [Client Configuration](../admin-client/02-subject.md)| -|`clientConfig -> propertyConfig`|see [Client Configuration](../admin-client/02-subject.md)| -|`clientConfig -> searchable`|see [Client Configuration](../admin-client/02-subject.md)| -|`clientConfig -> searchConfig`|see [Client Configuration](../admin-client/02-subject.md)| -|`sourceConfig -> requestParams`|see [Source Configuration](../admin-client/02-subject.md)| -|`sourceConfig -> resolutions`|see [Source Configuration](../admin-client/02-subject.md)| -|`sourceConfig -> tileOrigin`|see [Source Configuration](../admin-client/02-subject.md)| -|`sourceConfig -> tileSize`|see [Source Configuration](../admin-client/02-subject.md)| -|`sourceConfig -> url`|see [Source Configuration](../admin-client/02-subject.md)| -|`sourceConfig -> useBearerToken`|see [Source Configuration](../admin-client/02-subject.md)| - -## Configure Tools - -This field stores the configuration for the application tools in JSON format: - -
-Tool configuration as JSON -
- 
-  {
-  JSON.stringify(
-  [
-  {
-    'name': 'measure_tools',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'measure_tools_distance',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'measure_tools_area',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_point',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_line',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_polygon',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_circle',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_rectangle',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_annotation',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_modify',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_upload',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_download',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'draw_tools_delete',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'feature_info',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'print',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'tree',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'permalink',
-    'config': {
-      'visible': true
-    }
-  },
-  {
-    'name': 'language_selector',
-    'config': {
-      'visible': true
-    }
-  }
-  ], null, '  ')
-  }
-
-
-
- -Every available tool from the toolbox is recorded in this document. By changing the visibility of any tool to `true`, it is made available in the Web-GIS application. Please note that some tools also depend on other parameters (e.g. the queryability of a layer). - -This is a full list of parameters that can be edited: - -|Key|Description| -|---|---| -|`name`|Name of the tool. This parameter should not be edited| -|`config -> visible`|Sets the visibility of a certain tool within the Web-GIS application| - -:::info - -If you leave the configuration blank, all tools will be available by default. As soon as one tool is added to the configuration, all other tools will be unavailable until they are also explicitly added. - -::: - - - -## User permissions - -In the user permission field, users can be activated for the specific applications and assigned user permissions. - -![user_permissions](../../static/img/user_permissions.png) - -Clicking on the ![admin-client](../../static/img/plus.png) button opens a new window with two input fields: - -![add_permissions](../../static/img/add_permission.png) - -After entering the e-mail address of a user, various permissions can be assigned to that specific user. The following permissions are available: - -|Key|Description| -|---|---| -|`Read`|All authenticated users can access the Web-GIS application| -|`Update`|If set the user can modify the application configuration| -|`Update & Delete`|If set the user can modify and completely delete the application| -|`Owner`|If set the user can modify and delete the JSON-files configuring the Web-GIS and grant permissions to new users| - -:::info - -Every user listed within the permission grid has access to the Web-GIS application. Permissions other than `Read` only affect users who also have the `admin` role, since only these users can access the admin client and thus change the configurations. - -::: - - diff --git a/docs/admin-client/02-subject.md b/docs/admin-client/02-subject.md deleted file mode 100644 index 8582ae3..0000000 --- a/docs/admin-client/02-subject.md +++ /dev/null @@ -1,80 +0,0 @@ -# Subjects -*** -Under the menu-item *Subjects* external WMS can be persisted for the applications and custom raster or vector data can be imported. In addition, various settings can be made for each layer. - -![subjects_overview](../../static/img/subjects_overview.png) - -Existing services can be modified by clicking in the respective row within the subject-grid. To add a new WMS service click the ![create_subject](../../static/img/create_subject.png) button. - -Raster or Vector data can be imported via the ![upload_subject](../../static/img/upload_subject.png) button. - -Once a subject got modified, it can be saved via the ![save_subject](../../static/img/save_subject.png) button. - -Unsaved changes can be reset by the ![reset_subject](../../static/img/reset_subject.png) button. - -When creating/editing a subject, the field *Datasource* must be filled in addition to the name for the subject as well as the type (can be selected from the suggestion list). - -## Configuration - -This field stores the configuration for the respective subject in JSON format and could look like as follows: - -``` -{ - "hoverable": false, - "opacity": 0.5, - "downloadConfig": [ - { - "downloadUrl": "https://my-url.org/my/path/to/the/subject.tiff", - "formatName": "my-subject" - } - ] -} -``` - -This is a full list of parameters that can be edited: - -|Key|Description|Example|Required| -|---|---|---|---| -|`crossOrigin`|Set to 'anonymous' if you encounter any problems while querying a layer in the Web-GIS application. Usually you don't want to overwrite this.|'anonymous'|false| -|`downloadConfig`|List of download configurations. If set, a new menu-item within the layertree appears to download the layer|https://example.com/geoserver/SHOGUN/ows?service=WFS&version=1.0.0&request=GetFeature&outputFormat=application%2Fjson|false| -|`downloadConfig -> downloadUrl`|URL which allows to download the layer data|see above|true| -|`downloadConfig -> formatName`|The displayed format name for the given downloadUrl. If not set it will be set to 'XML'|'GeoJSON'|false| -|`hoverable`|Determines whether map features may be queried using the Query map features tool|true|false| -|`maxResolution`|The maximum resolution of the layer (to which resolution/zoom level the layer should be visible)|100000|false| -|`minResolution`|The minimum resolution of the layer (at what resolution/zoom level the layer should become visible)|10000|false| -|`opacity`|Sets the initial opacity for the layer with a range from 0-1|0.5|false| -|`propertyConfig`|Is currently not in use||false| -|`searchable`|Is currently not in use||false| -|`searchConfig`|Is currently not in use||false| - -## Datasource - -This field defines the source of the subject in JSON format. Depending on the type of the topic, the datastructure differs: - - -``` -{ - "url": "https://ows.terrestris.de/osm-gray/service?", - "layerNames": "OSM-WMS", - "attribution": "© OpenStreetMap contributors", - "useBearerToken": false -} -``` - -This is a full list of parameters that can be edited: - -|Key|Description|Example|Required| -|---|---|---|---| -|`url`|The base URL of the layer|https://ows.terrestris.de/osm-gray/service?|true| -|`layerNames`|A comma separated list of layers to request|'OSM-WMS'|true| -|`attribution`|The copyright attribution to be shown for this layer. It will be rendered in the bottom corner of the map.|`© OpenStreetMap contributors`|false| -|`useBearerToken`|Whether to send the (internal) Keycloak Bearer Token alongside the map requests or not. Has to be set to 'true' when a layer is requested from the internal GeoServer|true|false| -|`legendUrl`|An URL to a custom legend image that will be displayed within the layertree|https://ows.terrestris.de/ows/my-legend.png|false| -|`matrixSet`|Tile Matrix Set identifier, which determines the CRS into which the layer will be exposed. Must be one of the listed tile matrix for the layer. See details here https://gdal.org/drivers/raster/wmts.html|'WEBMERCATOR'|false| -|`requestParams`|Request parameters to be passed to the map server when querying a layer e.g. via GetMap. This can be useful if you want to pass server specific parameters|'{\"transparent\": true}'|false| -|`resolutions`|The list of resolutions the layer should be requested on|'[2445.9849047851562, 1222.9924523925781, 611.4962261962891]'|false| -|`tileOrigin`|Origin of the tile grid. Usually you don't want to set a custom value. See here for details ToDo.||false| -|`tileSize`|Sets the tile size. Default is 256 |512|false| - - diff --git a/docs/admin-client/index.md b/docs/admin-client/index.md deleted file mode 100644 index ed2aa07..0000000 --- a/docs/admin-client/index.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -id: Admin-Client -title: Admin-Client -description: Admin-Client -sidebar_position: 3 -sidebar_label: Admin-Client ---- - -# Admin-Client -*** -The [Admin-Client](https://shogun2022.intranet.terrestris.de/admin) is used to create individual **Web-GIS applications**. You can define which layers should initially be available for an application, which users should have access to the application and which tools are available. In addition, further styling settings can be made and the resolution as well as the projection can be set. - -![admin-client](../../static/img/admin.png) - -Only users with the **Admin** role have access to the [Admin-Client](https://shogun2022.intranet.terrestris.de/admin) and can create or modify Web-GIS applications. - -After successful login, the administrator sees the dashboard in the right area, which lists the existing entities (Applications and Subjects) in short form. By clicking on an entry in the respective lists, a desired entry can be selected directly. diff --git a/docs/gis-client/01-header.md b/docs/gis-client/01-header.md new file mode 100644 index 0000000..54c86d4 --- /dev/null +++ b/docs/gis-client/01-header.md @@ -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. + + + + diff --git a/docs/gis-client/02-toolbox.md b/docs/gis-client/02-toolbox.md new file mode 100644 index 0000000..0d990c5 --- /dev/null +++ b/docs/gis-client/02-toolbox.md @@ -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. + +::: + + + +## 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. + +::: + + + +## 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. + +::: + + + +## 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. + +::: + + + +## Language selector + +The language selector can be used to switch the applications language. diff --git a/docs/gis-client/03-footer.md b/docs/gis-client/03-footer.md new file mode 100644 index 0000000..9743cca --- /dev/null +++ b/docs/gis-client/03-footer.md @@ -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. + diff --git a/docs/gis-client/index.md b/docs/gis-client/index.md index 600404a..d60f549 100644 --- a/docs/gis-client/index.md +++ b/docs/gis-client/index.md @@ -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. diff --git a/docs/overview/index.md b/docs/overview/index.md deleted file mode 100644 index 4173761..0000000 --- a/docs/overview/index.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -id: overview -title: overview -description: overview -sidebar_position: 1 -sidebar_label: General overview ---- - -# General overview -*** -The basic technology behind the **SHOGun**-web-application is made up of various components as shown in the following image: - -![components](../../static/img/components.png) - -For the usage of the SHOGun-Web-GIS in particular two components are important: -- [Admin-Client](../admin-client/index.md) -- [GIS-Client](../gis-client/index.md) - -The [Admin-Client](../admin-client/index.md) component is basically an UI for handling SHOGun entities like users, applications, and layers. Whereas the [GIS-Client](../gis-client/index.md) represents a created instance from the admin client. diff --git a/docusaurus.config.js b/docusaurus.config.js index 708178d..c9f8d2c 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -8,11 +8,11 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); const config = { title: 'SHOGun', tagline: 'Documentation', - favicon: 'img/shogun_logo.png', + favicon: './img/shogun_logo.png', // Set the production url of your site here url: 'http://localhost/', - baseUrl: '/shogun-docs/', + baseUrl: 'shogun-docs', // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. @@ -25,10 +25,18 @@ const config = { // Even if you don't use internalization, you can use this field to set useful // metadata like html lang. For example, if your site is Chinese, you may want // to replace "en" with "zh-Hans". - // i18n: { - // defaultLocale: 'en', - // locales: ['en'], - // }, +i18n: { + defaultLocale: 'en', + locales: ['en', 'de'], + localeConfigs: { + en: { + label: 'English' + }, + de: { + label: 'Deutsch' + }, + }, + }, presets: [ [ @@ -50,25 +58,29 @@ const config = { /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ // Replace with your project's social card - image: 'src/images/shogun_logo.png', + image: './img/shogun_logo.png', navbar: { - // title: 'Web-GIS', + title: 'SHOGun', logo: { alt: 'SHOGun logo', - src: 'img/shogun_logo.png', + src: './img/shogun_logo.png', }, items: [ { type: 'docSidebar', sidebarId: 'tutorialSidebar', position: 'left', - label: 'Tutorial', + label: 'Manual', }, { href: '/~https://github.com/terrestris/shogun-docker', label: 'GitHub', position: 'right', }, + { + type: 'localeDropdown', + position: 'right', + }, ], }, footer: { diff --git a/i18n/de/code.json b/i18n/de/code.json new file mode 100644 index 0000000..a771129 --- /dev/null +++ b/i18n/de/code.json @@ -0,0 +1,279 @@ +{ + "theme.ErrorPageContent.title": { + "message": "Die Seite ist abgestürzt.", + "description": "The title of the fallback page when the page crashed" + }, + "theme.NotFound.title": { + "message": "Seite nicht gefunden", + "description": "The title of the 404 page" + }, + "theme.NotFound.p1": { + "message": "Wir konnten nicht finden, wonach Sie gesucht haben.", + "description": "The first paragraph of the 404 page" + }, + "theme.NotFound.p2": { + "message": "Bitte kontaktieren Sie den Besitzer der Seite, die Sie mit der ursprünglichen URL verlinkt hat, und teilen Sie ihm mit, dass der Link nicht mehr funktioniert.", + "description": "The 2nd paragraph of the 404 page" + }, + "theme.admonition.note": { + "message": "note", + "description": "The default label used for the Note admonition (:::note)" + }, + "theme.admonition.tip": { + "message": "tip", + "description": "The default label used for the Tip admonition (:::tip)" + }, + "theme.admonition.danger": { + "message": "danger", + "description": "The default label used for the Danger admonition (:::danger)" + }, + "theme.admonition.info": { + "message": "info", + "description": "The default label used for the Info admonition (:::info)" + }, + "theme.admonition.caution": { + "message": "caution", + "description": "The default label used for the Caution admonition (:::caution)" + }, + "theme.blog.archive.title": { + "message": "Archiv", + "description": "The page & hero title of the blog archive page" + }, + "theme.blog.archive.description": { + "message": "Archiv", + "description": "The page & hero description of the blog archive page" + }, + "theme.BackToTopButton.buttonAriaLabel": { + "message": "Zurück nach oben scrollen", + "description": "The ARIA label for the back to top button" + }, + "theme.blog.paginator.navAriaLabel": { + "message": "Navigation der Blog-Listenseite", + "description": "The ARIA label for the blog pagination" + }, + "theme.blog.paginator.newerEntries": { + "message": "Neuere Einträge", + "description": "The label used to navigate to the newer blog posts page (previous page)" + }, + "theme.blog.paginator.olderEntries": { + "message": "Ältere Einträge", + "description": "The label used to navigate to the older blog posts page (next page)" + }, + "theme.blog.post.paginator.navAriaLabel": { + "message": "Blog Post Seiten Navigation", + "description": "The ARIA label for the blog posts pagination" + }, + "theme.blog.post.paginator.newerPost": { + "message": "Neuer Post", + "description": "The blog post button label to navigate to the newer/previous post" + }, + "theme.blog.post.paginator.olderPost": { + "message": "Älterer Post", + "description": "The blog post button label to navigate to the older/next post" + }, + "theme.blog.post.plurals": { + "message": "Ein Post|{count} Posts", + "description": "Pluralized label for \"{count} posts\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.blog.tagTitle": { + "message": "{nPosts} getaggt mit \"{tagName}\"", + "description": "The title of the page for a blog tag" + }, + "theme.tags.tagsPageLink": { + "message": "Alle Tags anzeigen", + "description": "The label of the link targeting the tag list page" + }, + "theme.colorToggle.ariaLabel": { + "message": "Umschalten zwischen dunkler und heller Ansicht (momentan {mode})", + "description": "The ARIA label for the navbar color mode toggle" + }, + "theme.colorToggle.ariaLabel.mode.dark": { + "message": "dunkler Modus", + "description": "The name for the dark color mode" + }, + "theme.colorToggle.ariaLabel.mode.light": { + "message": "heller Modus", + "description": "The name for the light color mode" + }, + "theme.docs.breadcrumbs.navAriaLabel": { + "message": "Breadcrumbs", + "description": "The ARIA label for the breadcrumbs" + }, + "theme.docs.DocCard.categoryDescription": { + "message": "{count} Einträge", + "description": "The default description for a category card in the generated index about how many items this category includes" + }, + "theme.docs.paginator.navAriaLabel": { + "message": "Dokumentation Seiten", + "description": "The ARIA label for the docs pagination" + }, + "theme.docs.paginator.previous": { + "message": "Zurück", + "description": "The label used to navigate to the previous doc" + }, + "theme.docs.paginator.next": { + "message": "Weiter", + "description": "The label used to navigate to the next doc" + }, + "theme.docs.tagDocListPageTitle.nDocsTagged": { + "message": "Ein doc getaggt|{count} docs getaggt", + "description": "Pluralized label for \"{count} docs tagged\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.tagDocListPageTitle": { + "message": "{nDocsTagged} mit \"{tagName}\"", + "description": "The title of the page for a docs tag" + }, + "theme.docs.versionBadge.label": { + "message": "Version: {versionLabel}" + }, + "theme.docs.versions.unreleasedVersionLabel": { + "message": "Das ist die unveröffentlichte Dokumentation für {siteTitle} {versionLabel}.", + "description": "The label used to tell the user that he's browsing an unreleased doc version" + }, + "theme.docs.versions.unmaintainedVersionLabel": { + "message": "Das ist die Dokumentation für {siteTitle} {versionLabel} und wird nicht weiter gewartet.", + "description": "The label used to tell the user that he's browsing an unmaintained doc version" + }, + "theme.docs.versions.latestVersionSuggestionLabel": { + "message": "Für die aktuellste Dokumentation bitte auf {latestVersionLink} ({versionLabel}) gehen.", + "description": "The label used to tell the user to check the latest version" + }, + "theme.docs.versions.latestVersionLinkLabel": { + "message": "letzte Version", + "description": "The label used for the latest version suggestion link label" + }, + "theme.common.editThisPage": { + "message": "Diese Seite bearbeiten", + "description": "The link label to edit the current page" + }, + "theme.common.headingLinkTitle": { + "message": "Direkter Link zur {heading}", + "description": "Title for link to heading" + }, + "theme.lastUpdated.atDate": { + "message": " am {date}", + "description": "The words used to describe on which date a page has been last updated" + }, + "theme.lastUpdated.byUser": { + "message": " von {user}", + "description": "The words used to describe by who the page has been last updated" + }, + "theme.lastUpdated.lastUpdatedAtBy": { + "message": "Letztes Update{atDate}{byUser}", + "description": "The sentence used to display when a page has been last updated, and by who" + }, + "theme.navbar.mobileVersionsDropdown.label": { + "message": "Versionen", + "description": "The label for the navbar versions dropdown on mobile view" + }, + "theme.tags.tagsListLabel": { + "message": "Tags:", + "description": "The label alongside a tag list" + }, + "theme.AnnouncementBar.closeButtonAriaLabel": { + "message": "Schließen", + "description": "The ARIA label for close button of announcement bar" + }, + "theme.blog.sidebar.navAriaLabel": { + "message": "Navigation der letzten Beiträge im Blog", + "description": "The ARIA label for recent posts in the blog sidebar" + }, + "theme.CodeBlock.copied": { + "message": "Kopiert", + "description": "The copied button label on code blocks" + }, + "theme.CodeBlock.copyButtonAriaLabel": { + "message": "In die Zwischenablage kopieren", + "description": "The ARIA label for copy code blocks button" + }, + "theme.CodeBlock.copy": { + "message": "Kopieren", + "description": "The copy button label on code blocks" + }, + "theme.CodeBlock.wordWrapToggle": { + "message": "Toggle word wrap", + "description": "The title attribute for toggle word wrapping button of code block lines" + }, + "theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel": { + "message": "Umschalten der Seitenleiste mit einklappbarer Kategorie '{label}'", + "description": "The ARIA label to toggle the collapsible sidebar category" + }, + "theme.NavBar.navAriaLabel": { + "message": "Main", + "description": "The ARIA label for the main navigation" + }, + "theme.navbar.mobileLanguageDropdown.label": { + "message": "Sprachen", + "description": "The label for the mobile language switcher dropdown" + }, + "theme.TOCCollapsible.toggleButtonLabel": { + "message": "Auf dieser Seite", + "description": "The label used by the button on the collapsible TOC component" + }, + "theme.blog.post.readMore": { + "message": "Mehr lesen", + "description": "The label used in blog post item excerpts to link to full blog posts" + }, + "theme.blog.post.readMoreLabel": { + "message": "Mehr lesen über {title}", + "description": "The ARIA label for the link to full blog posts from excerpts" + }, + "theme.blog.post.readingTime.plurals": { + "message": "Eine Minute Lesezeit|{readingTime} Minuten Lesezeit", + "description": "Pluralized label for \"{readingTime} min read\". Use as much plural forms (separated by \"|\") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)" + }, + "theme.docs.breadcrumbs.home": { + "message": "Home page", + "description": "The ARIA label for the home page in the breadcrumbs" + }, + "theme.docs.sidebar.collapseButtonTitle": { + "message": "Seitenleiste einklappen", + "description": "The title attribute for collapse button of doc sidebar" + }, + "theme.docs.sidebar.collapseButtonAriaLabel": { + "message": "Seitenleiste einklappen", + "description": "The title attribute for collapse button of doc sidebar" + }, + "theme.docs.sidebar.navAriaLabel": { + "message": "Docs sidebar", + "description": "The ARIA label for the sidebar navigation" + }, + "theme.docs.sidebar.closeSidebarButtonAriaLabel": { + "message": "Close navigation bar", + "description": "The ARIA label for close button of mobile sidebar" + }, + "theme.navbar.mobileSidebarSecondaryMenu.backButtonLabel": { + "message": "← Zurück zum Hauptmenü", + "description": "The label of the back button to return to main menu, inside the mobile navbar sidebar secondary menu (notably used to display the docs sidebar)" + }, + "theme.docs.sidebar.toggleSidebarButtonAriaLabel": { + "message": "Toggle navigation bar", + "description": "The ARIA label for hamburger menu button of mobile navigation" + }, + "theme.docs.sidebar.expandButtonTitle": { + "message": "Seitenleiste ausklappen", + "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.docs.sidebar.expandButtonAriaLabel": { + "message": "Seitenleiste ausklappen", + "description": "The ARIA label and title attribute for expand button of doc sidebar" + }, + "theme.ErrorPageContent.tryAgain": { + "message": "Nochmal versuchen", + "description": "The label of the button to try again rendering when the React error boundary captures an error" + }, + "theme.common.skipToMainContent": { + "message": "Zum Hauptinhalt springen", + "description": "The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation" + }, + "theme.tags.tagsPageTitle": { + "message": "Tags", + "description": "The title of the tag list page" + }, + "Welcome to the SHOGun-Manual. This manual is designed to give a comprehensive overview of the functionalities of the SHOGun-Web-GIS application.": { + "message": "Willkommen im Benutzerhandbuch für SHOGun. Dieses Handbuch gibt einen Überblick über die Funktionalität von SHOGun-Web-GIS-Applikationen." + }, + "Manual": { + "message": "Handbuch" + } +} diff --git a/i18n/de/docusaurus-plugin-content-docs/current.json b/i18n/de/docusaurus-plugin-content-docs/current.json new file mode 100644 index 0000000..2fa0568 --- /dev/null +++ b/i18n/de/docusaurus-plugin-content-docs/current.json @@ -0,0 +1,14 @@ +{ + "version.label": { + "message": "Next", + "description": "The label for version current" + }, + "sidebar.tutorialSidebar.category.Admin-Client": { + "message": "Admin-Client", + "description": "The label for category Admin-Client in sidebar tutorialSidebar" + }, + "sidebar.tutorialSidebar.category.GIS-Client": { + "message": "GIS-Client", + "description": "The label for category GIS-Client in sidebar tutorialSidebar" + } +} diff --git a/docs/gis-client/01-measure.md b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/01-measure.md similarity index 100% rename from docs/gis-client/01-measure.md rename to i18n/de/docusaurus-plugin-content-docs/current/gis-client/01-measure.md diff --git a/docs/gis-client/02-draw.md b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/02-draw.md similarity index 100% rename from docs/gis-client/02-draw.md rename to i18n/de/docusaurus-plugin-content-docs/current/gis-client/02-draw.md diff --git a/docs/gis-client/03-query-map-features.md b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/03-query-map-features.md similarity index 100% rename from docs/gis-client/03-query-map-features.md rename to i18n/de/docusaurus-plugin-content-docs/current/gis-client/03-query-map-features.md diff --git a/docs/gis-client/04-export.md b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/04-export.md similarity index 100% rename from docs/gis-client/04-export.md rename to i18n/de/docusaurus-plugin-content-docs/current/gis-client/04-export.md diff --git a/docs/gis-client/05-layertree.md b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/05-layertree.md similarity index 100% rename from docs/gis-client/05-layertree.md rename to i18n/de/docusaurus-plugin-content-docs/current/gis-client/05-layertree.md diff --git a/docs/gis-client/06-share.md b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/06-share.md similarity index 100% rename from docs/gis-client/06-share.md rename to i18n/de/docusaurus-plugin-content-docs/current/gis-client/06-share.md diff --git a/docs/gis-client/07-language-selector.md b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/07-language-selector.md similarity index 100% rename from docs/gis-client/07-language-selector.md rename to i18n/de/docusaurus-plugin-content-docs/current/gis-client/07-language-selector.md diff --git a/i18n/de/docusaurus-plugin-content-docs/current/gis-client/index.md b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/index.md new file mode 100644 index 0000000..21bc9d3 --- /dev/null +++ b/i18n/de/docusaurus-plugin-content-docs/current/gis-client/index.md @@ -0,0 +1,45 @@ +--- +id: GIS-Client +title: GIS-Client +description: GIS-Client +sidebar_position: 1 +sidebar_label: GIS-Client +--- + +# GIS-Client + +## Übersicht + +Der grundlegende Aufbau einer GIS-Client-Applikation ist in der folgenden Abbildung ersichtlich: + +![gis-client](/img/application_overview_de.png) + +## Kopfzeile + +Die Kopfzeile ist ständig sichtbar, wenn die Applikation geöffnet ist. In der Kopfzeile finden sich folgende Informationen und Werkzeuge: + +Links werden das Logo und der Titel der Applikation angezeigt. + +Mittig in der Kopfzeile befindet sich die Suchleiste. + +In der rechten Ecke der Kopfzeile findet sich das Nutzersymbol mit der Möglichkeit zum Ausloggen aus der Applikation. + +## Toolbox + +Im linken oberen Bereich des Hauptinhaltbereichs wird die Toolbox angezeigt. Hier werden verschiedene Werkzeuge angeboten. Weitere Informationen zu den Funktionen in der Toolbox finden sich [hier](../gis-client/toolbox). + +## Kartenbereich + +Die Karte wird im eigentlichen Inhaltsbereich der Applikation zwischen Kopf- und Fußzeile angezeigt. + +In der rechten unteren Ecke werden die Copyright-Informationen zu den aktivierten Karten angezeigt. Die Anzeige ist zunächst eingeklappt, kann über einen Klick auf das i aber ausgeklappt werden. + +## Fußzeile + +Die Fußzeile ist ständig sichtbar, wenn die Applikation geöffnet ist. In der Fußzeile finden sich folgende Informationen und Werkzeuge: + +Links befindet sich der Maßstabsbalken, gefolgt von einem Auswahlmenü des Maßstabs. + +Es folgt die Anzeige des Bezugssystems und der aktuellen Mausposition, sofern die Maus in einem Bereich der Hauptkarte platziert ist. + +In der rechten Ecke der Fußzeile finden sich die weiterführenden Links für Kontakt, Impressum und Datenschutz. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/glossar/index.md b/i18n/de/docusaurus-plugin-content-docs/current/glossar/index.md new file mode 100644 index 0000000..a074597 --- /dev/null +++ b/i18n/de/docusaurus-plugin-content-docs/current/glossar/index.md @@ -0,0 +1,38 @@ +--- +id: Glossary +title: Glossary +description: Glossary +sidebar_position: 6 +sidebar_label: Glossary +--- + +# Glossary + +## Permission + +In the first place permissions are used to grant a user access to an application. In addition, various restrictions for the individual **Applications** can be applied. Since only the admin-user has access to the admin client, the restrictions mainly impact the admin-user. + +The following permissions can be granted to each user: + +|Key|Description| +|---|---| +|`Read`|If corresponding to the users role, the user can read the JSON-files configuring the Web-GIS| +|`Update`|If corresponding to the users role, the user can modify the JSON-files configuring the Web-GIS| +|`Update & Delete`|If corresponding to the users role, the user can modify and delete the JSON-files configuring the Web-GIS| +|`Owner`|If corresponding to the users role, the user can modify and delete the JSON-files configuring the Web-GIS and grant permissions to new users| + +We would recommend granting every user the `Read` permission except for the owner of the application. + +:::info + +Every user listed within the permission grid has access to the Web-GIS application. The permissions granted mainly affect users who also have the `admin` role, as only these users can access the admin client and thus modify the configurations. + +::: + +## Application + +An application is a defined configuration of a Web-GIS. It can be determined which user should have access rights to the Web-GIS, as well as which layers should be displayed by default in which zoom level for which extent. It can be individually defined which tools should be available, as well as which color, name and logo the Web-GIS should have. + +## Subject + +A predefined list of layers that can be added to an instance and can be available by default according to the properties set. diff --git a/i18n/de/docusaurus-plugin-content-docs/current/workflows/index.md b/i18n/de/docusaurus-plugin-content-docs/current/workflows/index.md new file mode 100644 index 0000000..8e3a3b3 --- /dev/null +++ b/i18n/de/docusaurus-plugin-content-docs/current/workflows/index.md @@ -0,0 +1,372 @@ +--- +id: Workflows +title: Workflows +description: Workflows +sidebar_position: 5 +sidebar_label: Workflows +--- + +## Create a new application + +1. Log in to the [Admin-Client](https://shogun2022.intranet.terrestris.de/admin) and authenticate as a admin-user + +2. Select *Application* menu item + +3. Click ![create_instance](/img/create_instance.png) button to create a new Web-GIS application + +4. To save an instance, it is first necessary to specify a name + +5. Use the following JSON-script for the *Client configuration*: + +
+Client configuration +
+ 
+  {
+  JSON.stringify(
+{
+  "mapView": {
+    "zoom": 2,
+    "center": [
+      10,
+      51
+    ],
+    "extent": null,
+    "projection": "EPSG:3857",
+    "resolutions": [
+      8920,
+      4480,
+      2240,
+      1120,
+      560,
+      350,
+      280,
+      140,
+      70,
+      28,
+      14,
+      7,
+      2.8,
+      1.4,
+      0.7,
+      0.28,
+      0.07
+    ]
+  },
+  "description": "The default application",
+  "legal": {
+    "contact": "https://www.terrestris.de/de/kontakt/",
+    "imprint": "https://www.terrestris.de/de/impressum/",
+    "privacy": "https://www.terrestris.de/de/datenschutzerklaerung/"
+  },
+  "theme": {
+    "primaryColor": "#555555",
+    "secondaryColor": "#73b3fb",
+    "complementaryColor": "#ffffff",
+    "logoPath": "null"
+  }
+  }, null, '  ')
+  }
+
+
+
+ +More detailed information about the attributes can be found in the [admin-client documentation](../admin-client/02-subject.md). + +6. Use the following JSON-script for the *Layertree*-configuration: + +
+Layertree configuration +
+ 
+  {
+  JSON.stringify(
+{
+  "title": "root",
+  "children": [
+    {
+      "title": "Copernicus Services",
+      "checked": false,
+      "children": [
+        {
+          "title": "VHR 2018",
+          "checked": false,
+          "layerId": 1
+        },
+        {
+          "title": "VHR 2012",
+          "checked": false,
+          "layerId": 2
+        }
+      ]
+    },
+    {
+      "title": "OSM-WMS(gray)",
+      "checked": true,
+      "layerId": 3
+    }
+  ]
+  }, null, '  ')
+  }
+
+
+
+ +:::caution + +The layerId has to be corresponding to the *Subjects*-layerId! + +::: + +7. If the layers are already added as a Subject, you can skip this step. If the layers still need to be added: + + * Switch to *Subjects* menu item + +
+ Add Land - VHR Mosaik 2018-layer +
+
    +
  1. Click create subject button to create a new Web-GIS application
    2. +
  2. Name the first layer Land - VHR Mosaik 2018 and choose the type TILEWMS
    3. +
  3. Use the following JSON-script as a Datasource:
    4. + 
    +        {
+        JSON.stringify(
+        {
+        "url": "https://copernicus.discomap.eea.europa.eu/arcgis/services/GioLand/VHR_2018_WM/ImageServer/WMSServer",
+        "layerNames": "VHR_2018_WM:VHR2018",
+        "useBearerToken": false
+        }, null, '  ')
+        }
+
    +
  4. Save the subject via the save subject button
    5. +
+
+
+ +
+ Add Land - VHR Mosaik 2012 +
+
    +
  1. Click create subject button to create a new Web-GIS application
    2. +
  2. Name the first layer Land - VHR Mosaik 2012 and choose the type TILEWMS
    3. +
  3. Use the following JSON-script as a Datasource:
    4. + 
    +        {
+        JSON.stringify(
+        {
+        "url": "https://copernicus.discomap.eea.europa.eu/arcgis/services/GioLand/VeryHighResolution2012/MapServer/WMSServer",
+        "layerNames": "core003_Mosaic_NaturalColor_Feathering",
+        "useBearerToken": false
+        }, null, '  ')
+        }
+
    +
  4. Save the subject via the save subject button
    5. +
+
+
+ +
+ Add OSM-WMS (gray) +
+
    +
  1. Click create subject button to create a new Web-GIS application
    2. +
  2. Name the first layer OSM-WMS (gray) and choose the type TILEWMS
    3. +
  3. Use the following JSON-script as a Datasource:
    4. + 
    +        {
+        JSON.stringify(
+        {
+        "url": "https://ows.terrestris.de/osm-gray/service?",
+        "layerNames": "OSM-WMS",
+        "attribution": "© OpenStreetMap contributors",
+        "useBearerToken": false
+        }, null, '  ')
+        }
+
    +
  4. Save the subject via the save subject button
    5. +
+
+
+ +8. Use the following JSON-script to define which tools shall be available for the Web-GIS application: + +
+List of tools +
+ 
+  {
+  JSON.stringify(
+  [
+  {
+    "name": "measure_tools",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "measure_tools_distance",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "measure_tools_area",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_point",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_line",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_polygon",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_circle",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_rectangle",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_annotation",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_modify",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_upload",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_download",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "draw_tools_delete",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "feature_info",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "print",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "tree",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "permalink",
+    "config": {
+      "visible": true
+    }
+  },
+  {
+    "name": "language_selector",
+    "config": {
+      "visible": true
+    }
+  }
+  ], null, '  ')
+  }
+
+
+
+ +9. At this point the Web-GIS application is ready to use and can be accessed by the admin-user. If multiple users should access the application, access rights must be granted to the respective users. This is done via the *User permissions*-grid: + + 1. Click on the ![plus](/img/plus.png) + 2. Type in the *Username* or the *email address* of the user you want to grant access + 3. Select the permission *Read* + 4. Confirm your request + +10. To open the Web-GIS application just click on the *Link to application* within the respective row of the applications grid + +## Share a customized application + +1. Open the Web-GIS client and customize the predefined application according to your needs, for example by loading a new WMS or deselect existing ones. In addition, you could zoom in on a specific map section to change the extent. + +2. Use the [Share](../gis-client/06-share.md) tool within your toolbox to share your customized application: + +![share](/img/share.png) + +3. You can send the generated URL directly via twitter, whatsapp or email. Alternatively, you can copy the link to the clipboard. + +:::info + +The created URL has all the set information. Any authenticated user can access the modified application via the provided link. + +::: + +4. Open the newly generated URL in a new Tab + +:::info + +As long as the layers are available under their URL or within the internal GeoServer, the link will be valid. + +::: + +## Upload vector or raster data and display it in the Web-GIS + +1. Log in to the [Admin-Client](https://shogun2022.intranet.terrestris.de/admin) and authenticate as a admin-user + +2. Switch to the content [Subjects](../admin-client/02-subject.md) + +3. Click the ![upload-subject](/img/upload_subject.png) button and upload a geoTIFF or ShapeFile. Alternatively the files can also be added via Drag&Drop onto the upload button. + +:::caution + +The ShapeFile data need to be zipped. + +::: + +4. A new [Subject](../admin-client/02-subject.md) will be added to the list of existing ones + +5. Switch to the content [Instance](../admin-client/01-instance.md) and edit the **layertree** configuration + +6. Add a new layer to the **layertree** and link the layer with the **LayerId** corresponding to the **Subjects LayerId** diff --git a/i18n/de/docusaurus-theme-classic/footer.json b/i18n/de/docusaurus-theme-classic/footer.json new file mode 100644 index 0000000..f7a5eaf --- /dev/null +++ b/i18n/de/docusaurus-theme-classic/footer.json @@ -0,0 +1,26 @@ +{ + "link.title.Community": { + "message": "Community", + "description": "The title of the footer links column with title=Community in the footer" + }, + "link.item.label.terrestris": { + "message": "terrestris", + "description": "The label of footer link with label=terrestris linking to https://www.terrestris.de/de/" + }, + "link.item.label.GitHub": { + "message": "GitHub", + "description": "The label of footer link with label=GitHub linking to /~https://github.com/terrestris" + }, + "link.item.label.Twitter": { + "message": "Twitter", + "description": "The label of footer link with label=Twitter linking to https://twitter.com/terrestrisde/" + }, + "link.item.label.Mastodon": { + "message": "Mastodon", + "description": "The label of footer link with label=Mastodon linking to https://bonn.social/@terrestris" + }, + "copyright": { + "message": "Copyright © 2023 @terrestris. Built with Docusaurus.", + "description": "The footer copyright" + } +} diff --git a/i18n/de/docusaurus-theme-classic/navbar.json b/i18n/de/docusaurus-theme-classic/navbar.json new file mode 100644 index 0000000..93b8ddb --- /dev/null +++ b/i18n/de/docusaurus-theme-classic/navbar.json @@ -0,0 +1,18 @@ +{ + "logo.alt": { + "message": "SHOGun logo", + "description": "The alt text of navbar logo" + }, + "item.label.GitHub": { + "message": "GitHub", + "description": "Navbar item with label GitHub" + }, + "title": { + "message": "SHOGun", + "description": "The title in the navbar" + }, + "item.label.Manual": { + "message": "Handbuch", + "description": "Navbar item with label Manual" + } +} diff --git a/src/pages/index.js b/src/pages/index.js index 0a4f6b2..067526c 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -4,6 +4,7 @@ import Link from '@docusaurus/Link'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; import styles from './index.module.css'; +import Translate, {translate} from '@docusaurus/Translate'; function HomepageHeader() { const { siteConfig } = useDocusaurusContext(); @@ -15,8 +16,8 @@ function HomepageHeader() {
- Documentation + to="docs/gis-client"> + Manual
@@ -38,9 +39,9 @@ export default function Home() {

- Welcome to the SHOGun-Manual.
+ Welcome to the SHOGun-Manual. This manual is designed to give a comprehensive overview of the functionalities - of the SHOGun-Web-GIS application based on the Userstories. + of the SHOGun-Web-GIS application.

Authors: