Diary: Difference between revisions

From MoodleDocs
(Updated activity settings explanations.)
(One intermediate revision by the same user not shown)
Line 7: Line 7:
|float = right
|float = right
}}
}}
Diary is based off the Journal plugin. The Diary module allows a teacher to collect online text, audio, and video from a user. Depending on the Diary setup options, a user can create a new entry each calendar day or even each minute. Each entry can be individually reviewed, provided with feedback, and graded, with overall rating results being shown based on the selected aggregate type of rating. Currently, the user can edit any entry, and can even create a new entry for a skipped day. The data submitted by a student is visible only to the teacher, course manager, or site admin, and not to the other users in the course.
Diary is based off the Journal plugin with a lot of extra capabilities, one such being by date released writing prompts. The Diary module allows a teacher to collect online text, audio, and video from a user. Depending on the Diary setup options, a user can create a new entry each calendar day or even each minute. Each entry can be individually reviewed, provided with feedback, and graded, with overall rating results being shown based on the selected aggregate type of rating. Currently, the user can edit any entry, and can even create a new entry for a skipped day. The data submitted by a student is visible only to the teacher, course manager, or site admin, and not to the other users in the course.
==Purpose==
==Purpose==
Like the Journal, the Diary module is suitable for short, online writing assignments in which users can refine their entries over time, based on feedback from the marker. Unlike the Journal however, the Diary can start a new entry for any calendar day, hour or minute. This helps prevent the 'scroll of death' for markers as they see only one entry from each user at the same time on one page. If needed, markers can look at ALL the entries for any single user, and add ratings and feedback to individual entries. Using visible or separate groups also helps cut down on the 'scroll of death' for markers. With all the new tools available in the Atto and Tiny MCE editors, a diary entry can also include audio and video recordings. Feedback can be a simple numerical rating along with text, or autorating info can be added at the push of a button, The use of the rubric or marking guide is not supported.
Like the Journal, the Diary module is suitable for short to long, or multiple, online writing assignments in which users can refine their entries over time, based on feedback from the marker. Unlike the Journal however, the Diary can start a new entry for any calendar day, hour or minute. This helps prevent the 'scroll of death' for markers as they see only one entry from each user at the same time on one page. If needed, markers can look at ALL the entries for any single user, and add ratings and feedback to individual entries. Using visible or separate groups also helps cut down on the 'scroll of death' for markers. With all the new tools available in the Atto and Tiny MCE editors, a diary entry can also include audio and video recordings. Feedback can be a simple numerical rating along with text, or autorating info can be added at the push of a button, The use of the rubric or marking guide is not supported.
==Activity Setup==
==Activity Setup==
# Login and navigate to your Moodle course.
In any course, the teacher can add one, or more, Diary activities. If so desired, the teacher can also set up a, Glossary of Common Errors, activity to use for automatic grading when students misuse words that are contained in the glossary. e.g. u instead of you or i instead of I. The amount to penalize for each misuse is in the activity settings. The teacher can also set up penalty points character, word, sentence, or paragraph counts. For each, they can set a minimum count, and a maximum count. The amount of penalty for each category can be set. During the activity setup, the teacher can make Diary act just like the Journal plugin, but honestly, why would you want too?
# Turn editing on.
 
# Go to the topic you would like to add a Diary activity to, then from the Add an activity drop down select, Diary, assuming your installation has the plugin installed.
* Login and navigate to your Moodle course.
# General - Diary name - Enter a suitable name, one that possibly reflects the purpose of the diary activity, such as, Daily Notes, or, Weekly Essay.
* Turn editing on.
# General - Diary description - Enter a suitable description or a prompt that tells students what's expected of them in regards to the Diary activity. Check the box for, Display description on course page, if desired.
* Go to the topic you would like to add a Diary activity to, then from the Add an activity drop down select, Diary, assuming your installation has the plugin installed.
# Availability - Days available - When the Course format is set to, Weekly format, you can set the Days available to the number of days you want. For other course formats, Always open, will be automatically set, and Days available will be hidden. The Days available the activity is actually open, depends up which week the activity is in. e.g. In the next week, if you create a diary with one day availability, it will be available to students only on Monday of next week.
 
