diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000000000000000000000000000000000000..51285967a7d9722c5bdee4f6a81c154a56aa0846 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,19 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 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/00_index.rst b/docs/admin/00_index.rst new file mode 100644 index 0000000000000000000000000000000000000000..c5786831bae68eab1102891f1b03126ec1d4957c --- /dev/null +++ b/docs/admin/00_index.rst @@ -0,0 +1,7 @@ +Setting up a digital class register with AlekSIS-App-Alsijil +============================================================ + +.. toctree:: + :glob: + + * diff --git a/docs/admin/30_configure.rst b/docs/admin/30_configure.rst new file mode 100644 index 0000000000000000000000000000000000000000..22b8401d6c27c569d7381b17bf9772cb78ced504 --- /dev/null +++ b/docs/admin/30_configure.rst @@ -0,0 +1,49 @@ +Defining base data +================== + +With sufficient authorisation, two additional menu items appear in the class register menu. + +Excuse types +------------ + +Additional types of excuse for an absence can be created here. +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 +----------- + +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 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/admin/40_preferences.rst b/docs/admin/40_preferences.rst new file mode 100644 index 0000000000000000000000000000000000000000..b6e5ccf08856bea311776d34c4abe239f0679d81 --- /dev/null +++ b/docs/admin/40_preferences.rst @@ -0,0 +1,29 @@ +System-wide settings for the digital class register +=================================================== + +The behaviour of the digital class register can be customised +under `Admin → Configuration → Class Register`. The section contains the +following preferences: + +* **Block adding personal notes for cancelled lessons**: If this option is + activated, teachers will not be able to add personal notes for cancelled + lessons. +* **Allow users to view their own personal notes:** With this option, the school management + can control whether students should be able to view their own personal notes. +* **Allow primary group owners to register future absences for students in their groups**: + This allows owners of the student's primary group (e. g. the class) + to register future absences like doctor's appointments or family celebrations. +* **Allow original teachers to edit their lessons although they are substituted:** + In the case of substitute teaching, absent teachers can be given write-in privileges for the lesson. +* **Carry over data from first lesson period to the following lesson periods in lessons over multiple periods:** + For double (or even more adjacent) lessons, the lesson data from the first lesson period + can be automatically carried over to the following lessons. +* **Carry over personal notes to all following lesson periods on the same day:** + For double (or more adjacent) lessons, the personal notes from the first lesson period + can be automatically carried over to the following lessons. +* **Allow teachers to open lesson periods on the same day and not just at the beginning of the period:** + Teachers can open lessons earlier on the same day and not just at the beginning of the lesson. +* **Allow teachers to add data for lessons in holidays:** + It is possible to allow entering content for lessons during the holidays. +* **Allow group owners to assign group roles to the parents of the group's members:** + With this being activated, group roles like parent representatives can be managed by the class teacher. diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000000000000000000000000000000000000..9339a7085beb6e6fe86786bf476e7b5d01c0245f --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,207 @@ +# -*- coding: utf-8 -*- +# +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +import os +import sys + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import django + +sys.path.insert(0, os.path.abspath("..")) +os.environ["DJANGO_SETTINGS_MODULE"] = "aleksis.core.settings" +os.environ["LOCAL_SETTINGS_FILE"] = os.path.abspath(os.path.join("..", "local.cfg")) +django.setup() + +# -- Project information ----------------------------------------------------- + +project = "AlekSIS-App-Alsijil" +copyright = "2019-2022 The AlekSIS team" +author = "The AlekSIS Team" + +# The short X.Y version +version = "2.0" +# The full version, including alpha/beta/rc tags +release = "2.0rc8" + + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + "sphinx.ext.autodoc", + "sphinxcontrib_django", + "sphinx_autodoc_typehints", + "sphinx.ext.intersphinx", + "sphinx.ext.viewcode", +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ["_templates"] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = ".rst" + +# The master toctree document. +master_doc = "index" + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = None + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = "sphinx_material" + +# html_favicon = "../aleksis/core/static/img/aleksis-icon.png" +# html_logo = "../aleksis/core/static/img/aleksis-banner.svg" + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +html_theme_options = { + "repo_url": f"https://edugit.org/AlekSIS/official/{project}", + "repo_name": "EduGit", + "repo_type": "gitlab", + "theme_color": "#0d5eaf", + "color_primary": "#0d5eaf", + "color_accent": "#0d5eaf", + "globaltoc_depth": 2, + "globaltoc_collapse": False, +} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ["_static"] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +html_sidebars = { + "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"] +} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = f"{project}doc" + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, f"{project}.tex", f"{project} Documentation", author, "manual"), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [(master_doc, "aleksis", f"{project} Documentation", [author], 1)] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ( + master_doc, + project, + f"{project} Documentation", + author, + project, + "One line description of project.", + "Miscellaneous", + ), +] + + +# -- Options for Epub output ------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = project + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +# +# epub_identifier = '' + +# A unique identification for the text. +# +# epub_uid = '' + +# A list of files that should not be packed into the epub file. +epub_exclude_files = ["search.html"] + + +# -- Extension configuration ------------------------------------------------- + +# -- Options for intersphinx extension --------------------------------------- + +# Example configuration for intersphinx: refer to the Python standard library. +intersphinx_mapping = { + "https://docs.python.org/": None, + "https://docs.djangoproject.com/en/stable": "https://docs.djangoproject.com/en/stable/_objects", +} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..be6e93c3f650f9ea1faa2d7e0ed39e3889f05fec --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,24 @@ +.. AlekSIS documentation master file, created by + sphinx-quickstart on Thu Aug 15 10:49:03 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to AlekSIS-App-Alsijil's documentation! +=============================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + user/00_index + admin/00_index + dev/00_index + ref/00_index + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000000000000000000000000000000000000..27f573b87af11e2cbbd9f54eb1ee285a58550146 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/user/00_index.rst b/docs/user/00_index.rst new file mode 100644 index 0000000000000000000000000000000000000000..afa9d42c569858cb04a7513a0a7922a24b26467f --- /dev/null +++ b/docs/user/00_index.rst @@ -0,0 +1,7 @@ +Digital class register +====================== + +.. toctree:: + :glob: + + * diff --git a/docs/user/10_basic.rst b/docs/user/10_basic.rst new file mode 100644 index 0000000000000000000000000000000000000000..d51047195b6ed2e8e2684621975e9552c1020974 --- /dev/null +++ b/docs/user/10_basic.rst @@ -0,0 +1,37 @@ +Concept of Alsijil and overview about functionality +=================================================== + +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. + +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. + +In addition, statistical evaluation, like counting absences, is done +automatically. + +In an overview, Alsijil currently provides the following functionality: + +- Direct link to the lesson currently taking place +- Overview with all lessons of one week + + Navigation between lessons + + Filtering according to learning groups/courses and teachers +- List of learning groups + + List of students with current statistics (absences, lateness, etc.) + + printing of the group-specific class register +- "My overview" for pupils with an overview of "personal notes" such as omissions, lateness, remarks +- "My overview" for teachers with a list of their own lessons over the last four weeks and the following filtering options: + + Specifying the period + + Restriction to lessons with or without entry for lesson content + + Restriction to certain groups + + Restriction to certain lesson contents +- 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 diff --git a/docs/user/15_concepts.rst b/docs/user/15_concepts.rst new file mode 100644 index 0000000000000000000000000000000000000000..6fbcb74809358195239021f5b2230971f2e1536b --- /dev/null +++ b/docs/user/15_concepts.rst @@ -0,0 +1,34 @@ +Basic data concepts +=================== + +Timetable data +-------------- + +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. + +Lesson documentations +--------------------- + +Three input fields are provided for the lesson content: + +1. **Lesson topic:** The content of the lesson is to be noted here, if necessary with information on the material used. +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. + +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:** +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, students can view all personal notes concerning themselves. diff --git a/docs/user/20_overview.rst b/docs/user/20_overview.rst new file mode 100644 index 0000000000000000000000000000000000000000..fc550253a042c6f3fd43e64e73439b97e7e9c61e --- /dev/null +++ b/docs/user/20_overview.rst @@ -0,0 +1,80 @@ +Overviews about lessons and students +==================================== + +Week overview +------------- + +In the weekly overview, all lessons of the week for the respective user are displayed in a weekly schedule. +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 +----------- + +Personal overview for students +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +This menu item provides the student with an overview of the personal notes +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: Overview for students + +Personal overview for teachers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +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 +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 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, +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, 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 + :width: 100% + :alt: List with all students of a teacher + +All lessons +----------- + +For the head teacher or the coordinators of certain grades, +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. diff --git a/docs/user/21_lesson.rst b/docs/user/21_lesson.rst new file mode 100644 index 0000000000000000000000000000000000000000..6db6108bcf19442c42ea63e067846c58b2292186 --- /dev/null +++ b/docs/user/21_lesson.rst @@ -0,0 +1,74 @@ +Viewing and managing lessons +============================ + +The lesson documentation can be called up in different ways: + +1. **Via 'Current lesson'**: During the current lesson, this is the quickest way to access the lesson documentation. +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 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' +-------------------------- + +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 + +If enabled in the preferences, lesson documentation is carried over to adjacent +lessons. So if one subject is held in a double or triple lesson, only one needs +to be filled in. + +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% + :alt: Personal notes in lesson overview + +Behaviour of absences and tardiness +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +When a student is marked as absent, this information is carried over to all future +lessons on the same day, meaning that for any teacher holding lessons in the class +after the one that marked them as absent will automatically see them as absent. + +Likewise, if a student returns and is marked as not absent, this is carried over +to all future lessons. + +Tab 'Previous lesson' +--------------------- + +This tab shows information about the previous lesson in the same group and subject +for reference. + +Tab 'More' +---------- + +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. + +.. 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 new file mode 100644 index 0000000000000000000000000000000000000000..ad388845fb19d7d0f0a0cc7f22957c3023023753 --- /dev/null +++ b/docs/user/25_group_roles.rst @@ -0,0 +1,9 @@ +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 diff --git a/docs/user/40_export.rst b/docs/user/40_export.rst new file mode 100644 index 0000000000000000000000000000000000000000..cdb2f2f23e550a5f27f6c4f6b339aa1dd74d78a5 --- /dev/null +++ b/docs/user/40_export.rst @@ -0,0 +1,14 @@ +(Archive) printout +================== + +Via the menu item *My Groups*, extensive documentation can be generated for each group. +This class register will be generated as a printable PDF file. + +It contains a list of the lessons taught staggered according to timetable periods, +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. + +.. note:: + This mechanism can be used for archival purposes required by law. diff --git a/pyproject.toml b/pyproject.toml index 0f12d8dc5999f9906529b72f1ce438315589fe17..edc504733396032e0248b9dc580626c89b062285 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -52,7 +52,7 @@ aleksis-core = "^2.2" aleksis-app-chronos = "^2.0rc3" [tool.poetry.dev-dependencies] -aleksis-builddeps = "^5" +aleksis-builddeps = "^6" [tool.poetry.plugins."aleksis.app"] alsijil = "aleksis.apps.alsijil.apps:AlsijilConfig"