144 lines
10 KiB
HTML
144 lines
10 KiB
HTML
<div>
|
|
<h1> Studyplan user manual</h1>
|
|
<ul class="nav nav-tabs">
|
|
<li class="nav-item"><a class="nav-link " href="index.htm">Main</a></li>
|
|
<li class="nav-item"><a class="nav-link " href="create-studyplan.htm">Creating a study plan</a></li>
|
|
<li class="nav-item"><a class="nav-link " href="view-studyplan.htm">Viewing a studyplan - for students</a></li>
|
|
<li class="nav-item"><a class="nav-link " href="teacherview-studyplan.htm">Viewing a studyplan - for teachers</a></li>
|
|
<li class="nav-item"><a class="nav-link active" href="advanced.htm">Advanced topics</a></li>
|
|
<li class="nav-item"><a class="nav-link " href="configuration.htm">Configuration</a></li>
|
|
</ul>
|
|
<h2>Advanced studyplan editing features</h2>
|
|
<p>The studyplan editor has a number of advanced features that are available under the
|
|
<span class="text-danger" role="button"><i class="fa fa-cog"></i>Advanced</span> link. (Top-right on the screen in the editor view</p>
|
|
<p>These features are helpful to the administrator, but can be dangerous if abused.</p>
|
|
<h3>Course manipulation</h3>
|
|
<p><b>Cascade cohort sync</b> can be used to manually enrol cohorts and users linked to the study plan into the courses that are in the studyplan.
|
|
If you do not have automatic cascading enabled, you must use this button to do it manually</p>
|
|
<p>It will create a cohort-sync enrolment to all courses in the studyplan for each cohort you have linked here.
|
|
It can also automatically remove those enrolments when a cohort is unlinked from a studyplan.</br>
|
|
Individually linked students can also be cascaded down to the courses (if the feature is enabled). In those cases a manual enrolment is created for the users
|
|
in each of the studyplan's courses. Those enrolments will never be automatically removed, since that might deprive a student of study content.
|
|
</p>
|
|
<p><b>Force scales</b> Only useful in <i>Manual</i> aggregation mode. In those cases you may want to enforce a specific scale to all selected gradables in
|
|
the studyplan. This can save time manually updating all the gradables used in the studyplan to a standerdized grade scale. This tool allows you to do so.</p>
|
|
<p></p>
|
|
<h3>Backup and restore</h3>
|
|
<p>Using the <b>Backup studyplan</b> you can backup an entire studyplan into a .json file.</p>
|
|
<p></p>
|
|
<p>Use <b>restore studylines from backup</b> to import the content (study lines and courses) from a studyplan into the current study plan</p>
|
|
<div class="generalbox alert alert-success"><b>PRO TIP:</b><br>
|
|
<p>If you are proficient in editing json like data structures, you can manually edit the .json backups and then restore them as new courses.</p>
|
|
<p>This is mostly useful if you need to create multiple study plans with only minor changes, or predictable changes
|
|
(like changing some text in course short names to link to new versions of courses)</p>
|
|
</div>
|
|
<h3>Deleting a studyplan</h3>
|
|
<p>Sometimes you want to delete an entire study plan. This can be done using the button found in the <b>delete</b> tab</p>
|
|
|
|
<h2>Setting a simple name for the courses</h2>
|
|
<p>By default, the short name of the course will be displayed in the study plan. However, often this name is quite long and has some
|
|
prefixes or suffixes to distinguish it from other courses that were given in earlier academic years. If you want to display a simpler name,
|
|
you can op to do so in two ways:</p>
|
|
<ol>
|
|
<li>Display the courses <b>id</b> number</li>
|
|
<li>Display a <b>custom course field</b></li>
|
|
</ol>
|
|
<p>Go to <b>Site administration</b> -> <b>Courses</b> -> <b>Studyplans</b> -> <b>Studyplan settings</b><br>
|
|
Under <b>Course display name</b> you can select if you want to use <i>shortname</i>, <i>ID field</i> or any other previously configured custom course field</p>
|
|
</p>
|
|
|
|
<h2>Grade & Scale interpretation</h2>
|
|
<div class="generalbox alert alert-info"><b>NOTE:</b><br>
|
|
<p>The information in this category is mostly applicable to <i>manual</i> aggregation methods for study plans.
|
|
If <i>Moodle course completion</i> is used, it is especially important to always configure <b>grade to pass</b></p>
|
|
<p>Note that future versions may use this feature to automatically repair missing <b>grade to pass</b> in gradable activities.</p>
|
|
</div>
|
|
<p>Best practice is to set a <b>grade to pass</b> in all gradable activities in the studyplan. This way the entire system will know
|
|
if a gradable activity wass passed or failed.</p>
|
|
<p>But since teachers are all human, this may occasionally (or regularly) be forgotten. In the absence of a configured <b>grade to pass</b>,
|
|
the studyplan system will use the values configured here to determine if a grade was a passable grade.</p>
|
|
<p>Go to <b>Site administration</b> -> <b>Courses</b> -> <b>Studyplans</b> -> <b>Configure grade & scale interpretation</b> to configure it.</p>
|
|
<p>Each scale will need to have a <b>completion threshold</b> set. This is the scale value that starts a passing grade.</p>
|
|
<p>You can also configure certain <b>maximum grade points</b> to have a default passing value (<b>completion threshold</b>)</p>
|
|
<p>While scales are automatically added and cannot be removed, you can remove previously configured <i>maximum grade points</i>.
|
|
To do so, check the <b>delete</b> mark next to it, and press <b>save</b> </p>
|
|
|
|
<h2>Accessing studyplans in context</h2>
|
|
<p>The studyplan plugin is category context aware - meaning that every studyplan is placed in a context. And users can have rights to view and/or edit
|
|
studyplans within a specific context. </p>
|
|
<p>To edit a studyplan in a specific context, you can use one or two ways:</p>
|
|
<ol>
|
|
<li>Go to the category you want to. If you have studyplan view or edit rights (Right <i>local/treestudyplan:editstudyplan</i>), you will find a link <b>Manage study plans</b> in that category's menu. </li>
|
|
<li>Go to <b>manage study plans</b> in the primary navigation, and select the context you need in the drop down menu in the top left. This drop down menu will
|
|
only show the category contexts you have studyplan management access to (Right <i>local/treestudyplan:editstudyplan</i>) </li>
|
|
</ol>
|
|
<p>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.</p>
|
|
<img src="img/Contexts-Manage.png" class="border border-primary rounded-lg ml-3">
|
|
|
|
<h3>Viewing student studyplans</h3>
|
|
<p> Viewing the studyplans of students is also a right that is context-aware. (Right <i>local/treestudyplan:viewuserreports</i>)</p>
|
|
<p> Both methods outlined above also work for viewing student studyplans. The main difference is that the drop-down list on the top-left of the page
|
|
only shows the categories that actually have studyplans that are viewable for the current user. (Which means that the user can not only see the study plan
|
|
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.
|
|
</p>
|
|
<img src="img/Contexts-View.png" class="border border-primary rounded-lg ml-3">
|
|
|
|
<h2>Block MyStudyplan</h2>
|
|
<p>Using the block <i>My Studyplan</i> you can show students the studyplans they are enrolled in on the dashboard page. This may be useful for navigation.</p>
|
|
<p>This block shows <i>teachers</i> another view - namely all studyplans they are currently teaching courses in (orderd in tabs). For teachers, this view will often take a
|
|
few seconds to load, especialy if they teach in multiple study plans, since the result statistics for each course are collected each time</p>
|
|
<p>In spite of the loading time, this view can be beneficial to teachers, since it can easily show them the statistics for the courses they are teaching</p>
|
|
|
|
<a id="rights"><h2>Roles and permissions</h2></a>
|
|
<p>For the studyplan the following permissions are defined:</p>
|
|
<table>
|
|
<tr>
|
|
<th>Right</th>
|
|
<th>Explanation</th>
|
|
<th>Default applied to</th>
|
|
<th>Context applicabble</th>
|
|
</tr>
|
|
<tr>
|
|
<td>local/treestudyplan:editstudyplan</td>
|
|
<td></td>
|
|
<td>manager</td>
|
|
<td>System and/or category</td>
|
|
</tr>
|
|
<tr>
|
|
<td>local/treestudyplan:forcescales</td>
|
|
<td>Allow studyplan managers with this right to push scales for grading to all selected grable activities (see above)<br>
|
|
(Effective only when Manual aggregation method is selected in the study plan)</td>
|
|
<td>manager</td>
|
|
<td>System and/or category</td>
|
|
</tr>
|
|
<tr>
|
|
<td>local/treestudyplan:selectowngradables</td>
|
|
<td>Teachers with this right in a course context, can select their own gradable activities in the plan<br>
|
|
(Effective only when Manual aggregation method is selected in the study plan)</td>
|
|
<td>teacher</td>
|
|
<td>Course</td>
|
|
</tr>
|
|
<tr>
|
|
<td>local/treestudyplan:configure</td>
|
|
<td>Users with this right can configure global interpretation of scales and point grades </td>
|
|
<td>manager</td>
|
|
<td>System</td>
|
|
</tr>
|
|
<tr>
|
|
<td>local/treestudyplan:viewuserreports</td>
|
|
<td></td>
|
|
<td>manager</td>
|
|
<td>System and/or category</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>While the studyplan management rights are added by default to the <b>manager</b> role, the right to just view the studyplans for teachers and students is not
|
|
added to any default role. You should make a separate role for faculty that is allowed to view the study plans (or integrate it in an existing role),
|
|
grant the roght <i>local/treestudyplan:viewuserreports</i> to that role, and assign the role to all users that should have this right in a given context.</p>
|
|
|
|
|
|
|
|
|
|
</div> |