View source for Proposals/Outcomes portfolio/Activity page infrastructure

<h2 id="activity-page-infrastructure">Activity page infrastructure</h2>
<p>[https://bugs.launchpad.net/mahara/+bug/1991604 Wishlist item]</p>
<h3 id="high-level-overview">High level overview</h3>
<ul>
<li>Add activity information to the page settings → Create a new portfolio page type</li>
<li>Pull in information from tables and people to auto-populate information</li>
<li>Display activity information set up on the page settings page</li>
<li>Update certain information directly while editing or viewing the activity page</li>
<li>Dealing with &#39;signing off&#39; / completing activities</li>
</ul>
<h3 id="details">Details</h3>
<h4 id="mock-up-reference-set-up-activity-page-group-tutor-and-group-admin-">Mock-up reference: &#39;Set up activity page – group tutor and group admin&#39;</h4>
<p><strong>Who?</strong> As group tutor or group admin...</p>
<p><strong>What?</strong> I want to set up activites for the group member...</p>
<p><strong>Why?</strong> So that all admin work is collected in one place and then available when I work with the group member on a particular activity.</p>
<p>The numbered list refers to the bullets in the mock-up &#39;Set up activity page – group tutors and group admin&#39;. This page is only accessible to group tutors and group admins. Students cannot get to it.</p>
[[File:Set up activity page - group tutors and group admins.png|frame|left]]
<ol>
<li>[no change] Page title: It&#39;s a short title of the activity to avoid that the heading of a page is longer than one line and therefore fits better into a navigation menu. This title is pulled into the outcomes overview page automatically. Mandatory field.</li>
<li>Activity information panel: automatically uncollapsed as information needs to be entered.</li>
<li>Activity description: Long title of the activity. Mandatory field.</li>
<li>Subject: Select list with hard-coded items (phase 1).</li>
<li>Responsible staff: Select list comprised of all group tutors and group admins from this group. The person filling in the form is automatically displayed as default choice.</li>
<li>Start date: Date picker.</li>
<li>End date: Date picker. Check that the end date is greater or equal to the start date.</li>
<li><p>Levels of achievement: Three single-line text entry fields. The fourth level is predefined. </p>
<ul>
<li>Icons are assigned automatically.</li>
<li>Level 1 is the highest achievement and level 4 the lowest.</li>
<li>Suggested icons: Font Awesome number corresponding to the level with a circle around it in primary theme link colour but with a new variable set up if a different colour should be used. This will need to be achieved with stacked icons, e.g.  icon-1 and icon-circle.</li>
<li>New table &#39;view_activity_achievement_levels&#39; with ID, view_activity_ID (i.e. the view ID), priority column (1-4), value and level 4 always being the same (via hidden value).</li>
</ul>
</li>
<li><p>Clicking &#39;Save&#39; takes you to the &#39;Edit&#39; screen of the activity page.</p>
</li>
</ol>
<blockquote>
<p>Notes: </p>
<ul>
<li>The page buttons have changed slightly in Mahara 22.10 and thus will be used instead of the ones pictured on the mock-up.</li>
<li>This settings page is only available to group tutors and group admins.</li>
<li>The rest of the page settings stay as they are in the &#39;Advanced&#39; panel.</li>
<li>&#39;Prevent removing of blocks&#39; in the &#39;Advanced&#39; panel is automatically set to &#39;Yes&#39; (see section &#39;Group changes&#39;) but can be changed to &#39;No&#39;.</li>
</ul>
</blockquote>
<h4 id="mock-up-reference-edit-activity-page-group-tutor-and-group-admin-">Mock-up reference: &#39;Edit activity page – group tutor and group admin&#39;</h4>
<p><strong>Who?</strong> As group tutor or group admin...</p>
<p><strong>What?</strong> I want to add content to the activity page...</p>
<p><strong>Why?</strong> To assist the learner with their evidence collection and mark checkpoints as completed to illustrate progress.</p>
<p>The numbered list refers to the bullets in the mock-up &#39;Edit activity page – group tutor and group admin&#39;. This page is accessible to group tutors, group admins, and learners.</p>
[[File:Edit activity page - group tutor and group admin.png|frame|left]]
<ol>
<li>&#39;Settings&#39; button: Available to group tutor and group admins to change information about the activity. It&#39;s not accessible to regular group members.</li>
<li><p>Activity information:</p>
<ul>
<li>is displayed at the top of the page and cannot be moved.</li>
<li>is displayed collapsed so that you only see the long-form activity, outcomes, outcome type, and whether the outcome has been achieved or not in the panel header.</li>
<li>is a full-page width block. → Change the default width of blocks in Mahara when they are put on a page into full-page width blocks</li>
</ul>
</li>
<li><p>Activity description: Long &#39;title&#39; of the activity.</p>
</li>
<li>Outcome: Short title of the outcome to which this activity belongs.</li>
<li>Outcome type: Pulled from the outcome, i.e. short name with the predefined background colour.</li>
<li><p>Achieved: Switch to decide whether an activity page has been achieved or not. This can always be changed. A modal is displayed to confirm the choice. Only the latest change to &#39;Yes&#39; will be recorded in the database.</p>
<ul>
<li>This uses the &#39;Sign-off&#39; block functionality as basis and makes the following change:</li>
<li>Change the &#39;Sign-off&#39; block to not be a block any more but make it a setting in the &#39;Advanced&#39; panel on the page settings screen so that the info is always displayed at the top right. → Sign-off/Verify gets a new template so that we can move it elsewhere if needed and the activity template includes the sign-off template which then is included in a page.</li>
<li>If a page is of the &#39;Activity&#39; type, automatically set &#39;Verified&#39; to &#39;No&#39; in the settings for the &#39;Sign-off&#39;.</li>
</ul>
</li>
<li><p>Responsible staff: Pulled from the activity setup.</p>
</li>
<li>Subject: Pulled from the activity setup.</li>
<li>Time frame: Start and end date from the activity setup combined.</li>
<li>Strategies and support: Editable field for group tutor and group admin. Similar to the &#39;Progress&#39; field on &#39;Outcomes&#39; (see section &#39;Outcomes overview page in progress – group tutors and group admin&#39;).</li>
<li>Resources: Editable field for group tutor and group admins. Similar to the &#39;Progress&#39; field on &#39;Outcomes&#39;.</li>
<li>Learner support: Editable field for group tutor and group admins. Similar to the &#39;Progress&#39; field on &#39;Outcomes&#39;.</li>
<li>[no change] Click the &#39;Add block&#39; button at the top right to add a checkpoint block or any other block onto the page below the activity information.</li>
</ol>
<p>Numbered items 14-20 are done as part of the &#39;Checkpoint block infrastructure&#39; (see that section for details).</p>
<h4 id="mock-up-reference-view-activity-page-not-achieved-group-tutor-and-group-admin-">Mock-up reference: &#39;View activity page, not achieved – group tutor and group admin&#39;</h4>
<p><strong>Who?</strong> As group tutor and group admin...</p>
<p><strong>What?</strong> I want to view a page in &#39;Display&#39; mode...</p>
<p><strong>Why?</strong> So that I can see the information how it is presented without all editing controls.</p>
<p>The numbered list refers to the bullets in the mock-up &#39;View activity page not achieved – group tutor and group admin&#39;.</p>
[[File:View activity page not achieved - group tutor and group admin.png|frame|left]]
<ol>
<li>Strategies and support, resources, and learner support can also be changed when viewing the page. Content is saved upon clicking the respective &#39;Save&#39; button. Browser modal to appear if content hasn&#39;t been saved yet before navigating away from the page.</li>
<li>Switch can be flipped to indicate the achievement status. A confirmation modal comes up when status is changed. It can be changed back to &#39;No&#39;. Record in the database only who changed the status when but don&#39;t display it on screen.</li>
<li>Set the achievement level with the drop-down menu. The help icon displays the long-form text for the levels. The menu itself only displays &#39;Level 1&#39;, &#39;Level 2&#39;, &#39;Level 3&#39;, and &#39;Level 4&#39;.</li>
</ol>
<h4 id="mock-up-reference-view-activity-page-achieved-group-tutor-and-group-admin-">Mock-up reference: &#39;View activity page, achieved – group tutor and group admin&#39;</h4>
[[File:View activity page achieved - group tutor and group admin.png|frame|left]]
<p><strong>Who?</strong> As group tutor and group admin...</p>
<p><strong>What?</strong> I want to be able to mark completed activities as achieved...</p>
<p><strong>Why?</strong> So that I don&#39;t have to go into &#39;Edit&#39; mode to do that.</p>
<p>The numbered list refers to the bullets in the mock-up &#39;View activity page achieved– group tutor and group admin&#39;. </p>
<ol>
<li>Strategies and support, resources, and learner support are locked in and can&#39;t be edited any more. The name of the person who edited the field last is displayed along with the date.</li>
<li>Switch can be flipped to indicate the achievement status. A confirmation modal comes up when status is changed. It can be changed back. Record in the database only who changed the status when.</li>
<li>Comments can still be added to checkpoints.</li>
</ol>
<h4 id="mock-up-reference-edit-activity-page-group-member-">Mock-up reference: &#39;Edit activity page – group member&#39;</h4>
[[File:Edit activity page - group member.png|frame|left]]
<p><strong>Who?</strong> As a group member...</p>
<p><strong>What?</strong> I want to see the requirements for a particular activity and add my learning evidence to the page...</p>
<p><strong>Why?</strong> So that I can demonstrate that I&#39;ve achieved a checkpoint and ultimately the activity.</p>
<p>The numbered list refers to the bullets in the mock-up &#39;Edit activity page – group member&#39;. This page is accessible to group tutors, group admins, and group members.</p>
<ol>
<li>Group members don&#39;t see all the buttons like group tutors and group admin do. They can&#39;t access the page settings nor can they give access to the portfolio.</li>
<li>Activity information is displayed at the top of the page below the page instructions and cannot be moved. It is displayed collapsed so that you only see the long-form activity, outcomes, outcome type, and whether the activity has been achieved or not.</li>
<li>Achieved: Group members can&#39;t flip the switch and thus only see the line icon.</li>
<li>[no change] Group members can add any number of blocks onto the page. They won&#39;t be able to delete them unless group tutors or group admins allow that on the page settings (that&#39;s the &#39;Prevent removing of blocks&#39; functionality).</li>
</ol>
<p>Done as part of the checkpoint block infrastructure:</p>
<ol>
<li>Group members cannot delete any comments. They can still edit a comment for 10 minutes after they made it or until someone posts another comments, whichever occurs first.</li>
</ol>
<h4 id="mock-up-reference-view-activity-page-not-achieved-group-member-and-view-activity-page-achieved-group-member-">Mock-up reference: &#39;View activity page not achieved – group member&#39; and &#39;View activity page achieved – group member&#39;</h4>
<p><strong>Who?</strong> As a group member...</p>
<p><strong>What?</strong> I want to view a page in &#39;Display&#39; mode...</p>
<p><strong>Why?</strong> So that I can see the information how it is presented without all editing controls.</p>
<p>This page is very similar to &#39;View activity page, achieved – group tutor and group admin&#39;, with the difference that group members see a line instead of a drop-down menu when a checkpoint or an activity hasn&#39;t been achieved yet.</p>
[[File:View activity page not achieved - group member.png|frame|left]]

[[File:View activity page achieved - group member.png|frame|left]]
<p>Comments on checkpoints:</p>
<ul>
<li>Can be made no matter whether the checkpoint has been achieved or not.</li>
<li>Group members cannot delete any comments. They can still edit a comment for 10 minutes after they made it or until someone posts another comments, whichever occurs first.</li>
</ul>