# Availability - Open Time - When enabled, a date and time can be set and no entries can be made until the date and time have passed.
===== General - =====
# Availability - Close time - When enabled, a date and time can be set and no entries can be made once the date and time have passed.
 
# Availability - Edit all entries - When enabled users can edit ANY previous entry by clicking the pencil icon at the end of the Entry: title. When, disabled, the icon is hidden and editing previous days entries is not possible.
* Diary name - Enter a suitable name, one that possibly reflects the purpose of the diary activity, such as, Daily Notes, or, Weekly Essay.
# Availability - Edit entry dates - When enabled users can edit the date of entry. This makes it possible to "move" a previously created entry by changing the date/time of the entry. An entry for a missed day can be created changing the current date to the missing date.
* Diary description - Enter a suitable description or a prompt that tells students what's expected of them in regards to the Diary activity. Check the box for, Display description on course page, if desired.
# Appearance - There are two settings for the, entry/feedback and text, background colors. This makes it possible to color coordinate with your theme, OR set colors to make it easy to differentiate which Diary you are using.
 
# Appearance - Enable statistics - When enabled, all the new statistics will appear below each entry. When not enabled, they are hidden.
===== Availability =====
# Auto-rating - Enable automatic rating - When enabled, automatic rating information will appear below each entry. When not enabled, the information is hidden.
 
# Min/Max Counts - Add minimum, maximum, and percentage for characters, words, sentences and paragraphs. If left as a zero, the penalty is not applied.
* Days available - When the Course format is set to, Weekly format, you can set the Days available to the number of days you want. For other course formats, Always open, will be automatically set, and Days available will be hidden. The Days available the activity is actually open, depends up which week the activity is in. e.g. In the next week, if you create a diary with one day availability, it will be available to students only on Monday of next week.
# Ratings - Aggregate type - Select any one of the rating types you want to use, Average of ratings, Count of ratings, Maximum of ratings, Minimum of ratings, or Sum of ratings.
* Open Time - When enabled, a date and time can be set and no entries can be made until the date and time have passed.
# Ratings - Scale - Select a scale from the drop down and set the Maximum grade.
* Close time - When enabled, a date and time can be set and no entries can be made once the date and time have passed.
# Ratings - Grade to pass - Depending on the scale type, set an appropriate Grade to pass.
* Edit all entries - When enabled users can edit ANY previous entry by clicking the pencil icon at the end of the Entry: title. When, disabled, the icon is hidden and editing previous days entries is not possible.
# Select/set the remaining options, especially the, Group mode, if you have very many users. Also, be sure to set, Activity completion, if you are using it for the course.
* Edit entry dates - When enabled users can edit the date of entry. This makes it possible to "move" a previously created entry by changing the date/time of the entry. An entry for a missed day can be created changing the current date to the missing date.
# Click Save and display.
 
===== Appearance =====
 
* There are two settings for the, entry/feedback and text, background colors. This makes it possible to color coordinate with your theme, OR set colors to make it easy to differentiate which Diary you are using.
* Enable statistics - When enabled, all the new statistics will appear below each entry. When not enabled, they are hidden.
* Enable titles - Enable, or disable, requiring titles for each entry.
* Send email notifications to teachers - Enable or disable the capability to immediately send email notifications to teachers. i.e Ignore site edit time before emails are sent. This setting and the next one makes it possible for teachers to use a diary activity in a face-to-face or video conference course and provide and receive feedback right away, while the class is still in progress.
* Send email notifications to students - Enable or disable the capability to immediately send email notifications to students. i.e Ignore site edit time before emails are sent.
 
===== Auto-rating =====
 
* Enable automatic rating - When enabled, automatic rating information will appear below each entry. When not enabled, the information is hidden.
 
===== Min/Max counts =====
 
