88 lines
5.3 KiB
HTML
88 lines
5.3 KiB
HTML
<html>
|
|
<head></head>
|
|
<body>
|
|
<div>
|
|
<h1> Studyplan user manual</h1>
|
|
<ul class="nav nav-tabs">
|
|
<li class="nav-item"><a class="nav-link active" 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 " href="advanced.htm">Advanced topics</a></li>
|
|
<li class="nav-item"><a class="nav-link " href="configuration.htm">Configuration</a></li>
|
|
</ul>
|
|
<a id="#about"><h2>About studyplan</h2></a>
|
|
<p>The studyplan plugin extends Moodle with the ability to show students and teachers an overview of their curriculum and results therein</p>
|
|
<p>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</p>
|
|
|
|
<a id="#postinstall"><h2>Configuration post install</h2></a>
|
|
<p>The studyplan plugin will automatically add links to the flat navigation bat used in Moodle 3.11 and below<p>
|
|
<p>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)</p>
|
|
|
|
<p><strong>Use the following workaround:</strong></p>
|
|
<p>You can add custom primary menu items in <b>Site administration</b> -> <b>Appearance</b>-> <b>Theme settings</b>
|
|
That page contains an item called Custom menu items". Add the following into that area to custimize it
|
|
</p>
|
|
<p><pre >
|
|
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
|
|
</pre></p>
|
|
<p> The studyplan plugin wil automatically hide the primary navigation items that are not applicable for the current user.</p>
|
|
<h2>Roles post install</h2>
|
|
<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>
|
|
<p>See <a href="advanced.htm#rights"><b>Advanced</b> -> <b>Roles and permissions</b></a> for more details</p>
|
|
|
|
<h3>Recommended roles</h3>
|
|
<p> It is recommended to create the following new roles:</p>
|
|
<ul>
|
|
<li><b>Full Name:</b> <i>Studyplan Manager</i><br>
|
|
<b>Short Name:</b> <i>studyplanmanager</i><br>
|
|
<b>Context types:</b> <i>System</i>, <i>Category</i><br>
|
|
<b>Capabilities</b>
|
|
<ul>
|
|
<li><b>local/treestudyplan:editstudyplan</b> <i>Manage studyplans</i></li>
|
|
</ul>
|
|
</li>
|
|
<li><b>Full Name:</b> <i>Studyplan Viewer</i><br>
|
|
<b>Short Name:</b> <i>studyplanviewer</i><br>
|
|
<b>Context types:</b> <i>System</i>, <i>Category</i><br>
|
|
<b>Capabilities</b>
|
|
<ul>
|
|
<li><b>local/treestudyplan:viewuserreports</b> <i>View study plan of others</i></li>
|
|
</ul>
|
|
<div class="generalbox alert alert-success"><b>TIP:</b><br>
|
|
If you already have a role that you hand out to all teachers/faculty in specific categories, you may want to integrate this role with that one
|
|
</div>
|
|
</li>
|
|
<li><b>Full Name:</b> <i>Studyplan Coach</i><br>
|
|
<b>Short Name:</b> <i>studyplancoach</i><br>
|
|
<b>Context types:</b> <i>System</i>, <i>Category</i><br>
|
|
<b>Capabilities</b>
|
|
<ul>
|
|
<li><b>local/treestudyplan:coach</b> <i>Available as coach</i></li>
|
|
</ul>
|
|
<div class="generalbox alert alert-success"><b>TIP:</b><br>
|
|
If you already have a role that you hand out to coaches of a limited group of students, you may want to integrate this role with that one
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<p> Then assign the role <b>studyplanmanager</b> in a specific category context, or the system context to all users who should be able to create and edit studyplans
|
|
in that specific context</p>
|
|
<p> Assign the role <b>studyplanviewer</b> to all users who should be able to view the teacher view of the studyplan and view the specific results of users associated
|
|
with that studyplan. </p>
|
|
|
|
<h2>Configuration</h2>
|
|
<p>After installing the plugin you can find the main configuration in <b>Site administration</b> -> <b>Courses</b> -> <b>Studyplans</b></p>
|
|
<p><img src="img/Siteconfig.png" class="border border-primary rounded-lg ml-3"></p>
|
|
<p>The page <a href="configuration.htm"><b>Configuration</b></a> gives more details about the configuration options</p>
|
|
|
|
</div>
|
|
</body>
|
|
</html> |