Skip to content

Commit

Permalink
Merge pull request #12 from somiaj/instructor-help-update
Browse files Browse the repository at this point in the history
Updates to InstructorSendEmail help.
  • Loading branch information
drgrice1 authored May 25, 2023
2 parents 42c9de7 + 68863b4 commit 111177a
Showing 1 changed file with 35 additions and 11 deletions.
46 changes: 35 additions & 11 deletions templates/HelpFiles/InstructorSendMail.html.ep
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,43 @@
% title maketext('Email Help');
%
<p>
<%= maketext('Emails can be sent from this page to the class. Be sure to change all blanks which read "fixme". The '
. 'email can be sent to all students, or some subset. To change the way the students are ordered, after '
. 'selecting the criteria, push the "Change Display Settings" button.') =%>
<%= maketext('Use this page to send emails to active (enrolled or auditing) students. Emails can be sent to '
. 'all active students or selected students. Use the "Students" form to sort, filter, or format how '
. 'the user name is displayed. Click "Change Display Settings" to apply any changes. Use control-click '
. 'or shift-click to select multiple students to email.') =%>
</p>
<p>
<%= maketext('Personalized data can be inserted into the message using any of the variables available in the drop '
. 'down menu titled "list of insertable macros". Most of the personal data does not need a merge file, but if '
. 'you wish to include scoring data, you must select that scoring file as the merge file, and then enter the '
. 'score into the message by using what ever column the score is in. For example, if the scores where in the '
. '4th column of s0scr.cvs then I would set the merge file to that file, and then type $COL~[4~] to have that '
. 'be the score.') =%>
<%= maketext('Emails can contain personalized data, such as name, section, or status. Click "List of insertable '
. 'macros" for a full list available variables. Additional personal data can be included by using a merge '
. 'file. A merge file is a CSV file located in the ~[Scoring~] directory in which the first column is the '
. 'student id, followed by additional data (such as student grades). This data is identified by which '
. 'column it is in, for instance if the scores where in the 4th column of the merge file, insert them into '
. 'an email using the variable $COL~[4~]. The "Scoring Tools" page can export grades into a CSV that can be '
. 'used as a merge file. Upload customized merge files with the "File Manager".') =%>
</p>
<p>
<%= maketext('Use the "Merge file" drop down menu to select which merge file to use, or select "None" to not '
. 'use any merge file. When a merge file is selected, the data for active students will be displayed '
. 'above the "Email Body". This will show you the structure of the merge file and the column variables '
. 'associated with each column. Data that is longer than 7 characters will be truncated, and the data can '
. 'be scrolled up and down to see all rows.') =%>
</p>
<p> <%= maketext('Preview the message before sending using the "Preview Message" button. The preview shows the '
. 'email that would be sent to the first selected student or the instructor if no students were selected. '
. 'The preview will also list all of the students that would receive their own personalized message. If a '
. 'merge file was selected, the preview will also indicate which (if any) recipient\'s merge file data '
. 'could not be found.') =%>
</p>
<p>
<%= maketext('Messages can be saved to a message file (which must end in the ".msg" extension). Use the '
. '"Message file" drop down menu to select which message file to load, or "None" to use a blank message. '
. 'To save a new message, use the "Save as" button after entering in a valid filename. The "Save as" '
. 'button will not overwrite currently saved messages. To edit a currently saved message first select it '
. 'using the drop down menu, then click the "Save" button to save any changes. Use the "File Manager" to '
. 'delete messages, located in the "~[TMPL~]/email" directory.') =%>
</p>
<p class="mb-0">
<%= maketext('The size of the email box can be changed by changing the numbers in the "columns" and "rows" boxes '
. 'and pressing enter.') =%>
<%= maketext('When the message is ready to send, click "Send Email". This will queue the email to be sent, which '
. 'can take several minutes depending on the number of students selected. You will be notified by email '
. 'once all the emails have been sent.') =%>
</p>

0 comments on commit 111177a

Please sign in to comment.