diff --git a/doc.php b/doc.php new file mode 100644 index 0000000..c81a3a5 --- /dev/null +++ b/doc.php @@ -0,0 +1,33 @@ +libdir.'/weblib.php'); + +$systemcontext = context_system::instance(); + +$PAGE->set_url("/local/treestudyplan/doc.php",array()); +$PAGE->set_pagelayout('base'); +$PAGE->set_context($systemcontext); +require_login(); + +$pi = $_SERVER['PATH_INFO']; +$file = $CFG->dirroot."/local/treestudyplan/doc".$pi; + +// Fallback to index +if(!file_exists($file)){ + $file = $CFG->dirroot."/local/treestudyplan/doc/index.htm"; +} + +$mime = mime_content_type($file); +$text_types = ["text/html","text/plain"]; + +if( in_array($mime,$text_types)) +{ + print $OUTPUT->header(); + print file_get_contents($file); + print $OUTPUT->footer(); +} +else { + header("Content-type: {$mime}"); + print file_get_contents($file); +} \ No newline at end of file diff --git a/doc/img/AddStudyline-modal.png b/doc/img/AddStudyline-modal.png new file mode 100644 index 0000000..db98219 Binary files /dev/null and b/doc/img/AddStudyline-modal.png differ diff --git a/doc/img/AddStudylines-overview.png b/doc/img/AddStudylines-overview.png new file mode 100644 index 0000000..9c1f24c Binary files /dev/null and b/doc/img/AddStudylines-overview.png differ diff --git a/doc/img/Course-config-bistate.png b/doc/img/Course-config-bistate.png new file mode 100644 index 0000000..a94706e Binary files /dev/null and b/doc/img/Course-config-bistate.png differ diff --git a/doc/img/Course-config-corecompletion.png b/doc/img/Course-config-corecompletion.png new file mode 100644 index 0000000..2ce2917 Binary files /dev/null and b/doc/img/Course-config-corecompletion.png differ diff --git a/doc/img/Createstudyplan.png b/doc/img/Createstudyplan.png new file mode 100644 index 0000000..7589f28 Binary files /dev/null and b/doc/img/Createstudyplan.png differ diff --git a/doc/img/Newstudyplan-bistate.png b/doc/img/Newstudyplan-bistate.png new file mode 100644 index 0000000..1b8fdf8 Binary files /dev/null and b/doc/img/Newstudyplan-bistate.png differ diff --git a/doc/img/Newstudyplanscreen.png b/doc/img/Newstudyplanscreen.png new file mode 100644 index 0000000..ae7da4b Binary files /dev/null and b/doc/img/Newstudyplanscreen.png differ diff --git a/doc/img/Siteconfig.png b/doc/img/Siteconfig.png new file mode 100644 index 0000000..01867f4 Binary files /dev/null and b/doc/img/Siteconfig.png differ diff --git a/doc/img/Studyitem-dragdelete.png b/doc/img/Studyitem-dragdelete.png new file mode 100644 index 0000000..9bd0075 Binary files /dev/null and b/doc/img/Studyitem-dragdelete.png differ diff --git a/doc/img/Studylines-view.png b/doc/img/Studylines-view.png new file mode 100644 index 0000000..0893c8d Binary files /dev/null and b/doc/img/Studylines-view.png differ diff --git a/doc/img/Toolbox-Courses.png b/doc/img/Toolbox-Courses.png new file mode 100644 index 0000000..8be32d7 Binary files /dev/null and b/doc/img/Toolbox-Courses.png differ diff --git a/doc/img/Toolbox-badges.png b/doc/img/Toolbox-badges.png new file mode 100644 index 0000000..94403b3 Binary files /dev/null and b/doc/img/Toolbox-badges.png differ diff --git a/doc/img/Toolbox-dragcourse.png b/doc/img/Toolbox-dragcourse.png new file mode 100644 index 0000000..f774add Binary files /dev/null and b/doc/img/Toolbox-dragcourse.png differ diff --git a/doc/img/Toolbox-flow.png b/doc/img/Toolbox-flow.png new file mode 100644 index 0000000..ee0a995 Binary files /dev/null and b/doc/img/Toolbox-flow.png differ diff --git a/doc/index.htm b/doc/index.htm new file mode 100644 index 0000000..709b774 --- /dev/null +++ b/doc/index.htm @@ -0,0 +1,142 @@ +
+

