Skip to content
Snippets Groups Projects
Verified Commit c76e0223 authored by Nik | Klampfradler's avatar Nik | Klampfradler
Browse files

Finalise handbook for now

parent 75993ef3
No related branches found
No related tags found
1 merge request!263Add docs
Pipeline #53664 canceled
System-wide settings for the digital class register
===================================================
The behavior of the digital class register can be customised
The behaviour of the digital class register can be customised
under `Admin → Configuration → Class Register`. The section contains the
following preferences:
......
Digital class register with AlekSIS-App-Alsijil
===============================================
Digital class register
======================
.. toctree::
:glob:
......
Concept of Alsijil and overview about functionality
===================================================
Alsijil (Arabic for class register) is a privacy-compliant online class register solution.
It is not simply the digital equivalent of a paper class book although elements are adopted
AlekSIS provides a privacy-compliant online class register solution.
It is not simply the digital equivalent of a paper class book, although elements are adopted
for easier orientation and smoother transition for teachers. For example, there is a weekly
view of all lessons and a list of all the students in the class. Lesson content,
notes about the student and also remarks about the learning group can be entered.
......@@ -10,9 +10,9 @@ notes about the student and also remarks about the learning group can be entered
However, the application uses the possibilities and therefore the advantages of a digital application.
The student lists do not have to be filled in by the class teacher,
but are provided automatically by the system. The timetable is also already stored.
Documents for general instruction of the students can also be stored centrally for reference.
The numbers of absences and tardies are automatically summed up
and missing entries can be displayed at the touch of a button.
In addition, statistical evaluation, like counting absences, is done
automatically.
In an overview, Alsijil currently provides the following functionality:
......@@ -29,10 +29,9 @@ In an overview, Alsijil currently provides the following functionality:
+ Restriction to lessons with or without entry for lesson content
+ Restriction to certain groups
+ Restriction to certain lesson contents
- Only for teachers: Listing of pupils from their own lessons with totalled absences and lateness as well as other remarks
- Only for teachers with special rights: Listing of all lessons of a specific class in preparation for printing the class register
- Only for teachers: Listing of students from their own lessons with totalled absences and lateness as well as other remarks
- Only for teachers with special privileges: Listing of all lessons of a specific class in preparation for printing the class register
- For administrators only: Definition of types of excuses, e.g. for absences due to school-related reasons
- For administrators only: Determination of types of remark, e.g. HA for homework forgotten
- Only for administrators: Assignment of special group roles, e.g. for the evaluation of class book entries or access to the print function
- Only for administrators: Creating group roles
Basic data concepts
===================
Relation to Chronos
-------------------
Timetable data
--------------
The class register uses the data from the Chronos app. This means that timetables with
The class register uses the data from the timetable app. This means that timetables with
all current changes such as substitutions, events and exams can be found directly in the class book.
Even basic settings such as lesson times, holidays and public holidays do not have to be
entered separately in the class book, as they are managed centrally by Chronos.
entered separately in the class book, as they are managed centrally.
Concept of lesson documentations
--------------------------------
Lesson documentations
---------------------
Three input fields are provided for the lesson content:
......@@ -19,16 +19,16 @@ Three input fields are provided for the lesson content:
2. **Homework:** In this field, the teacher can enter the homework for the next lesson.
3. **Group note:** Here, there is space for notes that concern the whole learning group, e.g. instructions, dates, or similar.
Concept of personal notes
-------------------------
Personal notes
--------------
Under the tab 'Personal Notes', you will find a student list of the group. The following entries can be made there:
1. **Absent:** This field is not activated by default.
2. **Lateness in minutes**
1. **Absent:**
2. **Tardiness in minutes**
3. **Excused**
4. **Excuse type:** Several types can be set up for an excuse for absence, e.g. in case a student was absent due to a school event.
5. **Extra marks:** This item is also configurable. A selection field for missing homework or similar would be possible here.
6. **Remarks:**
With the appropriate configuration, the student can directly view the data concerning him or her.
\ No newline at end of file
With the appropriate configuration, students can view all personal notes concerning themselves.
......@@ -17,21 +17,25 @@ It is also possible to filter the schedule according to certain groups or teache
:width: 100%
:alt: Personal notes tab in week view
My overview (as student)
------------------------
My overview
-----------
Personal overview for students
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This menu item provides the student with an overview of the personal notes
such as tardies, absences and remarks that the teacher has entered in the class register.
This enables him/her to quickly check whether excuses still need to be submitted.
such as tardiness, absences and remarks that teachers hav entered in the class register.
This enables them to quickly check whether excuses still need to be submitted,
and to verify what notes have been made about them.
.. image:: ../_static/overview_person.png
:width: 100%
:alt: Statistics about one person
:alt: Overview for students
My overview (as teacher)
------------------------
Personal overview for teachers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
This view shows your own hours for the last four weeks.
For teachers, this view shows their own lessons for the last four weeks.
A filter can be used to adjust the list with regard to period,
missing entries, certain groups or certain lesson contents.
A corresponding symbol in each line immediately shows
......@@ -40,11 +44,13 @@ Individual lessons can be called up from the list to add or change entries.
.. image:: ../_static/overview_lessons.png
:width: 100%
:alt: Overview of lessons
:alt: Overview of lessons for teachers
My groups (for teachers)
My groups
---------
This menu item is only available for teachers.
With this quick access to your own learning groups,
you can on the one hand access the relevant student lists
and the weekly view of the lessons of this group,
......@@ -57,7 +63,7 @@ and on the other hand you can print the course-specific class book.
My students
-----------
With this menu item, the teacher receives a list of all students from his/her lesson.
With this menu item, teachers receive a list of all students from their lessons.
From each entry, you can switch to a detailed view to add specific data.
.. image:: ../_static/my_students.png
......@@ -68,7 +74,7 @@ All lessons
-----------
For the head teacher or the coordinators of certain grades,
this menu item gives them the possibility to see all lessons of a learning group in a list.
this menu item gives the possibility to see all lessons of a learning group in a list.
By means of a filter, the list can be specified to certain entries.
This makes it possible to call up all lessons with missing entries and
to send a request for completion of the data to the teachers concerned via a button.
......@@ -12,17 +12,31 @@ The data can be entered, changed and saved via the relevant forms.
In addition, navigation to the previous or next lesson is possible.
Tab Lesson Documentation
------------------------
with lesson topic, homework for the next lesson and notes for the learning group
Tab 'Lesson Documentation'
--------------------------
The lesson documentation is a strictly non-personal information about the contents
of the lesson. It contains the topic, describing what contents were taught, and an
optional homework, describing what tasks students got for the next lesson.
Everything entered here should be considered public knowledge.
.. warning::
Never add any personal information to the lesson documentation.
.. image:: ../_static/lesson_documentation.png
:width: 100%
:alt: Lesson documentation in lesson overview
Tab Personal Notes
------------------
with a list of pupils and the possibility to enter tardies, excuses and remarks about the pupil
Tab 'Personal Notes'
--------------------
Personal notes are specific to single students, and contain information about
absences, tardiness, any extra marks defined in the system, and a free text comment.
This information can never be viewed by other students. It is visible to any
teacher in the class by default, and might also be visible to the concerned
student.
.. image:: ../_static/lesson_personal_notes.png
:width: 100%
......@@ -31,7 +45,8 @@ with a list of pupils and the possibility to enter tardies, excuses and remarks
Tab 'Previous lesson'
---------------------
(if the lesson content of the lesson in question has been entered) with the date and subject of the previous lesson and a list of the pupils absent from that lesson.
This tab shows information about the previous lesson in the same group and subject
for reference.
Tab 'More'
----------
......@@ -43,4 +58,3 @@ This tab contains several special items not mentioned before:
.. image:: ../_static/lesson_version_history.png
:width: 100%
:alt: Change history of the lesson
Assign Group Roles
==================
Assigning group roles
=====================
This menu item enables the assignment of a previously defined group role to a specific person,
e.g. for ventilation services or class representatives.
.. image:: ../_static/assign_group_role.png
:width: 100%
:alt: Form for assigning a group role to a person
\ No newline at end of file
:alt: Form for assigning a group role to a person
......@@ -8,4 +8,4 @@ It contains a list of the lessons taught staggered according to timetable period
a collection of all the students' personal notes as well as all lesson contents.
An alternative path to printing a class register is via the weekly view.
There, the relevant group can be selected via the filter to print the class book.
\ No newline at end of file
There, the relevant group can be selected via the filter to print the class book.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment