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

Merge branch 'docs-create' into 'master'

[Docs] Add user instructions

Closes #8

See merge request AlekSIS/official/AlekSIS-App-Stoelindeling!6
parents 2496b09f 2b34c7e0
No related branches found
No related tags found
1 merge request!6[Docs] Add user instructions
Pipeline #76224 passed with warnings
Pipeline: AlekSIS

#76233

    docs/_static/class_register_with_seating_plan.png

    86 KiB

    docs/_static/class_register_without_seating_plan.png

    51.4 KiB

    docs/_static/edit_seating_plan.png

    146 KiB

    docs/_static/seating_plans.png

    83.5 KiB

    docs/_static/view_seating_plan.png

    112 KiB

    Seating plan administration
    ===========================
    .. toctree::
    :glob:
    *
    Permissions
    ===========
    Group owners can always view, create, edit and delete seating plans
    for their groups. Also, they can view plans of parent groups.
    The ``Seating plans`` menu entry is only displayed, when at least
    one seating plan can be viewed by a person.
    To give persons who are not group owners permissions, use the following:
    * **stoelindeling.view_seatingplan**: Global or orbject permission to
    view all seating plans or a specific one
    * **stoelindeling.add_seatingplan**: Global permission to create seating
    plans
    * **stoelindeling.change_seatingplan**: Global or object permission to
    edit all seating plans or a specific one
    * **stoelindeling.delete_seatingplan**: Global or object permission to
    delete all seating plans or a specific one
    Persons with the global permission **stoelindeling.add_seatingplan** are
    also allowed to view the list of all seating plans.
    ......@@ -10,6 +10,9 @@ Welcome to AlekSIS-App-Stoelindelings documentation!
    :maxdepth: 2
    :caption: Contents:
    user/00_index
    admin/00_index
    Indices and tables
    ==================
    ......
    Using seating plans
    ===================
    .. toctree::
    :glob:
    *
    Managing seating plans
    ======================
    A seating plan is always linked to a combination of ``Group`` and ``Room``. Additionally,
    a ``Subject`` can be specified. When a group, e.g. a class, has a seating plan without a subject,
    all subgroups, e.g. a course of that class, will inherit that plan, as long as
    they do not have their own seating plan. More specific relations precede more general ones,
    so if there exists a plan for group 5a and one for group 5a with subject English, the latter will be shown.
    All seating plans can be viewed, edited and created under ``Seating plans`` in the navigation.
    .. image:: ../_static/seating_plans.png
    :alt: Seating plans overview
    To create a new seating plan, click on ``Create seating plan``.
    Select a group, subject and room and continue to the seat arrangement page.
    There you can use drag-and-drop to place available persons in the grid at the bottom.
    Extend the size of the plan, if necessary, using the expand buttons at each edge.
    .. image:: ../_static/edit_seating_plan.png
    :alt: Edit a seating plan
    Seating plans can be viewed by clicking on their name in the overview, where they can
    also be edited or deleted.
    .. image:: ../_static/view_seating_plan.png
    :alt: View a seating plan
    Integration with class register
    ===============================
    When the class register functionality of AlekSIS is used, there will be
    a tab for seating plans on lesson documentation pages.
    .. image:: ../_static/class_register_with_seating_plan.png
    :alt: Lesson documentation with seating plan
    If there is no seating plan for a lesson, i.e. no one for that specific
    combination of ``Group``, ``Room`` and ``Subject``, no one for the combination
    of ``Group`` and ``Room`` and if none of the parent groups has one, options
    for creating a seating plan are displayed.
    .. image:: ../_static/class_register_without_seating_plan.png
    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