Studyplan user manual

+ +

About studyplan

 +

The studyplan plugin extends Moodle with the ability to show students and teachers an overview of their curriculum and results therein

+

By showing students an easy to read graphical overview of their progress over multiple courses, students are more in control of their own + learning process than by just listing results alone

+ +

Configuration post install

 +

The studyplan plugin will automatically add links to the flat navigation bat used in Moodle 3.11 and below

+

However, Moodle 4.0-4.2 use a new "primary navigation" bar, and does not yet support customizing the primary navigation bar (it is a planned feature though)

+ +

Use the following workaround:

+

You can add custom primary menu items in Site administration -> Appearance-> Theme settings + That page contains an item called Custom menu items". Add the following into that area to custimize it +

+ 

+Mijn studieplan|/local/treestudyplan/myreport.php||nl
+Studieplannen|/local/treestudyplan/view-plan.php||nl
+Studieplannen beheren|/local/treestudyplan/edit-plan.php||nl
+My study plan|/local/treestudyplan/myreport.php||en
+Study plans|/local/treestudyplan/view-plan.php||en
+Manage Study plans|/local/treestudyplan/edit-plan.php||en
+

+

The studyplan plugin wil automatically hide the primary navigation items that are not applicable for the current user.

+

Configuration

 + After installing the plugin you can find the main configuration in Site administration -> Courses -> Studyplans +
+ +

Creating a study plan

 +

To create a studyplan, go to Site administration -> Courses -> Studyplans -> Manage Studyplans

+

You will now see a screen like the following

+

+

If you do not yet have an exported studyplan to import, pick Add study plan to create a new study plan

+

You are now asked to provide details for this new studyplan

+

+

The screen allows you to specify the full name, code or short name and description for this specific plan

+

You can also choose the category context in which to place this study plan. This is useful to manage access rights in a large moodle installation

+

The next options give more information about the timing of the plan. The number of slots to place courses in the plan can be specified. + This is usually used to show the different periods in the academic year. You can expect this to become more explicit in upcoming versions of the plugin. + The start date and end date of the plan help to show students and teachers which plans are current, and which were finished in the past. + They will default to start on august 1 of this year and continue until august 1 of next year, since that matches most academic years.

+

Finally we have the aggregation style, which is ised to determine how the courses show grades. There are a number of options available:

+ +

Details for Manual: Completed + required goals

+

+ With this aggregation method you manually select which grade items are used in the progress report. The design intent is to prepare a number of gradable items, + and describe the learning objectives for each course and use these to indicate completion. While any grade will be properly shown, it makes most sense to use a scale which indicates + if the student has either met the objective or not. The teacher or studyplan editor can also mark certain gradables/objectives as required or compulsory. +

+

The final outcome for the courses will then be determined based on the percentage of met objectives, provided that all required/compulsory objectives are met

+

+

