Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: init pdf export #4

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@ node_modules
npm-debug.log*
yarn-debug.log*
yarn-error.log*
/test-results/
/playwright-report/
/playwright/.cache/
4 changes: 2 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM node:16.15.1-alpine as build
FROM node:18.17.1-alpine as build

WORKDIR /app

Expand All @@ -11,7 +11,7 @@ COPY . ./

RUN npm run build

FROM nginx:1.24.0-alpine
FROM nginx:1.25.2-alpine

COPY --from=build /app/build /usr/share/nginx/html

Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Integration into SHOGun Projects
# SHOGun Documentation

This repository contains the documentation for the SHOGun webapplication.

### nginx

Set the nginx location to `/shogun-docs/`

# ToDo's
Expand Down
6 changes: 3 additions & 3 deletions docs/overview/index.md → docs/1_overview/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The basic technology behind the **SHOGun**-web-application is made up of various
![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)
- [Admin-Client](../2_admin-client/index.md)
- [GIS-Client](../3_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.
The [Admin-Client](../2_admin-client/index.md) component is basically an UI for handling SHOGun entities like users, applications, and layers. Whereas the [GIS-Client](../3_gis-client/index.md) represents a created instance from the admin client.
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ A `Layer group` can also be part of the `children`-array. In this case another h

:::caution

The layerId has to be corresponding to the *[Subject](../admin-client/02-subject.md)s*-layerId!
The layerId has to be corresponding to the *[Subject](../2_admin-client/02-subject.md)s*-layerId!

:::

Expand All @@ -241,14 +241,14 @@ This is a full list of parameters that can be edited:
|`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|
|`layerId`|LayerId corresponding to the LayerId of the [Subject](../2_admin-client/02-subject.md)|1|true|

<!-- You can find an illustrative example of how to change the name or initial visibility of a layer in the following video:
<ReactPlayer controls width='max' height='max' url='/shogun-docs/videos/admin-client-layertree.mp4' /> -->

## 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.
Within the layer configuration window, predefined layer settings from the [Subjects](../2_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:
```
Expand Down Expand Up @@ -278,20 +278,20 @@ 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)|
|`layerId`|LayerId corresponding to the LayerId of the [Subject](../2_admin-client/02-subject.md)|1|true|
|`clientConfig -> hoverable`|see [Client Configuration](../2_admin-client/02-subject.md)|
|`clientConfig -> maxResolution`|see [Client Configuration](../2_admin-client/02-subject.md)|
|`clientConfig -> minResolution`|see [Client Configuration](../2_admin-client/02-subject.md)|
|`clientConfig -> opacity`|see [Client Configuration](../2_admin-client/02-subject.md)|
|`clientConfig -> propertyConfig`|see [Client Configuration](../2_admin-client/02-subject.md)|
|`clientConfig -> searchable`|see [Client Configuration](../2_admin-client/02-subject.md)|
|`clientConfig -> searchConfig`|see [Client Configuration](../2_admin-client/02-subject.md)|
|`sourceConfig -> requestParams`|see [Source Configuration](../2_admin-client/02-subject.md)|
|`sourceConfig -> resolutions`|see [Source Configuration](../2_admin-client/02-subject.md)|
|`sourceConfig -> tileOrigin`|see [Source Configuration](../2_admin-client/02-subject.md)|
|`sourceConfig -> tileSize`|see [Source Configuration](../2_admin-client/02-subject.md)|
|`sourceConfig -> url`|see [Source Configuration](../2_admin-client/02-subject.md)|
|`sourceConfig -> useBearerToken`|see [Source Configuration](../2_admin-client/02-subject.md)|

## Configure Tools

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions docs/workflows/index.md → docs/4_workflows/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ sidebar_label: Workflows
</div>
</details>

More detailed information about the attributes can be found in the [admin-client documentation](../admin-client/02-subject.md).
More detailed information about the attributes can be found in the [admin-client documentation](../2_admin-client/02-subject.md).

6. Use the following JSON-script for the *Layertree*-configuration:

Expand Down Expand Up @@ -331,7 +331,7 @@ The layerId has to be corresponding to the *Subjects*-layerId!

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:
2. Use the [Share](../3_gis-client/06-share.md) tool within your toolbox to share your customized application:

![share](../../static/img/share.png)

Expand All @@ -355,7 +355,7 @@ As long as the layers are available under their URL or within the internal GeoSe

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)
2. Switch to the content [Subjects](../2_admin-client/02-subject.md)

3. Click the ![upload-subject](../../static/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.

Expand All @@ -365,8 +365,8 @@ 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
4. A new [Subject](../2_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
5. Switch to the content [Instance](../2_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**
File renamed without changes.
Loading