Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development: Add documentation for lecture unit processing #7310

Merged
merged 6 commits into from
Oct 10, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion docs/user/lectures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,21 @@ Managing Lectures
Instructors have three options for creating a lecture.

1. Create a new lecture from scratch by clicking on |create-lecture-btn|.
Lectures consist of a title, a description, and optionally a start and end date.
Lectures consist of a title, a description, optionally a start and end date, and the selection of automatic unit processing.

|create-lecture|

If instructors decide to process units automatically by clicking on the |process-units-checkbox| checkbox, additional information will be displayed
and they can click on |process-units-btn| to process the lecture PDF into multiple units.

|create-lecture-automatic-unit-processing|

Once the units are processed, instructors can view how the units are split (start page and end page). A name is automatically generated for each lecture unit. Instructors
pellumbbaboci marked this conversation as resolved.
Show resolved Hide resolved
can also customize the table entries by removing or adding new units. Additionally, they can enter keywords if they want particular slides
to be removed. Slides containing the keyword will be removed.
pellumbbaboci marked this conversation as resolved.
Show resolved Hide resolved

|processed-lecture-units|

2. In addition to creating a new lecture from the default mode, instructors can switch to the guided lecture creation by clicking on |switch-to-guided-mode-btn|.
This guided mode helps creating a new lecture and adding its contents through a multi-step process. The following video shows an exemplary use of the guided mode.

Expand Down Expand Up @@ -168,3 +179,11 @@ See :ref:`Adaptive Learning <adaptive-learning>` for more information.
:width: 800
.. |create-exercise-unit| image:: lectures/create-exercise-unit.png
:width: 800
.. |process-units-checkbox| image:: lectures/process-units-checkbox.png
:width: 120
.. |process-units-btn| image:: lectures/process-units-btn.png
:width: 120
.. |processed-lecture-units| image:: lectures/processed-lecture-units.png
:width: 800
.. |create-lecture-automatic-unit-processing| image:: lectures/create-lecture-automatic-unit-processing.png
:width: 800
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/user/lectures/create-lecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/lectures/process-units-btn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/lectures/process-units-checkbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/lectures/processed-lecture-units.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.