moodle_local_treestudyplan/doc/create-studyplan.htm

<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 active" 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>
    <h2>Creating and managing a study plan</h2>
    <p>To create a studyplan, go to <b>Site administration</b> -> <b>Courses</b> -> <b>Studyplans</b> -> <b>Manage Studyplans</b></p>
    <p>You will now see a screen like the following</p>
    <p><img src="img/Createstudyplan.png" class="border border-primary rounded-lg ml-3"></p>
    <p>If you do not yet have an exported studyplan to import, pick <b>Add study plan</b> to create a new study plan</p>
    <p>You are now asked to provide details for this new studyplan</p>
    <p><img src="img/Newstudyplanscreen.png" class="border border-primary rounded-lg ml-3"></p>
    <p>The screen allows you to specify the <b>full name</b>, <b>code</b> or short name and <b>description</b> for this specific plan</p>
    <p>You can also choose the category <b>context</b> in which to place this study plan. This is useful to manage access rights in a large moodle installation</p>
    <p>The next options give more information about the timing of the plan. The <b>number of slots</b> 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 <b>start date</b> and <b>end date</b> 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.</p>
    <p>Finally we have the <b>aggregation style</b>, which is ised to determine how the courses show grades. There are a number of options available:</p>
    <ul>
        <li><b>Moodle course completion</b> <i>This is the recommended method to use.</i> All the conditions selected in the moodle course completion will be shown in the progress list.</li>
        <li><b>Manual: Completed + required goals</b>Manually select a number of gradable activities from the course, which will be used to determine grade. Extra options for this method</li>
        <li><b>Manual: Progress/Completed/Excellent classic</b> <i>Deprecated! Do not use!</i> This is an old and convoluted method that is only in here for compatibility reasons</li>
    </ul>
    <h3>Details for Manual: Completed + required goals</h3>
    <p>
        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. 
    </p>
    <p>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</p>
    <p><img src="img/Newstudyplanscreen.png" class="border border-primary rounded-lg ml-3"></p>
    <p>The added options allow you to set the <b>threshold</b> percentage of completed objectives in each course to determine the outcome as <i>excellent</i>, <i>good</i>
        or <i>completed</i>. 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) </p>
    <p>When <i>failed</i> results are enabled, any "progress" will be marked as "failed" when the course end date has passed</p>
    <p>Finally, you can opt to have an object ive </p>
    <a id="studylines"><h2>Setting up studylines</h2></a>
    <p>Before you can add courses to the studyplan, you have to define <i>study lines</i>. You use them to group together courses in logical categories. 
        Most likely these are categories or themes within your curriculum.</p>
    <p>For performance reasons, study lines can only be edited when in <i>study line edit mode</i>. 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 <i>edit stydy lines</i></p>
    <p><img src="img/AddStudylines-overview.png" class="border border-primary rounded-lg ml-3"></p>
    <p>Using the <b>Add study line</b> 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</p>
    <p><img src="img/AddStudyline-modal.png" class="border border-primary rounded-lg ml-3"></p>
    <p>Here you can enter a <b>full name</b> for the study line that will be shown when you hover over the name, and a <b>code</b> that is a short name which will be shown
    in front of the study line. Often this can be a short code. The <b>color</b> you pick will be shown in a little tab in front of the study line.</p>
    <p>You can <i>drag</i> study lines to re-order them after you place them using the <i class="fa fa-arrows"></i> crosshair arrows</p>
    <p>Using the <i class="fa fa-pencil"></i> and <i class="fa fa-trash"></i> symbols you can edit and delete the studyline (only empty studylines can be deleted)</p>
    <p><img src="img/Studylines-view.png" class="border border-primary rounded-lg ml-3"></p>
    <div class="generalbox alert alert-success"><b>TIP:</b><br>
    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.<br>(Use <b>Advanced</b> -> <b>Backup studyplan</b> to find the <i>backup</i> and <i>restore</i> features)</div>
    
    <a id="studycourses"><h2>Adding courses</h2></a>
    <p>To add courses, you need to exit <i>study line edit mode</i> and open the toolbox using the <button class="btn btn-primary">Open toolbox</button> 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)</p>
    <p><img src="img/Toolbox-Courses.png" class="border border-primary rounded-lg ml-3"></p>
    <p>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.</p>
    <p><img src="img/Toolbox-dragcourse.png" class="border border-primary rounded-lg ml-3"></p>
    <p>To re-arrange the courses in the study plan, simply drag and drop them from the places they are now in.</p>
    <p><img src="img/Studyitem-dragdelete.png" class="border border-primary rounded-lg ml-3"></p>
    <p>To remove a course from the study plan, simply drag it to the red garbage bin that appears on dragging</p>

    <h3>Layers within a study line</h3>
    To add a course to a new layer within a studyline, drag it to the bottom of the study line. There are small slots shown there, which
    will fully open when the course is dragged over them
    <p><img src="img/Studyplan-draglayers.png" class="border border-primary rounded-lg ml-3"></p>

    <a id="periods"><h2>Configuring periods</h2></a>
    All periods in the study plan will have a label showing the timing and it's short name directly above their course columns in the 
        timeline. Upon hovering over the short name, it's full name will appear.<br>
        Also, the period matching the current date, will be highlighted in the color
        indicated by the <pre style="display:inline;">--highlight</pre> css variable, which corresponds to the
        value of the <pre style="display:inline;">--info</pre> color by default.
    <p></p>
    
    <p><img src="img/Periods-in-plan.png" class="border border-primary rounded-lg ml-3"></p>
    <p><img src="img/Period-hover.png" class="border border-primary rounded-lg ml-3"></p>
    <p> At the start, the periods start and end times will be naively selected by splitting the study plan's duration among the number of periods.<br>
        By clicking on the <i class="text-primary fa fa-pencil"></i> icon, you can open the edit screen and change the period's <i>full name</i>, 
        <i>short name</i>, <i>start time</i> and <i>end time</i>
    </p>
    <p><img src="img/Period-edit.png" class="border border-primary rounded-lg ml-3"></p>
    <p></p>
    <div class="generalbox alert alert-success"><b>TIP:</b><br>
        Before you start dragging courses into a studyplan page, make sure you have the periods configured correctly.
    </div>

    <a id="studycourses"><h2>Configuring courses</h2></a>
    <p>Once a course is added to the studyplan, an icon shows if it needs to be configured (<i class='fa fa-exclamation-circle text-warning'></i>) or 
        is already configured (<i class='fa fa-check text-success'></i>).</p>
    <p>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:</p>
    <h3>Moodle course completion</h3>
    <p>When using moodle course completion as a base, all configuration is done in the <i>course's completion settings</i>. 
        The course details show a <i class='fa fa-gear primary'></i> 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</p>
    <p><img src="img/Course-config-corecompletion.png" class="border border-primary rounded-lg ml-3"></p>

    <h3>Manual: Completed + required goals</h3>
    <p> 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 <i>required</i>. 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</p>
    <p><img src="img/Course-config-bistate.png" class="border border-primary rounded-lg ml-3"></p>

    <h3>Course start and end times</h3>
    <p> Often, the course will have their start and end times configured differently than the period you drop them in. If this is the case,
        a screen will appear asking if you want to update the course's start and end times. The time details of both course and period will
        be shown for your comparison. By clicking <button class="btn btn-danger">Yes</button>, the course's start and end times will be 
        updated to those of the period. Any activity dates set will be adjusted according to the changed start date.</p>
    <p><img src="img/Course-timing-mismatch-screen.png" class="border border-primary rounded-lg ml-3"></p>
    <div class="generalbox alert alert-info"><b>NOTE:</b><br>
        <p> If you do not change the course start and end times at this moment, you always have the opportunity later on
        by clicking the <i class="fa fa-calendar-times-o"></i> icon in the course detail screen. (As seen in the screenshot below).</p>
        <p> This icon will be <i class="fa fa-calendar text-success"></i> (color <i>--success</i>) to indicate if the course timing matches
            period timing. If not, it is shown as <i class="fa fa-calendar-times-o text-warning"></i> (color <i>--warning</i>)</p>
    </div>

    <h3>Courses spanning multiple periods</h3>
    <p> If a course should span multiple periods, you can specify this in the course detail screen.<br>
        On the top right of the course details screen you can select the desired period span of this course.
        Do note however, that the available spans are limited by the available space to the right of the course in the studyplan</p>
    <p><img src="img/Course-timing-indicators.png" class="border border-primary rounded-lg ml-3"></p>
    <p> Upon selecting the span you want, the course display will immediately be updated to reflect the changes.<br>
        immediately after this, you will see the screen asking if you want to change the course start and end times to reflect the 
        new period span.</p>

    <a id="studybadges"><h2>Adding badges</h2></a>
    <p>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.</p>
    <p>When you click on the <i class="fa fa-gear"></i> icon in the badge it shows you additional information about the badge</p>
    <p><img src="img/Toolbox-badges.png" class="border border-primary rounded-lg ml-3"></p>
    <a id="flow"><h2>Drawing the flow</h2></a>
    <p>You can draw arrows between the courses and add flow indicators to show students how different courses are related in the studyplan</p>
    <div class="generalbox alert alert-success"><b>TIP:</b><br>
        While there are many possible relations between courses, it is best to limit the arrows to the most obvious relations. The studyplan can 
        easily become too crowded to give a good overview. Use <i>junctions</i> to combine multiple arrows into one if you do need to show the relation
        from many courses to a few.</div>
    <h3>Drawing arrows</h3>
    <p> You can draw arrows by dragging them from one course or flow indicator to another. Look for the green square on the right of the item.
        Then click and hold to drag the arrow. Once you do, a red square will appear on all the items that the arrow can end on. Drop the end of the arrow
        on one of those red squares to complete the arrow.
    </p>
    <p><img src="img/Arrows-drag.png" class="border border-primary rounded-lg ml-3"></p>
    <h3>Removing arrows</h3>
    <p> To remove an arrow, click on the green square where the arrow starts. A red <i class='fa fa-trash text-danger'></i> trash can icon will appear for 
        each line that starts there. Hover over the trash can icons to find the line you want to remove. The arrow for each trash can icon will be  highlighted in red
        once you hover over it with your cursor. Once you find the arrow you want to remove, click the trash icon.</p>
    <p> To close the trash icon menu without removing an arrow, click the green square (now red) again.</p>
    <p><img src="img/Arrows-delete.png" class="border border-primary rounded-lg ml-3"></p>
    <h3>Adding flow indicators</h3>
    <p> You can add the following flow indicators:</p>
        <ul>
            <li><b>Junction</b> Used to combine the results of multiple arrows. The color and resulting arrow will be based on the combination of the incoming arrows</li>
            <li><b>Finish</b> Used to indicate the end of a study line. It's color is based on the combination of the incoming arrows, just like the junction </li>
            <li><b>Start/continue</b> These indicators are always green and can be used to indicate the start of a series of courses</li>
        </ul>
    <p><img src="img/Toolbox-flow.png" class="border border-primary rounded-lg ml-3"></p>
        <p> By clicking on the <i class="fa fa-gear"></i> 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</p>
    <ul>
        <li><b>All entries</b></li>
        <li><b>2/3 of entries</b></li>
        <li><b>Half of entries</b></li>
        <li><b>All entries</b></li>
    </ul>
    <div class="generalbox alert alert-info"><b>NOTE:</b><br>
        Using the <i>Manual</i> aggregation method, these conditions are also used to determine whether a junction or finish will be shown as <i>good</i> or <i>excellent</i>
        In those cases, at least the specified number of arrows need to be  <i>good</i> or <i>excellent</i> in order to color the indicator as such.</div>
    <h2>Associating students with a studyplan</h2>
    <p>You can associate users with the studyplan in two ways: <b>Individually</b> or by <b>cohort</b></p>
    <p>The recommended way is association by cohort, since that allows to dynamically allocate users to courses and studyplans by allocatong them to cohorts.
        Assigning students to a studyplan individually is only useful in some fringe cases.
    </p>
    <p>To edit associations, click on the <span class="text-primary"><i class="fa fa-users"></i> associations</span> link in the studyplan, 
        or click on the <i class="fa fa-users text-primary"></i> icon in the studyplan overview.</p>
    <p>You will now get the association window</p>
    <p><img src="img/Cohort-link.png" class="border border-primary rounded-lg ml-3"></p>
    <p>In this window, type the first few letters of the <i>cohort</i>i> you want to link into the search bar. The matching cohorts will now be shown.</p>
    <p>Click <button type="button" class="btn btn-success"><i class="fa fa-link"></i>&nbsp;Add</button> to add the cohort to the studyplan</p>
    <p>To remove a cohort from the studyplan, select it from the left list, and click <button type="button" class="btn btn-danger"><i class="fa fa-chain-broken"></i>&nbsp;Delete</button>
    </p>
    <p>In order to link <i>individual students</i>, click <i>students</i> and follow the same procedure as lined out above for cohorts.</p>

    <div class="generalbox alert alert-warning"><b>IMPORTANT:</b><br>
        <p>If you have cascading cohort sync enabled (see configuration), the system will automatically 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.
        </p>
        <p>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>
    </div>
    

</div>