moodle_local_treestudyplan/doc/teacherview-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 " 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 active" 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>Teacher view for study plans</h2>
    <p>While students can only see their own results in a studyplan, teachers that have the right to see studyplans in a certain context can see more</p>
    <p>The teacherview shows teachers both <b>statistics</b> about the available grades as well as the results of <b>individual students</b> on request</p>
    <div class="generalbox alert alert-info"><b>NOTE:</b><br>
        <p>Because the teacherview collects a lot of data to generate the statistics, it can take a while for the teacher view to load.</p>
        <p>At the moment those statistics are not cached, but collected and calculated live on each request</p>
    </div>
    <h2>Overview of study plans</h2>
    <p>If a user has the permission <i>local/treestudyplan:viewuserrreport</i> they can see the link <b>Study plans</b> in a category view they have the permission,
        or (if the primary navigation is properly configured) in the primary navigation bar.</p>
    <p>Upon choosing the <b>Study plans</b> link the user is shown an overview of the studyplans availabel for viewing in the category selected.<br>
        (If no category is selected, the first available category where the user has the required permission will be shown.)</p>
    <p><img src="img/Teacherview-overview.png" class="border border-primary rounded-lg ml-3"></p>
    <p> In the top left drop-down menu the user can choose any other category with studyplans that they have permission for.</p>
    <p> The view shows info cards for each studyplans in relevant order: Current (blue), Past (purple) and  Future (grey), with colored bars indicating the timing status</p>
    <p> By clicking the info card's title or <b>open</b> button, the study plan is shown in detail (statistics view)</p>
    <div class="generalbox alert alert-success"><b>TIP:</b><br>
        <p>The colors can be tweaked by changing the  CSS vars <i>--past</i>, <i>--present</i> and <i>--future</i></p>
        <p>These same colors are also used to indicate the timing status of courses in the studyplan view itself</p>
    </div>
    
    <h2>Statistics view</h2>
    <p>The statistics view shows the studyplan in its entirety, but shows the completion statistics for each course or badge</p>
    <p><img src="img/Teacherview-statistics-badge-course.png" class="border border-primary rounded-lg ml-3"></p>
    <p>The completion circle shows the total completion by filling up the circle, but also shows you the amount of:
        <ul>
            <li class="font-weight-bold text-success">Passed criteria/activities</li>
            <li class="font-weight-bold text-info">Completed criteria</li>
            <li class="font-weight-bold text-danger">Failed criteria/activities</li>
            <li class="font-weight-bold text-warning">Ungraded activities</li>
        </ul>
        When there are activities that need grading, a center dot in the <b class="text-warning">warning</b> color appears as a signal.
    </p>
    <p>Badges will show a circle around them which fills up according to the number of students linked to the study plan who have achieved this badge</p>
    <p>The colored tabs in front of each course show if the course is currently given (blue), in the past (purple) or in the future (grey)</p>
    <p><img src="img/Teacherview-statistics.png" class="border border-primary rounded-lg ml-3"></p>
    <div class="generalbox alert alert-success"><b>TIP:</b><br>
        <p>The courses that a teacher is personally teaching are given a yellow highlight around them.<br>
        This helps teachers find their own courses more easily</p>
    </div>

    <h2>Course details</h2>
    <p>By clicking on the course title, the details view appears. Here all relevant criteria are shown</p>
    <p>Each criterium has a progress bar that shows the student progress. For activities, this progress bar uses the same color scheme as the completion circle
        to show the completion statistics for that requirement.
    </p>
    <p>By clicking on the <i class="s-required complete fa fa-question-circle"></i> icon, the specific requirements for the criterium are shown</p>
    <p><img src="img/Teacherview-course-corecompletion.png" class="border border-primary rounded-lg ml-3"></p>

    <h3>Course details when using manual studyplan aggregation</h3>
    <p>When using a manual aggregation method instead of the course completion method, the view is slightly different.</p>
    <p>Here, only the gradable activities for this course are shown.</p>
    <p><img src="img/Teacherview-course-manual.png" class="border border-primary rounded-lg ml-3"></p>
    
    <h2>Badge details</h2>
    <p>By clicking on the badge, more information about it are shown, like <b>description</b>, <b>award criteria</b> and a link to the <b>badge details</b> </p>
    <p> A progress bar is also shown, indicating how many students in the study plan have earned this badge</p>
    <p><img src="img/Teacherview-badgedetails.png" class="border border-primary rounded-lg ml-3"></p>

    <h2>Allowing teachers to select gradables in manual mode</h2>
    <p>When using a manual aggregation method, if a teacher has the permission <i>local/treestudyplan:selectowngradables</i> a gear icon is shown
    This allows the teacher to select which gradable activities are shown in the studyplan.</p>

    <h2>Viewing student studyplans</h2>
    <p> To view the results of individual students, the teacher can click on the <button class="btn btn-primary">View student plans</button> button</p>
    <p> This opens a drawer to the right of the screen, where the teacher can select any of the students linked to this study plan and view their results</p>
    <p>This view is identical to the view that the students themselves see when viewing their study plan.</p>
    <p><img src="img/Teacherview-choose-student.png" class="border border-primary rounded-lg ml-3"></p>
    <p>By selecting <button type="button" class="list-group-item list-group-item-primary list-group-item-action">Teacher view</button>, the teacher can 
        return to the teacher view</p>

</div>