The added options allow you to set the threshold percentage of completed objectives in each course to determine the outcome as excellent, good + or completed. If an objective is not met it will be marked as either "progress" (meaning that the student's work needs to be improved) or + "incomplete" (meaning that the student has not started working on this goal yet)

+

When failed results are enabled, any "progress" will be marked as "failed" when the course end date has passed

+

Finally, you can opt to have an object ive

+

Setting up studylines

 +

Before you can add courses to the studyplan, you have to define study lines. You use them to group together courses in logical categories. + Most likely these are categories or themes within your curriculum.

+

For performance reasons, study lines can only be edited when in study line edit mode. The courses and flow between them will be hidden, + so the lines can be reshuffled and edited. You can toggle studyline edit mode with the toggle switch edit stydy lines

+

+

Using the Add study line link, you can add a new studyline. You will then get a new window where you can enter details and select a handle color for this line

+

+

Here you can enter a full name for the study line that will be shown when you hover over the name, and a code that is a short name which will be shown + in front of the study line. Often this can be a short code. The color you pick will be shown in a little tab in front of the study line.

+

You can drag study lines to re-order them after you place them using the crosshair arrows

+

Using the and symbols you can edit and delete the studyline (only empty studylines can be deleted)

+

+
TIP:
+ If you have many studyplans using the same study line make-up you can export the first studyplan after you set up the study lines, and then import it on the next + study plans.
(Use Advanced -> Backup studyplan to find the backup and restore features)
+ +

Adding courses

 +

To add courses, you need to exit study line edit mode and open the toolbox using the button. + The toolbox will now open on the right of the screen. (Using the toggle button on top, you can also switch it to the left of the screen if needed)

+

+

The toolbox shows you all the categories you have access to and the courses in them. Simply drag the course you want to include from the toolbox and + drop it in one of the slots in the studyplan that now appear.

+

+

To re-arrange the courses in the study plan, simply drag and drop them from the places they are now in.

+

+

To remove a course from the study plan, simply drag it to the red garbage bin that appears on dragging

+

Configuring courses

 +

Once a course is added to the studyplan, an icon shows if it needs to be configured () or + is already configured ().

+

By clicking on the course title (it's shortname, or a configured custom field), you can view the details, and configure it where applicable. + The configuration is dependent on the aggregation method for the study plan:

+

Moodle course completion

+

When using moodle course completion as a base, all configuration is done in the course's completion settings. + The course details show a gear icon in the title, which takes you directly to the course completion configuration. + Once it is configured, the course details will show you exactly how the course completion is configured

+

+ +

Manual: Completed + required goals

+

In this mode, the course details show you all the gradable activities in the course. You need to select which of them will be used to determine progress + and will be shown to the students and teachers in the studyplan view. You can also mark gradables ad required. Gradable activities marked as + such will all need to be completed for the course to be marked as completed, regardless of the minimum percentage configured

+

+ +

Adding badges

 +

The toolbox also shows you the site-wide badges that are available for students. These can be dragged into the slots around and between the courses.

+

When you click on the icon in the badge it shows you additional information about the badge

+

+

Drawing the flow

 +

You can draw arrows between the courses and add flow indicators to show students how different courses are related in the studyplan

+

Drawing arrows

+

+

Removing arrows

+

+

Adding flow indicators +

+

You can add the following flow indicators:

+ +

By clicking on the icon in the junction and finish indicators, you can select how the incoming arrows will be combined. + The indicated numer of arrows need to be completed in order to show the indicator as completed

+ +
Note:
+ Using the Manual aggregation method, these conditions are also used to determine whether a junction or finish will be shown as good or excellent + In those cases, at least the specified number of arrows need to be good or excellent in order to color the indicator as such.
+ + +

\ No newline at end of file diff --git a/lang/en/local_treestudyplan.php b/lang/en/local_treestudyplan.php index 52366cf..422a08e 100644 --- a/lang/en/local_treestudyplan.php +++ b/lang/en/local_treestudyplan.php @@ -80,6 +80,7 @@ $string['studyplan_remove'] = 'Remove study plan'; $string['studyplan_confirm_remove'] = 'Are you sure you want to remove studyplan {$a}?'; $string['studyplan_name'] = 'Full name'; $string['studyplan_name_ph'] = ''; +$string['studyplan_context'] = 'Context'; $string['studyplan_shortname'] = 'Code'; $string['studyplan_shortname_ph'] = ''; $string['studyplan_description'] = 'Description'; diff --git a/lang/nl/local_treestudyplan.php b/lang/nl/local_treestudyplan.php index 9be2f36..f408476 100644 --- a/lang/nl/local_treestudyplan.php +++ b/lang/nl/local_treestudyplan.php @@ -82,6 +82,7 @@ $string['studyplan_remove'] = 'Studieplan verwijderen'; $string['studyplan_confirm_remove'] = 'Weet je zeker dat je studieplan {$a} wilt verwijderen?'; $string['studyplan_name'] = 'Naam'; $string['studyplan_name_ph'] = ''; +$string['studyplan_context'] = 'Context'; $string['studyplan_shortname'] = 'Code'; $string['studyplan_shortname_ph'] = ''; $string['studyplan_description'] = 'Beschrijving';