diff --git a/docs/_static/assign_group_role.png b/docs/_static/assign_group_role.png new file mode 100644 index 0000000000000000000000000000000000000000..ac77c11efecdfa5a76ff6e19811ecfb5343a0bfc Binary files /dev/null and b/docs/_static/assign_group_role.png differ diff --git a/docs/_static/create_excuse_type.png b/docs/_static/create_excuse_type.png new file mode 100644 index 0000000000000000000000000000000000000000..f7a3e8be3e250b602984a7809838131fa22b1299 Binary files /dev/null and b/docs/_static/create_excuse_type.png differ diff --git a/docs/_static/create_extra_mark.png b/docs/_static/create_extra_mark.png new file mode 100644 index 0000000000000000000000000000000000000000..ce0a37ae9edddf1877fb807d8bfcbb6c6c358200 Binary files /dev/null and b/docs/_static/create_extra_mark.png differ diff --git a/docs/_static/edit_group_role.png b/docs/_static/edit_group_role.png new file mode 100644 index 0000000000000000000000000000000000000000..f63c77fb1a7b09100b9253ff74776155249e7d46 Binary files /dev/null and b/docs/_static/edit_group_role.png differ diff --git a/docs/_static/excuse_types.png b/docs/_static/excuse_types.png new file mode 100644 index 0000000000000000000000000000000000000000..08180e8fc4d50c24c0be07bc2cd39bc80b8e344c Binary files /dev/null and b/docs/_static/excuse_types.png differ diff --git a/docs/_static/extra_marks.png b/docs/_static/extra_marks.png new file mode 100644 index 0000000000000000000000000000000000000000..8696b594b122968a490448adcad4edfd75c2a6ab Binary files /dev/null and b/docs/_static/extra_marks.png differ diff --git a/docs/_static/group_roles.png b/docs/_static/group_roles.png new file mode 100644 index 0000000000000000000000000000000000000000..2181f711cf31458cf82bc28e21961c01f9b44380 Binary files /dev/null and b/docs/_static/group_roles.png differ diff --git a/docs/_static/lesson_documentation.png b/docs/_static/lesson_documentation.png new file mode 100644 index 0000000000000000000000000000000000000000..e4904c0a5db7db39270a62ade9ccf6c06deb04f3 Binary files /dev/null and b/docs/_static/lesson_documentation.png differ diff --git a/docs/_static/lesson_personal_notes.png b/docs/_static/lesson_personal_notes.png new file mode 100644 index 0000000000000000000000000000000000000000..1ac6bd861cb86630624d910b6011cb884fd34333 Binary files /dev/null and b/docs/_static/lesson_personal_notes.png differ diff --git a/docs/_static/lesson_version_history.png b/docs/_static/lesson_version_history.png new file mode 100644 index 0000000000000000000000000000000000000000..4c21de59eb712128f1ddcf3c82dd60cbf4a539b7 Binary files /dev/null and b/docs/_static/lesson_version_history.png differ diff --git a/docs/_static/my_groups.png b/docs/_static/my_groups.png new file mode 100644 index 0000000000000000000000000000000000000000..7ab0b6b007222d23d79ccf475f4a157e2e35dba7 Binary files /dev/null and b/docs/_static/my_groups.png differ diff --git a/docs/_static/my_students.png b/docs/_static/my_students.png new file mode 100644 index 0000000000000000000000000000000000000000..895b8198e3e7144e683fd70ba4656bbd950b4e47 Binary files /dev/null and b/docs/_static/my_students.png differ diff --git a/docs/_static/overview_lessons.png b/docs/_static/overview_lessons.png new file mode 100644 index 0000000000000000000000000000000000000000..f4a48c5c03b29c33321cd4104144fd3d8e96b0df Binary files /dev/null and b/docs/_static/overview_lessons.png differ diff --git a/docs/_static/overview_person.png b/docs/_static/overview_person.png new file mode 100644 index 0000000000000000000000000000000000000000..ca351866c3451610baf74536e9827f66919cc4a7 Binary files /dev/null and b/docs/_static/overview_person.png differ diff --git a/docs/_static/register_absence.png b/docs/_static/register_absence.png new file mode 100644 index 0000000000000000000000000000000000000000..c7e886066911d1c51681df9645c023e9ff4336b6 Binary files /dev/null and b/docs/_static/register_absence.png differ diff --git a/docs/_static/register_absence_confirm.png b/docs/_static/register_absence_confirm.png new file mode 100644 index 0000000000000000000000000000000000000000..f0085121364c2ab5a2dc5dc0b908fc1b06285fca Binary files /dev/null and b/docs/_static/register_absence_confirm.png differ diff --git a/docs/_static/students_list.png b/docs/_static/students_list.png new file mode 100644 index 0000000000000000000000000000000000000000..737deca414eff7a2f686b8e844c20e62a2406a43 Binary files /dev/null and b/docs/_static/students_list.png differ diff --git a/docs/_static/week_view.png b/docs/_static/week_view.png new file mode 100644 index 0000000000000000000000000000000000000000..59cee6ed16bb8ed8a12e6ba3225989613d4f0a18 Binary files /dev/null and b/docs/_static/week_view.png differ diff --git a/docs/_static/week_view_personal_notes.png b/docs/_static/week_view_personal_notes.png new file mode 100644 index 0000000000000000000000000000000000000000..564472ffca8fcc422692396dddbccc32c9b7ec85 Binary files /dev/null and b/docs/_static/week_view_personal_notes.png differ diff --git a/docs/admin/30_configure.rst b/docs/admin/30_configure.rst index ecc7ede675257f547c18e59e86c88c12e93bd456..22b8401d6c27c569d7381b17bf9772cb78ced504 100644 --- a/docs/admin/30_configure.rst +++ b/docs/admin/30_configure.rst @@ -11,6 +11,14 @@ This can be useful if you only want to count certain absences. For example, if a student is busy at a school event and misses lessons, this may not be counted as a normal absence. +.. image:: ../_static/excuse_types.png + :width: 100% + :alt: List with defined excuse types + +.. image:: ../_static/create_excuse_type.png + :width: 100% + :alt: Form for creating new excuse types + Extra marks ----------- @@ -18,8 +26,24 @@ Some remarks are repeated over and over again, such as 'Forgot homework'. In order not to have to write this again and again in the remark field, additional marks can be set, which then only have to be clicked on in the class register. +.. image:: ../_static/extra_marks.png + :width: 100% + :alt: List with defined extra marks + +.. image:: ../_static/create_extra_mark.png + :width: 100% + :alt: Form for creating new extra marks Group roles ----------- -To manage additional rights to the data in the class register, group roles can be defined here. \ No newline at end of file +To track special roles in groups in the class register, group roles +like class representatives or ventilation services can be defined here. + +.. image:: ../_static/group_roles.png + :width: 100% + :alt: Overview about group roles + +.. image:: ../_static/edit_group_role.png + :width: 100% + :alt: Form for managing a group role \ No newline at end of file diff --git a/docs/user/10_overview.rst b/docs/user/10_overview.rst index 58a08cd2caf3a25fa45f2adc522a668dfecb104d..7eded1d9f2d938ab52c40cb99eb10c26c8655596 100644 --- a/docs/user/10_overview.rst +++ b/docs/user/10_overview.rst @@ -9,6 +9,14 @@ Clicking on a lesson takes you to the data for that lesson. Above the schedule, you can navigate to the previous or following week. It is also possible to filter the schedule according to certain groups or teachers. +.. image:: ../_static/week_view.png + :width: 100% + :alt: Week view + +.. image:: ../_static/week_view_personal_notes.png + :width: 100% + :alt: Personal notes tab in week view + My overview (as student) ------------------------ @@ -16,6 +24,10 @@ 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. +.. image:: ../_static/overview_person.png + :width: 100% + :alt: Statistics about one person + My overview (as teacher) ------------------------ @@ -26,6 +38,10 @@ A corresponding symbol in each line immediately shows whether entries are still missing for the lesson in question. 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 + My groups (for teachers) --------- @@ -34,12 +50,20 @@ you can on the one hand access the relevant student lists and the weekly view of the lessons of this group, and on the other hand you can print the course-specific class book. +.. image:: ../_static/my_groups.png + :width: 100% + :alt: List with all groups and their students + My students ----------- With this menu item, the teacher receives a list of all students from his/her lesson. From each entry, you can switch to a detailed view to add specific data. +.. image:: ../_static/my_students.png + :width: 100% + :alt: List with all students of a teacher + All lessons ----------- diff --git a/docs/user/20_lesson.rst b/docs/user/20_lesson.rst index f76eefbe7bdf90e71d66506828f32e791c2a443b..d165cb38ad8998a23fbf468ed27b6788858525ab 100644 --- a/docs/user/20_lesson.rst +++ b/docs/user/20_lesson.rst @@ -7,16 +7,27 @@ The lesson documentation can be called up in different ways: 2. **Via 'Weekly overview'**: This menu item shows all lessons of the current week. Individual lessons can be clicked on to access the lesson documentation. 3. **'My Overview'**: This menu item shows teachers a list of all hours worked in the last weeks. Individual lessons can be called up directly. -The lesson documentation consists of four main parts accessible via tabs: +The lesson documentation consists of four main parts accessible via tabs. +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 +.. 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 +.. image:: ../_static/lesson_personal_notes.png + :width: 100% + :alt: Personal notes in lesson overview + Tab 'Previous lesson' --------------------- @@ -29,4 +40,7 @@ This tab contains several special items not mentioned before: * **Changes**: Alsijil tracks all changes made to class register entries. This list shows a log of all these changes. -The data can be entered, changed and saved via the relevant forms. In addition, navigation to the previous or next lesson is possible. +.. image:: ../_static/lesson_version_history.png + :width: 100% + :alt: Change history of the lesson + diff --git a/docs/user/25_group_roles.rst b/docs/user/25_group_roles.rst index 8a951e0a2d16ff1badc7256d9caf54e535638584..415b4a23a50e9611787d2a95710f439b493ae581 100644 --- a/docs/user/25_group_roles.rst +++ b/docs/user/25_group_roles.rst @@ -1,4 +1,9 @@ +Assign Group Roles +================== -#### Assign 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. -This menu item enables the assignment of a previously defined group role to a specific person, e.g. for the evaluation of class book entries or access to the print function. +.. image:: ../_static/assign_group_role.png + :width: 100% + :alt: Form for assigning a group role to a person \ No newline at end of file diff --git a/docs/user/30_statistics.rst b/docs/user/30_statistics.rst deleted file mode 100644 index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..0000000000000000000000000000000000000000