# 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.

## Roles post install

While the studyplan management rights are added by default to the manager 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 local/treestudyplan:viewuserreports to that role, and assign the role to all users that should have this right in a given context.

See Advanced -> Roles and permissions for more details

### Recommended roles

It is recommended to create the following new roles:

- Full Name: Studyplan Manager
  Short Name: studyplanmanager
  Context types: System, Category
  Capabilities
  - local/treestudyplan:editstudyplan Manage studyplans
- Full Name: Studyplan Viewer
  Short Name: studyplanviewer
  Context types: System, Category
  Capabilities
  - local/treestudyplan:viewuserreports View study plan of others
  TIP:
  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
- Full Name: Studyplan Coach
  Short Name: studyplancoach
  Context types: System, Category
  Capabilities
  - local/treestudyplan:coach Available as coach
  TIP:
  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

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.

## Configuration

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

The page Configuration gives more details about the configuration options