--------------------------------------------------------------------- Contents i. PRELIMINARY INFO A. ONE TIME STEPS B. STEPS FOR EVERYTIME THE SCRIPT IS UPDATED C. HOW TO USE THE SCRIPT TO GENERATE THE MODERATION DOCUMENTS --- D. NOTES (FOR THOSE WHO WANT MORE DETAILS THAN THE SCRIPT DISPLAYS) E. TROUBLESHOOTING --------------------------------------------------------------------- i. PRELIMINARY INFO Along with this README.txt, the csmax596-moderation-docs.user.js script lives at https://trac.greenstone.org/browser/other-projects/csmax596/src . *No other contents* under https://trac.greenstone.org/browser/other-projects/csmax596/ are needed. The script performs fastest in the Chrome browser with the Tampermonkey extension, as explained below, but should also still work in Firefox (including with the GreaseMonkey extension). The installation steps are for TamperMonkey. There may be equivalent ones for enabling GreaseMonkey/Tamper Moneky extensions in Firefox. A. ONE TIME STEPS 1. Install Tampermonkey: Go to https://www.tampermonkey.net/index.php?browser=chrome and click on the tab to match your browser. Download and install. 2. You will need to enable userscripts in Chrome > press vertical dot-dot-dot ... > Extensions > Manage Extensions > turn on "Developer Mode" toggle top right. See https://www.tampermonkey.net/faq.php#Q209 3. Restart Chrome. 4. In Chrome, press the Extensions icon (the puzzle icon near the address bar) and choose Manage Extensions. Then click on the Details button of the TamperMonkey extension > turn on the Allow User Scripts toggle. B. STEPS FOR EVERY TIME THE SCRIPT IS UPDATED 5. Download the script from https://trac.greenstone.org/browser/other-projects/csmax596/src/csmax596-moderation-docs.user.js?format=txt Any updates will be available from this link also. Downloading the script *ought to* automatically install it. Check if it worked by clicking the puzzle-shaped Plugins/Extensions icon in the browser locaated near the address bar > left click Tamper Monkey > Dashboard. In the Dashboard window, the script CSMAX596-moodle-script should be listed and the Enabled toggle next to it should be toggled ON (indicated in green in Chrome). If in downloading the script TamperMoneky did not automatically install it into the browser's TamperMonkey extension, then: a. Open the downloaded script in a text editor and copy all the contents (Select All + Copy). It will now be in the copy buffer in memory. b. Install the script as follows: in Chrome, click on plugin/puzzle icon next to address bar > Tampermonkey > Create a new script c. Select all the placeholder content of the new script and press delete. d. You will have the custom 586 script copied into memory in step 4 (or else copy the script contents again following step 3b) and paste them into the Tampermonkey's empty script page. e. Press Ctrl+s to save the script. This script will now be available to you one tab over in TamperMonkey (tab "Installed Userscripts") where you can disable it if you ever find it annoying. You can also use this tab to replace the script contents with an updated script's contents whenever you need to, or edit the existing contents if you wish. C. HOW TO USE THE SCRIPT TO GENERATE THE MODERATION DOCUMENTS 6. Log into moodle and visit the CSMAX586 course then click on the "Grades" link (you're on the right page if the page's URL looks like https://elearn.waikato.ac.nz/grade/report/grader/index.php?id=SOME-NUMBERS). 7. The script will activate on the Grades page, thereby presenting you with ***A BIG RED BUTTON*** labelled "Generate CSMAX596 moderation docs". Press this button and follow the instructions that appear. --- D. NOTES These notes expand on the instructions the script will display or are more verbose and explicit. - If you're not merely testing out the script but mean to generate the final moderation documentation for a batch of CSMAX students, ensure all data has been entered as indicated in the instructions that appear when you press the big red button, so that you don't have to re-process student data again later. - REMAIN on the page while it's processing. It will take some minutes (3+ mins for 33 students on Chrome). An estimate for the remaining time in seconds will appear to the right of the progress bar after the first student's final report has been processed. In the background, the script loads each student's final report and industry evaluation report Moodle page and extracts the data from there for the student. If you leave the page at any point by visiting another browser tab, then Moodle fails to load the final report/industry eval page, so that the script will not be able to download that student's information. - The script will process a student only if it can successfully background-load both the Moodle grade tables on that student's final report and industry evaluation Moodle pages. If either the final report or industry evaluation grade table is not available for a student, or if either fails to load for any reason, that student will not be processed in the current batch. - There's a colour-coded progress bar where each cell indicates the status of processing for each student. The number of students to be processed in the current batch is determined by how many students in the course still need to be processed (the number that weren't already processed in a previous batch). Only those students that are successfully processed will be counted toward the current batch of processed students. Hover over the "Legend" link near the progress bar for an explanation of the colours used by the progress bar indicator: each cell in the progress bar represents the processing status of a student's data. The left half of a student's cell represents the final report data, the right half the industry evaluation data. Each half of a student's cell is green if the data for that half has been successfully (obtained and) processed. The half-cell is yellow if it is still being processed, and red if the script failed to obtain the data for that half-cell. - When processing is finished (indicated by all cells in the progress bar being now green or red), more buttons become available underneath the original red button. Click them from left to right to see print previews for each document, eyeballing the contents to check they're sensible, and save the printable document each time. - You may want to optionally choose to download the CSV spreadsheets that are linked below the row of buttons. If something went wrong, you will especially want to download the "Student moodle IDs with names". - Press the right most button *after* you have saved all the documents. It will do some background work and display some instructions you need to follow to check you have downloaded and done everything you need to for this batch. One of the crucial things this button does, is store a list of the current batch of processed students (it stores as a comment on Moodle, the IDs of all the students in the course which have been successfully processed by the script), so that they aren't reprocessed again in the next batch. This way, next time when you load the Grades page and press the big red button, you will only process the unprocessed students as part of the next batch. E. TROUBLESHOOTING - If for any reason you want to redo processing of *all* the students in the CSMAX596 course (including those you successfully processed in a previous session's batch), go to the Final Report moodle page of the 1st student of the course. It will contain a comment storing all the student IDs processed in past batches. Delete that comment, and you will be able to re-process all students again by visiting the Grades page and clicking the big red button. - The first step to troubleshooting is to ensure you're following all the instructions titled "Before you begin" that appear next to the big red button. If you don't carry out all those instructions, the script will fail or won't get all the student data you want it to. - When the script is running, you can press F12 to see the browser's Developer Tools window and go to the Console tab to see debugging messages that appear during processing. - As the instructions next to the big red button state: Ensure before starting, that on the Grades page, the "First name" and "Last name" filters are set to "All". Because if the filters are set to any letter, only students whose names are under that letter will be accessible to the script and get processed. And if there are no students under a currently selected letter filter, then the script will show that it's unable to retrieve data for any student in the course and assume this is because you don't have sufficient course permissions on Moodle to access student data and display an error message stating so. - If there are constantly errors in obtaining data (indicated in the progress bar showing all red cells and in the browser's Developers' Console tab consistently displaying error messages), this may be because your view of the Moodle pages' Grades tables is set to do some filtering. To fix this, visit a student's final report or industry eval grades rubrik and at the top * click the "Reset Table Preferences" link * and ensure filters are turned off by clicking the filter icon next to the "Reset Table Preferences" link and choosing "No filter" next to all dropdown menu options like "Filter" and "Workflow filter". * Reload the Grades page and press the big red button to restart processing again. ------------------------------ END OF FILE ----------------------------------