From c512b5b3eebb47cf6bdc77579d840a09e73af14f Mon Sep 17 00:00:00 2001 From: Mo8it Date: Tue, 28 Jun 2022 03:53:46 +0200 Subject: [PATCH] Update assistant docs --- advlabdb/templates/docs/assistant.html | 162 +++++++++++++++---------- 1 file changed, 95 insertions(+), 67 deletions(-) diff --git a/advlabdb/templates/docs/assistant.html b/advlabdb/templates/docs/assistant.html index 68403bf..f97894d 100644 --- a/advlabdb/templates/docs/assistant.html +++ b/advlabdb/templates/docs/assistant.html @@ -1,70 +1,98 @@ -
-

Welcome

-
-
-

Welcome to this website, AdvLabDB, where you will be able to manage your lab assistance. Please, read this documentation to familiarize yourself with this website.

+ + +

Welcome

+

+ Welcome to this website, AdvLabDB, where you will be able to manage your lab + assistance. Please, read this documentation to familiarize + yourself with this website. +

+ +

Menu items

+

+ In this section, you will find explanations to each menu item on the upper + navigation bar. +

+ +

Home

+

+ This is your home page. Here, you currently only find the number of + missing final experiment marks for the experiments that you + are assigned to. At the latest at the end of the semester, this number should + be 0. A number higher than 0 means that some oral and/or protocol marks are + missing. The final experiment mark is calculated automatically after the oral + and protocol marks of an experiment are set. +

+ +

Group Experiment

+

+ This is the most important menu item. Here, you see all pairs of experiments + and groups that you are responsible for. If a value in the column + Experiment Marks Missing is Yes, then + you did not set all the experiment marks for the pair in the related row. If + you click on the edit button on the left side of a row, then you will get a + form. +

+

+ In the form, you can edit the date of an appointment by clicking on + it. You should do so after writing with the students doing the experiment + corresponding to the appointment. The initial date you find before editing it + is only a suggestion in the week where the appointment should take place. + Please take take into account if the appointment should be in the semester + break. +

+

+ Below the appointments in the form, you can set the students' oral and + protocol marks. Students in a group have separate marks. The oral mark has to + be set after the oral exam. The protocol mark has to be set after correcting + the group's protocol. +

+ -
-
-

Menu items

-
-
-

In this section, you will find explanations to each menu item on the upper navigation bar.

-
-
-

Home

-
-

This is your home page. Here, you currently only find the number of missing final experiment marks for the experiments that you are assigned to. At the latest at the end of the semester, this number should be 0. A number higher than 0 means that some oral and/or protocol marks are missing. The final experiment mark is calculated automatically after the oral and protocol marks of an experiment are set.

-
-
-
-

Appointment

-
-

Here, you will find all the appointments you have for the experiments you are assigned to. You can only edit the Date of an appointment. You should do so after writing with the students doing the experiment corresponding to the appointment. The initial date you find before editing it is only a suggestion in the week where the appointment should take place. If Special is checked, then the date should be chosen in the semester break.

-
-
-

To edit the date of an appointment, click on the date (underlined fields are editable). Then, choose the new date and click on the check mark.

-
-
-
-

Experiment Mark

-
-

Here, you find the experiment marks that you have to fill for every student in every group. Students in a group have separate marks. The oral mark has to be set after the oral exam. The protocol mark has to be set after correcting the group’s protocol. The final experiment mark is calculated automatically after the oral and protocol marks are set.

-
-
-

IMPORTANT: Oral and protocol marks are between 0 and 15!

-
-
-

To edit an oral or protocol mark, click on the pen icon in a row. Then, enter the mark(s) and click on Save.

-
-
-

You can use the search bar to find a student by a part of the name or an email.

-
-
-
-

User

-
-

Here, you find a table with only one entry which is you as a user. Make sure that the fields Phone Number, Mobile Phone Number, Building and Room are filled and up to date, especially if you are a new assistant. To edit these fields, click on the pen icon at the left of the single entry in the table. After editing, click on Save.

-
-
-

You can generate a new random password by clicking on the pen icon, checking the corresponding checkbox and then clicking on Save. You will be then logged out. Your new password is displayed above the login fields. Make sure that you save the password in a safe place. Using a free open source password manager like Bitwarden or KeepassXC is recommended.

-
-
-
-

Docs

-
+

+ After editing appointment date(s) or experiment marks, click on the + Save button to save the changes. +

+

+ The changes are lost if you don't click on Save. Therefore, if you + want to discard the changes, just click on the back button of your browser. +

+ +

User

+

+ Here, you find a table with only one row which is you as a user. Make sure + that the fields Phone Number, Mobile Phone Number, + Building and Room are filled and up to date, especially if + you are a new assistant. To edit these fields, click on the pen icon at the + left of the single entry in the table. After editing, click on Save. +

+

+ You can generate a new random password by clicking on the pen icon, checking + the corresponding checkbox and then clicking on + Save. You will be then logged out. Your new password is displayed + above the login fields. Make sure that you save the password in a safe place. + Using a free open source password manager like + Bitwarden + or + KeepassXC + is recommended. +

+ +

Docs

This is a link which leads you to this page.

-
-
-
-

Active semester

-
-

An active semester is the semester you are working in. All shown experiment marks and appointments are in your active semester. By default as a new assistant, your active semester should be the latest semester.

-
-
-

If you see a warning that you are in an old semester, click on Active semester and choose the latest semester. You should only work in an old semester if there are still experiment marks to be set in the old semester.

-
-
-
-
\ No newline at end of file + +

Active semester

+

+ An active semester is the semester you are working in. All shown experiment + marks and appointments are in your active semester. By default as a new + assistant, your active semester should be the latest semester. +

+

+ If you see a warning that you are in an old semester, click on + Active semester and choose the latest semester. You should only work + in an old semester if there are still experiment marks to be set in the old + semester. +