summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorJannik Schönartz2019-05-19 17:00:29 +0200
committerJannik Schönartz2019-05-19 17:00:29 +0200
commit706b9efdd1b4bcfd12e1088b8887c1e8a37030d3 (patch)
treec10e9052ac5bfb1c2673eed8fd30e8f2762793c9 /documentation
parent[documentation] Add FAQ registration and basic webapp docu stuff (diff)
downloadbas-706b9efdd1b4bcfd12e1088b8887c1e8a37030d3.tar.gz
bas-706b9efdd1b4bcfd12e1088b8887c1e8a37030d3.tar.xz
bas-706b9efdd1b4bcfd12e1088b8887c1e8a37030d3.zip
[documentation] Some corrections + image border dark / light theme image.
Diffstat (limited to 'documentation')
-rw-r--r--documentation/.vuepress/override.styl5
-rw-r--r--documentation/.vuepress/public/img/home.pngbin231021 -> 245967 bytes
-rw-r--r--documentation/.vuepress/public/img/home_de.pngbin236116 -> 252773 bytes
-rw-r--r--documentation/.vuepress/public/img/user_menu.pngbin25143 -> 0 bytes
-rw-r--r--documentation/de/webapp/README.md21
-rw-r--r--documentation/webapp/README.md21
6 files changed, 22 insertions, 25 deletions
diff --git a/documentation/.vuepress/override.styl b/documentation/.vuepress/override.styl
index d807f5d..dfebc6a 100644
--- a/documentation/.vuepress/override.styl
+++ b/documentation/.vuepress/override.styl
@@ -106,4 +106,7 @@ blockquote
background-color: red
display: inline-flex
align-items: center
- justify-content: center \ No newline at end of file
+ justify-content: center
+
+.image-border
+ border: 1px solid black
diff --git a/documentation/.vuepress/public/img/home.png b/documentation/.vuepress/public/img/home.png
index 812f516..53ec688 100644
--- a/documentation/.vuepress/public/img/home.png
+++ b/documentation/.vuepress/public/img/home.png
Binary files differ
diff --git a/documentation/.vuepress/public/img/home_de.png b/documentation/.vuepress/public/img/home_de.png
index a0700c3..e09db1f 100644
--- a/documentation/.vuepress/public/img/home_de.png
+++ b/documentation/.vuepress/public/img/home_de.png
Binary files differ
diff --git a/documentation/.vuepress/public/img/user_menu.png b/documentation/.vuepress/public/img/user_menu.png
deleted file mode 100644
index 3eec088..0000000
--- a/documentation/.vuepress/public/img/user_menu.png
+++ /dev/null
Binary files differ
diff --git a/documentation/de/webapp/README.md b/documentation/de/webapp/README.md
index e460e8c..bff4072 100644
--- a/documentation/de/webapp/README.md
+++ b/documentation/de/webapp/README.md
@@ -1,5 +1,5 @@
# Webapplikation
-<a :href="$withBase('/img/dark_light_theme.png')" target="_blank"><img :src="$withBase('/img/dark_light_theme.png')" alt="BAS Dark and Light Theme"></a>
+<a :href="$withBase('/img/dark_light_theme.png')" target="_blank"><img :src="$withBase('/img/dark_light_theme.png')" alt="BAS Dark and Light Theme" class="image-border"></a>
Die Webapplikation ist das Frontend des BAS. Es benutzt dieselben API-Calls, die einem Benutzer zur Verfügung stehen, sodass alles, was im Frontend passiert auch über die API gemacht werden kann.
@@ -9,30 +9,27 @@ Auf der linken Seite ist das Sidepanel <span class="tutorial-label">1</span>, we
Das Sidepanel kann mit <span class="tutorial-label">2</span> geöffnet und geschlossen werden.
Das Verhalten des Sidepanels kann in den [Settings](/webapp/README.md#settings) Konfiguriert werden.
-Mit <span class="tutorial-label">3</span> kann das Aussehen der Webapplikation zwischen einem hellen und einem dunklen Design gewechselt werden.
-<span class="tutorial-label">4</span> öffnet das [Notifications](/webapp/README.md#notification) Menü. Der Button hat zusätzlich einen Zähler für ungelesene Benachrichtigungen in der unteren rechten ecke.
-Mit <span class="tutorial-label">5</span> kann ein Menü ausgeklappt werden, mit dem man zu den [Benutzereinstellungen](/webapp/README.md#user-account-settings) und [Einstellungen](/webapp/README.md#settings) navigieren oder sich Ausloggen kann.
-
-<a :href="$withBase('/img/user_menu.png')" target="_blank"><img :src="$withBase('/img/user_menu.png')" alt="BAS Home"></a>
-
+> <span class="tutorial-label">3</span> kann das Aussehen der Webapplikation zwischen einem hellen und einem dunklen Design gewechselt werden.\
+> <span class="tutorial-label">4</span> öffnet das [Notifications](/webapp/README.md#notification) Menü. Der Button hat zusätzlich einen Zähler für ungelesene Benachrichtigungen in der unteren rechten ecke.\
+> <span class="tutorial-label">5</span> kann ein Menü ausgeklappt werden, mit dem man zu den [Benutzereinstellungen](/webapp/README.md#user-account-settings) und [Einstellungen](/webapp/README.md#settings) navigieren oder sich Ausloggen kann.
## Benutzeraccount
Im Benutzeraccount Modul, kann der Benutzer einige seiner Informationen ändern.
-<a :href="$withBase('/img/account.png')" target="_blank"><img :src="$withBase('/img/account.png')" alt="BAS Account"></a>
+<a :href="$withBase('/img/account_de.png')" target="_blank"><img :src="$withBase('/img/account_de.png')" alt="BAS Account"></a>
-Mit dem Bearbeitungsbutton <span class="tutorial-label">1</span> kann der Benutzer seinen ```NAMEN``` und seine ```E-MAIL``` ändern.
+Mit dem ```BEARBEITEN```-Button <span class="tutorial-label">1</span> kann der Benutzer seinen ```NAMEN``` und seine ```E-MAIL``` ändern.
In den Accounteinstellungen ist es nicht möglich seinen ```BENUTZERNAMEN``` zu ändern.
::: tip
Der ```BENUTZERNAME``` kann nur im [Benutzermanagement](/webapp/modules.md#user-management) geändert werden. Dafür benötigt man die ```EDIT```-Rechte.
:::
-Das ```PASSWORT``` kann mit <span class="tutorial-label">2</span> geändert werden. Das Passwort muss aus mindestens ```>= 8 Zeichen``` bestehen.
+Das ```PASSWORT``` kann mit dem ```BEARBEITEN```-Button <span class="tutorial-label">2</span> geändert werden. Das Passwort muss aus mindestens ```>= 8 Zeichen``` bestehen.
-Mit <span class="tutorial-label">3</span> kann der Benutzer seinen Account endgültig Löschen.
+Mit dem ```LÖSCHEN```-Button <span class="tutorial-label">3</span> kann der Benutzer seinen Account endgültig Löschen.
::: danger
-Das Löschen des Accounts <span class="tutorial-label">3</span> kann **NICHT** rückgängig gemacht werden.
+Das Löschen des Accounts kann **NICHT** rückgängig gemacht werden.
:::
## Einstellungen
diff --git a/documentation/webapp/README.md b/documentation/webapp/README.md
index 17d06cc..5cc74aa 100644
--- a/documentation/webapp/README.md
+++ b/documentation/webapp/README.md
@@ -1,6 +1,6 @@
# Webapplication
-<a :href="$withBase('/img/dark_light_theme.png')" target="_blank"><img :src="$withBase('/img/dark_light_theme.png')" alt="BAS Dark and Light Theme"></a>
+<a :href="$withBase('/img/dark_light_theme.png')" target="_blank"><img :src="$withBase('/img/dark_light_theme.png')" alt="BAS Dark and Light Theme" class="image-border"></a>
The webapplication is the frontend for the BAS. It uses the same API calls, so everything which can be done in the frontend can also be done with the API.
@@ -9,30 +9,27 @@ The webapplication is the frontend for the BAS. It uses the same API calls, so e
On the left side there is a sidepanel <span class="tutorial-label">1</span> with all the modules inside.
The sidepanel can be opened and closed with <span class="tutorial-label">2</span>.
There are diffent appearances of the sidepanel which can be configured in the [Settings](/webapp/README.md#settings).
-<span class="tutorial-label">3</span> changes the style of the webapplication between a light and a dark theme.
-<span class="tutorial-label">4</span> opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications.
-<span class="tutorial-label">5</span> opens a small menu where you can go to the [User Settings](/webapp/README.md#user-account-settings), the [Settings](/webapp/README.md#settings) or Logout of the webapplication.
-
-<a :href="$withBase('/img/user_menu.png')" target="_blank"><img :src="$withBase('/img/user_menu.png')" alt="BAS Home"></a>
-
+> <span class="tutorial-label">3</span> changes the style of the webapplication between a light and a dark theme.\
+> <span class="tutorial-label">4</span> opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications.\
+> <span class="tutorial-label">5</span> opens a small menu where you can go to the [User Settings](/webapp/README.md#user-account-settings), the [Settings](/webapp/README.md#settings) or Logout of the webapplication.
## User Account
In the user account module the user is able to change some of his informations.
<a :href="$withBase('/img/account.png')" target="_blank"><img :src="$withBase('/img/account.png')" alt="BAS Account"></a>
-With the edit Button <span class="tutorial-label">1</span> the user is able to change his ```NAME``` and his ```E-MAIL```.
+With the ```EDIT``` button <span class="tutorial-label">1</span> the user is able to change his ```NAME``` and his ```E-MAIL```.
The change of the ```USERNAME``` is not possible in the account settings.
::: tip
-The ```USERNAME``` can only be changed in the [User Management](/webapp/modules.md#user-management) module where the ```EDIT``` permission is required.
+The ```USERNAME``` can be changed in the [User Management](/webapp/modules.md#user-management) module where the ```EDIT``` permission is required.
:::
-The ```PASSWORD``` can be changed with pressing the <span class="tutorial-label">2</span> button. The requirements for a password are ```>= 8 characters```.
+The ```PASSWORD``` can be changed with pressing the ```EDIT``` button <span class="tutorial-label">2</span>. The requirements for a password are ```>= 8 characters```.
-With <span class="tutorial-label">3</span> the user can delete his account.
+With the ```DELETE``` button <span class="tutorial-label">3</span> the user can delete his account.
::: danger
-Deleting your account with <span class="tutorial-label">3</span> can **NOT** be undone.
+Deleting your account can **NOT** be undone.
:::
## Settings