* Min/Max Counts - Add minimum, maximum, and percentage for characters, words, sentences and paragraphs. If left as a zero, the penalty is not applied.
 
===== Common Errors =====
 
* Glossary of errors - Choose the Glossary that contains a list of common errors. Each time one of the errors is found in the essay response, the specified penalty will be deducted from the student's rating for this entry.
* Penalty per error - Select the percentage of total rating that should be deducted for each error that is found in the response.
* Error matching behavior - This setting refines the matching behavior for entries in the Glossary of Common Errors.
 
===== Ratings =====
 
* Roles with permission to rate - Roles with permission to rate are roles with the capability moodle/rating:rate plus any activity-specific rating capabilities. You can give more roles permission to rate via the Page permissions.
* Aggregate type - Select any one of the rating types you want to use, Average of ratings, Count of ratings, Maximum of ratings, Minimum of ratings, or Sum of ratings.
* Scale - Select a scale from the drop down and set the Maximum grade.
* Grade category - This setting controls the category in which this activity's grades are placed in the gradebook.
* Grade to pass - This setting determines the minimum grade required to pass. The value is used in activity and course completion, and in the gradebook where pass grades are highlighted in green and fail grades in red.
 
===== Common module settings =====
 
* Availability - You have the choice to show and make the activity available to students on the course page, hide from students and make the activity not available ,on the course page, or make available but not show to students. You will then have to provide a link to the activity.
* Select/set the remaining options, especially the, Group mode, if you have very many users. Also, be sure to set, Activity completion, if you are using it for the course.
* Click Save and display.
==Tools==
==Tools==
Depending on the participates capabilities, various tools are available for real-time-use.
Depending on the participates capabilities, various tools are available for real-time-use.
Line 48: Line 83:
# Set date to start using prompt ID {$a} - Each time you create a prompt, you must define the time it will go into effect. By default, it is set to the current time of when you entered the prompt editor.
# Set date to start using prompt ID {$a} - Each time you create a prompt, you must define the time it will go into effect. By default, it is set to the current time of when you entered the prompt editor.
# Set date to stop using prompt ID {$a} - Each time you create a prompt, you must define the time it will cease to be in effect. By default, it is set to the current time of when you entered the prompt editor.
# Set date to stop using prompt ID {$a} - Each time you create a prompt, you must define the time it will cease to be in effect. By default, it is set to the current time of when you entered the prompt editor.
# Enter your writing prompt - In plain text, tell your students what they have to write about.
# Enter your writing prompt - In plain text, tell your students what they have to write about. You can create a template for guidance in the activity description or in a prompt.
# Background color for this prompt - Due to the possibility of having many different prompts, a background color can be added to make each different prompt stand out from the others. Enter as a Hex number or as a standard web color name. e.g. red, pink, yellow, lightblue, etc.
# Character count minimum - If set to zero, no penalty is applied, but for any positive integer, if the student writes fewer than that, the difference is used to calculate a possible penalty to subtract from the maximum score for the activity.
# Character count minimum - If set to zero, no penalty is applied, but for any positive integer, if the student writes fewer than that, the difference is used to calculate a possible penalty to subtract from the maximum score for the activity.
# Character count maximum - If set to zero, no penalty is applied, but for any positive integer, if the student writes more than that, the difference is used to calculate a possible penalty to subtract from the maximum score for the activity.
# Character count maximum - If set to zero, no penalty is applied, but for any positive integer, if the student writes more than that, the difference is used to calculate a possible penalty to subtract from the maximum score for the activity.

Revision as of 19:16, 24 April 2024

Diary is based off the Journal plugin with a lot of extra capabilities, one such being by date released writing prompts. The Diary module allows a teacher to collect online text, audio, and video from a user. Depending on the Diary setup options, a user can create a new entry each calendar day or even each minute. Each entry can be individually reviewed, provided with feedback, and graded, with overall rating results being shown based on the selected aggregate type of rating. Currently, the user can edit any entry, and can even create a new entry for a skipped day. The data submitted by a student is visible only to the teacher, course manager, or site admin, and not to the other users in the course.

