Miqra-Engineering/moodle_local_treestudyplan
2
0
Fork 0
Code Issues 8 Pull Requests Packages Projects Releases 4 Wiki Activity

Documentation updates

Browse Source
This commit is contained in:
PMKuipers 2023-08-17 23:52:52 +02:00
parent c04827d48c
commit 12ff557872
4 changed files with 81 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -1,13 +1,61 @@
# moodle-local_treestudyplan
# Moodle studyplan plugin
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
## Installing
Install the plugin by adding the zip file manually to the installed plugins in your moodle version
## Configuration post install
### Dynamic Navigation links
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.
### Role configuration
While the studyplan management rights are added by default to the **manager** role, and students can always see the studyplans they are associated with, the faculty members' right to view the studyplans 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 *local/treestudyplan:viewuserreports* to that role, and assign the role to all users that should have this right in a given context.
The recommended roles below give an example of that.
(See **Advanced** -> **Roles and permissions** in the documentation for more details about the different roled)
#### Recommended roles
It is recommended to create the following new roles:</p>
- **Full Name:** *Studyplan Manager*
**Short Name:** *studyplanmanager*
**Context types:** *System*, *Category*
**Capabilities**
- **Manage studyplans** (*local/treestudyplan:editstudyplan*)
- **Full Name:** *Studyplan Viewer*
**Short Name:** *studyplanviewer*
**Context types:** *System*, *Category*
**Capabilities**
- **View study plan of others** (*local/treestudyplan:viewuserreports*)
Then assign the role **studyplanmanager** 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
Assign the role **studyplanviewer** 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.
## Further Configuration<
After installing the plugin you can find the main configuration in **Site administration** -> **Courses** -> **Studyplans**
## Documentation / User manual
After installing the plugin, the user manual can be found under **Site administration** -> **Courses** -> **Studyplans** -> **Studyplan plugin documentation**
After installing the plugin, the detailed user manual can be found under **Site administration** -> **Courses** -> **Studyplans** -> **Studyplan plugin documentation**
Alternatively, you can unpack this ZIP file and open the **doc/index.html** file.
(Note that viewing the html files directly will not five the optimal experience, since fontawesome tags and bootstrap items will not be properly rendered)
(Note that viewing the html files directly will not five the optimal experience, since fontawesome tags and bootstrap styles will not be properly rendered)
## Development
To build a release zip, you can use the script **./build.sh**. This script calls grunt to build the javascript minified files where needed and creates a relase zip file with the current plugin version (as defined in *version.php*) in the directory **/build**

28
doc/index.htm
View File

@ -39,6 +39,34 @@ Manage Study plans|/local/treestudyplan/edit-plan.php||en
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>
</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>

2
lang/en/local_treestudyplan.php
View File

@ -15,7 +15,7 @@ $string['privacy:metadata:user:studyplan_id'] = 'The studyplan';
$string['treestudyplan:editstudyplan'] = "Manage studyplans";
$string['treestudyplan:configure'] = "Configure studyplans";
$string['treestudyplan:viewuserreports'] = "View study plan of others";
$string['treestudyplan:forcescales'] = 'Advanced: Allow stydyplan manager to force assignment scales to setting (manual modes only)';
$string['treestudyplan:forcescales'] = 'Advanced: Allow studyplan manager to force assignment scales to setting (manual modes only)';
$string['treestudyplan:selectowngradables'] = 'Teachers can select gradables in their own courses in study plan view mode (manual modes only)';

2
version.php
View File

@ -1,6 +1,6 @@
<?php
$plugin->component = 'local_treestudyplan'; // Recommended since 2.0.2 (MDL-26035). Required since 3.0 (MDL-48494)
$plugin->version = 2023081603; // YYYYMMDDHH (year, month, day, iteration)
$plugin->version = 2023081700; // YYYYMMDDHH (year, month, day, iteration)
$plugin->requires = 2021051700; // YYYYMMDDHH (This is the release version for Moodle 3.11)
$plugin->dependencies = [