summaryrefslogtreecommitdiffstats
path: root/documentation/webapp
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/webapp
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/webapp')
-rw-r--r--documentation/webapp/README.md21
1 files changed, 9 insertions, 12 deletions
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