Purpose

Like the Journal, the Diary module is suitable for short to long, or multiple, online writing assignments in which users can refine their entries over time, based on feedback from the marker. Unlike the Journal however, the Diary can start a new entry for any calendar day, hour or minute. This helps prevent the 'scroll of death' for markers as they see only one entry from each user at the same time on one page. If needed, markers can look at ALL the entries for any single user, and add ratings and feedback to individual entries. Using visible or separate groups also helps cut down on the 'scroll of death' for markers. With all the new tools available in the Atto and Tiny MCE editors, a diary entry can also include audio and video recordings. Feedback can be a simple numerical rating along with text, or autorating info can be added at the push of a button, The use of the rubric or marking guide is not supported.

Activity Setup

In any course, the teacher can add one, or more, Diary activities. If so desired, the teacher can also set up a, Glossary of Common Errors, activity to use for automatic grading when students misuse words that are contained in the glossary. e.g. u instead of you or i instead of I. The amount to penalize for each misuse is in the activity settings. The teacher can also set up penalty points character, word, sentence, or paragraph counts. For each, they can set a minimum count, and a maximum count. The amount of penalty for each category can be set. During the activity setup, the teacher can make Diary act just like the Journal plugin, but honestly, why would you want too?

  • Login and navigate to your Moodle course.
  • Turn editing on.
  • Go to the topic you would like to add a Diary activity to, then from the Add an activity drop down select, Diary, assuming your installation has the plugin installed.
General -
  • Diary name - Enter a suitable name, one that possibly reflects the purpose of the diary activity, such as, Daily Notes, or, Weekly Essay.
  • Diary description - Enter a suitable description or a prompt that tells students what's expected of them in regards to the Diary activity. Check the box for, Display description on course page, if desired.
Availability
  • Days available - When the Course format is set to, Weekly format, you can set the Days available to the number of days you want. For other course formats, Always open, will be automatically set, and Days available will be hidden. The Days available the activity is actually open, depends up which week the activity is in. e.g. In the next week, if you create a diary with one day availability, it will be available to students only on Monday of next week.
  • Open Time - When enabled, a date and time can be set and no entries can be made until the date and time have passed.
  • Close time - When enabled, a date and time can be set and no entries can be made once the date and time have passed.
  • Edit all entries - When enabled users can edit ANY previous entry by clicking the pencil icon at the end of the Entry: title. When, disabled, the icon is hidden and editing previous days entries is not possible.
  • Edit entry dates - When enabled users can edit the date of entry. This makes it possible to "move" a previously created entry by changing the date/time of the entry. An entry for a missed day can be created changing the current date to the missing date.
Appearance
  • There are two settings for the, entry/feedback and text, background colors. This makes it possible to color coordinate with your theme, OR set colors to make it easy to differentiate which Diary you are using.
  • Enable statistics - When enabled, all the new statistics will appear below each entry. When not enabled, they are hidden.
  • Enable titles - Enable, or disable, requiring titles for each entry.
  • Send email notifications to teachers - Enable or disable the capability to immediately send email notifications to teachers. i.e Ignore site edit time before emails are sent. This setting and the next one makes it possible for teachers to use a diary activity in a face-to-face or video conference course and provide and receive feedback right away, while the class is still in progress.
  • Send email notifications to students - Enable or disable the capability to immediately send email notifications to students. i.e Ignore site edit time before emails are sent.
Auto-rating
  • Enable automatic rating - When enabled, automatic rating information will appear below each entry. When not enabled, the information is hidden.
Min/Max counts
  • Min/Max Counts - Add minimum, maximum, and percentage for characters, words, sentences and paragraphs. If left as a zero, the penalty is not applied.
Common Errors
  • Glossary of errors - Choose the Glossary that contains a list of common errors. Each time one of the errors is found in the essay response, the specified penalty will be deducted from the student's rating for this entry.
  • Penalty per error - Select the percentage of total rating that should be deducted for each error that is found in the response.
  • Error matching behavior - This setting refines the matching behavior for entries in the Glossary of Common Errors.
