diff --git a/doc/advanced.htm b/doc/advanced.htm index 704f4dd..0ad0888 100644 --- a/doc/advanced.htm +++ b/doc/advanced.htm @@ -74,7 +74,7 @@

The list in the top left of the management page, also shows you how many study plans there are in the contexts listed. Since subcategories are also listed, this can be very useful for management purposes.

- +

Viewing student studyplans

Viewing the studyplans of students is also a right that is context-aware. (Right local/treestudyplan:viewuserreports)

@@ -83,7 +83,7 @@ itself, but also the results of specific users). It is recommended to give this right to all teachers in a specific category, unless you have specific reasons why teachers might not be allowed to see all results of the students.

- +

Block MyStudyplan

Using the block My Studyplan you can show students the studyplans they are enrolled in on the dashboard page. This may be useful for navigation.

diff --git a/doc/img/Teacherview-badgedetails.png b/doc/img/Teacherview-badgedetails.png new file mode 100644 index 0000000..3c3e9a8 Binary files /dev/null and b/doc/img/Teacherview-badgedetails.png differ diff --git a/doc/img/Teacherview-choose-student.png b/doc/img/Teacherview-choose-student.png new file mode 100644 index 0000000..55b8ddb Binary files /dev/null and b/doc/img/Teacherview-choose-student.png differ diff --git a/doc/img/Teacherview-course-corecompletion.png b/doc/img/Teacherview-course-corecompletion.png new file mode 100644 index 0000000..9de1026 Binary files /dev/null and b/doc/img/Teacherview-course-corecompletion.png differ diff --git a/doc/img/Teacherview-course-manual.png b/doc/img/Teacherview-course-manual.png new file mode 100644 index 0000000..318db3a Binary files /dev/null and b/doc/img/Teacherview-course-manual.png differ diff --git a/doc/img/Teacherview-overview.png b/doc/img/Teacherview-overview.png new file mode 100644 index 0000000..dead148 Binary files /dev/null and b/doc/img/Teacherview-overview.png differ diff --git a/doc/img/Teacherview-statistics-badge-course.png b/doc/img/Teacherview-statistics-badge-course.png new file mode 100644 index 0000000..574af93 Binary files /dev/null and b/doc/img/Teacherview-statistics-badge-course.png differ diff --git a/doc/img/Teacherview-statistics.png b/doc/img/Teacherview-statistics.png new file mode 100644 index 0000000..234f918 Binary files /dev/null and b/doc/img/Teacherview-statistics.png differ diff --git a/doc/teacherview-studyplan.htm b/doc/teacherview-studyplan.htm index 659abd1..59a8134 100644 --- a/doc/teacherview-studyplan.htm +++ b/doc/teacherview-studyplan.htm @@ -8,8 +8,75 @@ -

About studyplan

+

Teacher view for study plans

+

While students can only see their own results in a studyplan, teachers that have the right to see studyplans in a certain context can see more

+

The teacherview shows teachers both statistics about the available grades as well as the results of individual students on request

+
NOTE:
+

Because the teacherview collects a lot of data to generate the statistics, it can take a while for the teacher view to load.

+

At the moment those statistics are not cached, but collected and calculated live on each request

+
+

Overview of study plans

+

If a user has the permission local/treestudyplan:viewuserrreport they can see the link Study plans in a category view they have the permission, + or (if the primary navigation is properly configured) in the primary navigation bar.

+

Upon choosing the Study plans link the user is shown an overview of the studyplans availabel for viewing in the category selected.
+ (If no category is selected, the first available category where the user has the required permission will be shown.)

+

+

In the top left drop-down menu the user can choose any other category with studyplans that they have permission for.

+

The view shows info cards for each studyplans in relevant order: Current (blue), Past (purple) and Future (grey), with colored bars indicating the timing status

+

By clicking the info card's title or open button, the study plan is shown in detail (statistics view)

