From 646ccb0504335a168ac2663329b974d2f1f09415 Mon Sep 17 00:00:00 2001 From: Dominik George <dominik.george@teckids.org> Date: Wed, 12 Jan 2022 17:13:27 +0100 Subject: [PATCH] [Docs] Add hints on how to edit substitutions --- docs/admin/10_managing_data.rst | 6 +++++- docs/user/15_manage_substitutions.rst | 25 +++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 docs/user/15_manage_substitutions.rst diff --git a/docs/admin/10_managing_data.rst b/docs/admin/10_managing_data.rst index e3d1e03a..99681662 100644 --- a/docs/admin/10_managing_data.rst +++ b/docs/admin/10_managing_data.rst @@ -2,8 +2,12 @@ Managing timetable and substitution data ======================================== Currently, CHronos does not provide an interface for -interactively managing timetable and subsitution data. +interactively managing timetable data. Instead, data is imported from an external source. The official distribution handbook contains documentation about the existing integration apps. + +While there is basic support for editing substitutions, the +interface should not be used when substitution data is +imported from an external source. diff --git a/docs/user/15_manage_substitutions.rst b/docs/user/15_manage_substitutions.rst new file mode 100644 index 00000000..ee557948 --- /dev/null +++ b/docs/user/15_manage_substitutions.rst @@ -0,0 +1,25 @@ +Managing substitutions +====================== + +AlekSIS has basic support for managing substitutions and cancellations. + +In the mnue under `Timetable → Daily lessons`, a list of all lessons taking +place on a day can be found. + +.. image:: ../_static/daily_lessons.png + :width: 600 + :alt: Daily lessons + +The list allows editing a substitution for each lesson. + +.. image:: ../_static/substitution_edit.png + :width: 600 + :alt: Edit a substitution + +When editing a substitution, the week, date, and lesson is pre-filled. +The fields for `teacher`, `room`, and `subject` allow replacing +the respective information for the selected lesson. + +It should be noted that support for editing substitutions is currently +very basic, and the feature should not be used when substitution data +is imported from an external source. -- GitLab