Ratings
  • Roles with permission to rate - Roles with permission to rate are roles with the capability moodle/rating:rate plus any activity-specific rating capabilities. You can give more roles permission to rate via the Page permissions.
  • Aggregate type - Select any one of the rating types you want to use, Average of ratings, Count of ratings, Maximum of ratings, Minimum of ratings, or Sum of ratings.
  • Scale - Select a scale from the drop down and set the Maximum grade.
  • Grade category - This setting controls the category in which this activity's grades are placed in the gradebook.
  • Grade to pass - This setting determines the minimum grade required to pass. The value is used in activity and course completion, and in the gradebook where pass grades are highlighted in green and fail grades in red.
Common module settings
  • Availability - You have the choice to show and make the activity available to students on the course page, hide from students and make the activity not available ,on the course page, or make available but not show to students. You will then have to provide a link to the activity.
  • Select/set the remaining options, especially the, Group mode, if you have very many users. Also, be sure to set, Activity completion, if you are using it for the course.
  • Click Save and display.

Tools

Depending on the participates capabilities, various tools are available for real-time-use.

Activity tools

When a teacher or admin is on the view page using the Boost theme, the following standard items are shown directly under the Diary name:

  1. Diary - A link that will reload the current diary activity.
  2. Settings - A link to the current activity settings page.
  3. Diary writing prompts - A link to the prompt edit page. Teachers and admins can create, edit, and delete prompts on this page.
  4. Journal to Diary xfr - Visible to admin only - A capability that lets an admin transfer all the user entries from a Journal to a Diary. Includes options to send the user an email and to also add a note in the Diary feedback regarding the transfer.
  5. More

Clicking the More options will show the following options:

  1. Filters
  2. Permissions
  3. Backup
  4. Restore

Writing Prompt Editor

Clicking the, Diary writing prompts, will take teachers and admins to the, Writing Prompt Editor. On the first visit, the table of prompts should be empty and showing, Currently, there are, 0 prompts for this Diary activity. When visiting this page, by default the editor is always set up to edit the most recent, or last prompt. In this case, because there are no prompts yet, it is set up to let you enter your first prompt so there are going to be some variable names in view simply because there is no data for them to display yet.

  1. Set date to start using prompt ID {$a} - Each time you create a prompt, you must define the time it will go into effect. By default, it is set to the current time of when you entered the prompt editor.
  2. Set date to stop using prompt ID {$a} - Each time you create a prompt, you must define the time it will cease to be in effect. By default, it is set to the current time of when you entered the prompt editor.
  3. Enter your writing prompt - In plain text, tell your students what they have to write about. You can create a template for guidance in the activity description or in a prompt.
  4. Background color for this prompt - Due to the possibility of having many different prompts, a background color can be added to make each different prompt stand out from the others. Enter as a Hex number or as a standard web color name. e.g. red, pink, yellow, lightblue, etc.
  5. Character count minimum - If set to zero, no penalty is applied, but for any positive integer, if the student writes fewer than that, the difference is used to calculate a possible penalty to subtract from the maximum score for the activity.
  6. Character count maximum - If set to zero, no penalty is applied, but for any positive integer, if the student writes more than that, the difference is used to calculate a possible penalty to subtract from the maximum score for the activity.
  7. Character penalty per Min/Max count error - If set to zero, the Min and Max settings do not matter. However, if either one is a positive integer, and the student does not meet that setting requirement, this percentage is applied in calculating the possible penalty.
  8. Word, Sentence, and Paragraph counts, work the same as they do for character count.
  9. Save changes - Any changes you have made in the prompt editor, get saved to the current prompt. If it is the first prompt, then a new prompt is created. The page will automatically be reloaded with your new prompt in the prompt table list, and also in the editor. Notice that the list column of the prompt table, Edit, for each prompt it shows an edit and a delete icon. NOTE: Once a prompt has been used for a rating, it cannot be deleted!
  10. Cancel lets you, back out of the prompt editor without saving anything, and gracefully go back to the normal view page.
  11. Create new prompt - Adds a new empty prompt to the prompt table and presents you with an empty editor, ready for you to type a new prompt.
  12. Return to XXX - XXX will be replaced with the current diary name. The button is a link back to the normal diary view page. It allows you to go back without making any changes to the prompts.