+
TIP:
+

The colors can be tweaked by changing the boostrap CSS vars --blue, --purple and --gray

+

These same colors are also used to indicate the timing status of courses in the studyplan view itself

+
+

Statistics view

+

The statistics view shows the studyplan in its entirety, but shows the completion statistics for each course or badge

+

+

The completion circle shows the total completion by filling up the circle, but also shows you the amount of: +

+ When there are activities that need grading, a center dot in the warning color appears as a signal. +

+

Badges will show a circle around them which fills up according to the number of students linked to the study plan who have achieved this badge

+

The colored tabs in front of each course show if the course is currently given (blue), in the past (purple) or in the future (grey)

+

+
TIP:
+

The courses that a teacher is personally teaching are given a yellow highlight around them.
+ This helps teachers find their own courses more easily

+
+ +

Course details

+

By clicking on the course title, the details view appears. Here all relevant criteria are shown

+

Each criterium has a progress bar that shows the student progress. For activities, this progress bar uses the same color scheme as the completion circle + to show the completion statistics for that requirement. +

+

By clicking on the icon, the specific requirements for the criterium are shown

+

+ +

Course details when using manual studyplan aggregation

+

When using a manual aggregation method instead of the course completion method, the view is slightly different.

+

Here, only the gradable activities for this course are shown.

+

+

Badge details

+

By clicking on the badge, more information about it are shown, like description, award criteria and a link to the badge details

+

A progress bar is also shown, indicating how many students in the study plan have earned this badge

+

+ +

Allowing teachers to select gradables in manual mode

+

When using a manual aggregation method, if a teacher has the permission local/treestudyplan:selectowngradables a gear icon is shown + This allows the teacher to select which gradable activities are shown in the studyplan.

+ +

Viewing student studyplans

+

To view the results of individual students, the teacher can click on the button

+

This opens a drawer to the right of the screen, where the teacher can select any of the students linked to this study plan and view their results

+

This view is identical to the view that the students themselves see when viewing their study plan.

+

+

By selecting , the teacher can + return to the teacher view

\ No newline at end of file diff --git a/doc/view-studyplan.htm b/doc/view-studyplan.htm index 7b2cddd..63e1d32 100644 --- a/doc/view-studyplan.htm +++ b/doc/view-studyplan.htm @@ -66,6 +66,7 @@ used. If you wish to further configure the colors, you can choose to redefine the other variables (e.g. --blue and --gray) your theme's SCSS additions.

+

The colored tabs in front of each course show if the course is currently given (blue), in the past (purple) or in the future (grey)

By coloring the arrows in the color of the progress, both students and teachers can quickly see a student's progress in a course

Study plans that use the Moodle course completion aggregation method show a small circle that shows the progress percentage of all requirements, instead of an icon

@@ -80,7 +81,7 @@

The completion categories have a circle showing the progress in this category, while the status indicator to the top right shows the total status

Until the course end date has passed, the end status is marked as progress as long as one or more requirements are met or graded. After the course end date has passed, ther course is indicated as failed if the completion requirements are not met

-

By clicking on the icon, the student can see the specific requirements for each +

By clicking on the icon, the student can see the specific requirements for each condition or activity.

If a teacher left feedback for an activity, the link View feedback is shownand shows the specific feedback upon clicking it.

diff --git a/version.php b/version.php index 1ae9ce0..f072486 100644 --- a/version.php +++ b/version.php @@ -1,6 +1,6 @@ component = 'local_treestudyplan'; // Recommended since 2.0.2 (MDL-26035). Required since 3.0 (MDL-48494) -$plugin->version = 2023063007; // YYYYMMDDHH (year, month, day, iteration) +$plugin->version = 2023070100; // YYYYMMDDHH (year, month, day, iteration) $plugin->requires = 2021051700; // YYYYMMDDHH (This is the release version for Moodle 3.11) $plugin->dependencies = [