From 706b9efdd1b4bcfd12e1088b8887c1e8a37030d3 Mon Sep 17 00:00:00 2001 From: Jannik Schönartz Date: Sun, 19 May 2019 15:00:29 +0000 Subject: [documentation] Some corrections + image border dark / light theme image. --- documentation/webapp/README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) (limited to 'documentation/webapp') 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 -BAS Dark and Light Theme +BAS Dark and Light Theme 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 1 with all the modules inside. The sidepanel can be opened and closed with 2. There are diffent appearances of the sidepanel which can be configured in the [Settings](/webapp/README.md#settings). -3 changes the style of the webapplication between a light and a dark theme. -4 opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications. -5 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. - -BAS Home - +> 3 changes the style of the webapplication between a light and a dark theme.\ +> 4 opens the [Notifications](/webapp/README.md#notification) menu. The button has a notification counter, if there are unseen notifications.\ +> 5 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. BAS Account -With the edit Button 1 the user is able to change his ```NAME``` and his ```E-MAIL```. +With the ```EDIT``` button 1 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 2 button. The requirements for a password are ```>= 8 characters```. +The ```PASSWORD``` can be changed with pressing the ```EDIT``` button 2. The requirements for a password are ```>= 8 characters```. -With 3 the user can delete his account. +With the ```DELETE``` button 3 the user can delete his account. ::: danger -Deleting your account with 3 can **NOT** be undone. +Deleting your account can **NOT** be undone. ::: ## Settings -- cgit v1.2.3-55-g7522