Student tools

On the view page, above the first entry, there is a toolbar with the following:

  1. Export to .csv - A students export will contain only their entries from the current diary. A teachers export will contain all the entries from the current diary. An admins export will contain all entries from all diaries on the site.
  2. Reload and show from current to oldest diary entry - Reloads the view page and sets the, Sort order, From current diary entry to the first entry, for the current user, showing the number of entries selected in the, Entries per page: drop down.
  3. Edit top of the list - Open the diary entry at the top of the list for editing.
  4. From first diary entry to the latest entry - Reloads the view page, with the users very first diary entry at the top of the list of entries.
  5. Lowest rated entries - Reloads the view page, with the lowest rated diary entry at the top of the list of entries. Note: any unrated entry is considered lower than any entry with a numerical rating.
  6. Highest rated entries - Reloads the view page, with the highest rated diary entry at the top of the list of entries.
  7. Most recently modified entries - Reloads the view page, with the most recently edited diary entry at the top of the list of entries.

Teacher tools

On the report page, above the first entry there is a toolbar with the following:

  1. Export to .csv - A teachers export will contain all the entries from the current diary. An admins export will contain all entries from all diaries on the site.
  2. Reload and show from current to oldest diary entry - Reloads the report page, and shows the most current diary entry for each user with at least one entry.
  3. Current diary entries - Reloads the report page, and shows the most current diary entry for each user with at least one entry.
  4. First diary entries - Reloads the report page, and shows the first diary entry for each user with at least one entry.
  5. Lowest rated entries - Reloads the report page, and shows the diary entry with the lowest rating, for each user with at least one entry. Note: any unrated entry is considered lower than any entry with a numerical rating.
  6. Highest rated entries - Reloads the report page, and shows the diary entry with the highest rating, for each user with at least one entry.
  7. Most recently modified entries - Reloads the report page, and shows the most recently edited diary entry, for each user with at least one entry.

Also on the report page, next to the entry and date title for each student, there is now a link that will let the teacher see ALL the entries for a single student. From this new reportsingle page, the teacher can change/add grades and feedback to as many entries as they wish. A click on the, Save all feedback, button will save all changes and take the teacher back to the normal report page. Next to the, Save all feedback button, there is a, Return to report page for - Current Diary Name.

Setup a site wide Diary

One of the most versatile ways I have learned to use the Diary plugin for general use without ratings, especially on a development site, is to set it up for use throughout my whole Moodle site. The only downside is that you will need to install it on the site front page and when you do so you will need to change the, Locally assigned roles, to Student (student). With the role set this way, users can see all of their own entries and only an admin will be able to look at every entry for everyone. If you feel you need to, you can also add users with the manager and teacher roles.

   Install the Diary plugin.
   On the site front page add a, Main menu, block.
   In your new Main menu block, Add an activity or resource, then select Diary.
   Give it a name such as, Site Wide Diary.
   Add a Description, such as, A site wide diary for use by everyone.
   In the Diary settings, under Locally assigned roles, add everyone, except the admin, as a student.
   On the front page, in the Main menu block, click the edit icon and select, Configure Main menu block.
   In the settings, Where this block appears, change the, Page contexts to, Display throughout the entire site, then Save changes.

This should give everyone a link to the Site Wide Diary on every page of your Moodle site. If you want ANYONE to be able to see what the students have written, you will need to give them the Teacher role on the front page.

See also

  • Journal module - While the Journal module allows students/users to add text to one "entry", Diary moves one step further allowing students/users to add a new "entry" every new calendar day.