mirror of
https://codeberg.org/Mo8it/AdvLabDB.git
synced 2024-09-19 18:31:16 +00:00
Update assistant docs
This commit is contained in:
parent
38d61afb7f
commit
c512b5b3ee
1 changed files with 95 additions and 67 deletions
|
|
@ -1,70 +1,98 @@
|
|||
<div class="sect1">
|
||||
<h2 id="_welcome">Welcome</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph">
|
||||
<p>Welcome to this website, AdvLabDB, where you will be able to manage your lab assistance. Please, <strong>read this documentation</strong> to familiarize yourself with this website.</p>
|
||||
<div class="alert alert-warning" role="alert">
|
||||
Changes have been done to the web interface. Read the section
|
||||
<a href="#_group_experiment">Group Experiment</a> for more information.
|
||||
</div>
|
||||
|
||||
<h2>Welcome</h2>
|
||||
<p>
|
||||
Welcome to this website, AdvLabDB, where you will be able to manage your lab
|
||||
assistance. Please, <strong>read this documentation</strong> to familiarize
|
||||
yourself with this website.
|
||||
</p>
|
||||
|
||||
<h2>Menu items</h2>
|
||||
<p>
|
||||
In this section, you will find explanations to each menu item on the upper
|
||||
navigation bar.
|
||||
</p>
|
||||
|
||||
<h3>Home</h3>
|
||||
<p>
|
||||
This is your home page. Here, you currently only find the number of
|
||||
<strong>missing</strong> 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.
|
||||
</p>
|
||||
|
||||
<h3 id="_group_experiment">Group Experiment</h3>
|
||||
<p>
|
||||
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
|
||||
<em>Experiment Marks Missing</em> is <span style="color: red">Yes</span>, 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.
|
||||
</p>
|
||||
<p>
|
||||
In the form, you can edit the <em>date</em> 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.
|
||||
</p>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<div class="alert alert-warning" role="alert">
|
||||
Oral and protocol marks are between 0 and 15!
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect1">
|
||||
<h2 id="_menu_items">Menu items</h2>
|
||||
<div class="sectionbody">
|
||||
<div class="paragraph">
|
||||
<p>In this section, you will find explanations to each menu item on the upper navigation bar.</p>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_home">Home</h3>
|
||||
<div class="paragraph">
|
||||
<p>This is your home page. Here, you currently only find the number of <strong>missing</strong> 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.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_appointment">Appointment</h3>
|
||||
<div class="paragraph">
|
||||
<p>Here, you will find all the appointments you have for the experiments you are assigned to. You can only edit the <em>Date</em> 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 <em>Special</em> is checked, then the date should be chosen in the semester break.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>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.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_experiment_mark">Experiment Mark</h3>
|
||||
<div class="paragraph">
|
||||
<p>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.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p><strong>IMPORTANT:</strong> <mark>Oral and protocol marks are between 0 and 15!</mark></p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>To edit an oral or protocol mark, click on the pen icon in a row. Then, enter the mark(s) and click on <em>Save</em>.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>You can use the search bar to find a student by a part of the name or an email.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_user">User</h3>
|
||||
<div class="paragraph">
|
||||
<p>Here, you find a table with only one entry which is you as a user. Make sure that the fields <em>Phone Number</em>, <em>Mobile Phone Number</em>, <em>Building</em> and <em>Room</em> 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 <em>Save</em>.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>You can generate a new random password by clicking on the pen icon, checking the corresponding checkbox and then clicking on <em>Save</em>. 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 <a href="https://bitwarden.com/" target="_blank" rel="noopener">Bitwarden</a> or <a href="https://keepassxc.org/" target="_blank" rel="noopener">KeepassXC</a> is recommended.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_docs">Docs</h3>
|
||||
<div class="paragraph">
|
||||
<p>
|
||||
After editing appointment date(s) or experiment marks, click on the
|
||||
<em>Save</em> button to save the changes.
|
||||
</p>
|
||||
<p>
|
||||
The changes are lost if you don't click on <em>Save</em>. Therefore, if you
|
||||
want to discard the changes, just click on the back button of your browser.
|
||||
</p>
|
||||
|
||||
<h3>User</h3>
|
||||
<p>
|
||||
Here, you find a table with only one row which is you as a user. Make sure
|
||||
that the fields <em>Phone Number</em>, <em>Mobile Phone Number</em>,
|
||||
<em>Building</em> and <em>Room</em> 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 <em>Save</em>.
|
||||
</p>
|
||||
<p>
|
||||
You can generate a new random password by clicking on the pen icon, checking
|
||||
the corresponding checkbox and then clicking on
|
||||
<em>Save</em>. 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
|
||||
<a href="https://bitwarden.com/" target="_blank" rel="noopener">Bitwarden</a>
|
||||
or
|
||||
<a href="https://keepassxc.org/" target="_blank" rel="noopener">KeepassXC</a>
|
||||
is recommended.
|
||||
</p>
|
||||
|
||||
<h3>Docs</h3>
|
||||
<p>This is a link which leads you to this page.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sect2">
|
||||
<h3 id="_active_semester">Active semester</h3>
|
||||
<div class="paragraph">
|
||||
<p>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.</p>
|
||||
</div>
|
||||
<div class="paragraph">
|
||||
<p>If you see a warning that you are in an old semester, click on <em>Active semester</em> 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.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<h3>Active semester</h3>
|
||||
<p>
|
||||
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.
|
||||
</p>
|
||||
<p>
|
||||
If you see a warning that you are in an old semester, click on
|
||||
<em>Active semester</em> 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.
|
||||
</p>
|
||||
|
|
|
|||
Loading…
Reference in a new issue