{"id":19592086,"url":"https://github.com/catalyst/moodle-tool_broadcast","last_synced_at":"2025-04-23T04:53:11.354Z","repository":{"id":47064930,"uuid":"268181642","full_name":"catalyst/moodle-tool_broadcast","owner":"catalyst","description":" Broadcast message plugin for the Moodle LMS ","archived":false,"fork":false,"pushed_at":"2021-09-23T05:12:22.000Z","size":484,"stargazers_count":3,"open_issues_count":12,"forks_count":2,"subscribers_count":19,"default_branch":"MOODLE_39_STABLE","last_synced_at":"2025-04-23T04:53:05.444Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/catalyst.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-05-31T00:18:34.000Z","updated_at":"2023-08-17T18:51:42.000Z","dependencies_parsed_at":"2022-09-11T07:10:54.956Z","dependency_job_id":null,"html_url":"https://github.com/catalyst/moodle-tool_broadcast","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catalyst%2Fmoodle-tool_broadcast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catalyst%2Fmoodle-tool_broadcast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catalyst%2Fmoodle-tool_broadcast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/catalyst%2Fmoodle-tool_broadcast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/catalyst","download_url":"https://codeload.github.com/catalyst/moodle-tool_broadcast/tar.gz/refs/heads/MOODLE_39_STABLE","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250372946,"owners_count":21419722,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-11T08:33:03.893Z","updated_at":"2025-04-23T04:53:11.337Z","avatar_url":"https://github.com/catalyst.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Build Status](https://github.com/catalyst/moodle-tool_broadcast/actions/workflows/moodle-ci.yml/badge.svg?branch=master)\n\n# Broadcast message #\n\nThis plugin allows sending of broadcast messages to users.\n\n## Supported Moodle Versions\n\nThis plugin currently supports and is tested against the following versions of Moodle:\n\n| Moodle version     | Branch      |\n| ----------------- | ----------- |\n| Moodle 3.9 to 3.10 | MOODLE_39_STABLE |\n| Moodle 3.11 | MOODLE_311_STABLE |\n\n## Installation\n\nYou can install this plugin from the plugin directory or get the latest version\non GitHub.\n\n```bash\ngit clone -b \u003cbranch\u003e https://github.com/catalyst/moodle-tool_broadcast admin/tool/broadcast\n```\n\n# Using the plugin\n\nThe following sections outline how to use the plugin.\n\n## Creating a broadcast\n\nThe following outlines how to create a broadcast message for students.\n\n1. Once the plugin is installed log into Moodle as an administrator.\n2. Navigate to: *Site administration \u003e Broadcast Message \u003e Manage broadcasts*.\n3. Click on the *Add new broadcast* button. You will then be presented with a modal window form to create the broadcast.\n\n![create modal](/pix/create_modal.png?raw=true)\n\n4. Fill out the *broadcast title* and the *broadcast message* which will be displayed to users.\n5. Choose the scope of where you want the message to appear, either: *Site*, *Category* or *Course*. These are the contexts that you want the message to appear in. The message will display in that context and **all contexts below**. For example, a message defined at category level will appear in all courses in that category; a message defined at course level will appear in all activities in that course and a message at site level will appear everywhere.\n6. Choose the *Active from* and *Expiry* dates and times for the broadcast. The message will only display to users between those times.\n7. Select if you want the message to only apply to logged in users. When enabled only users who are logged in at the time of the message becoming active will see the message.\n8. Click the *Create broadcast* button. The broadcast details will show in the summary table on the manage broadcasts screen.\n\n![broadcast table](/pix/broadcast_table.png?raw=true)\n\nThe broadcast summary table provides details on the broadcasts for the system. It also includes the ability to edit, copy, and delete the broadcast. A report showing which users have acknowledged the broadcast can also be accessed for each broadcast from this table.\n\n## Editing a broadcast\n\nTo edit a broadcast message:\n\n1. Navigate to: *Site administration \u003e Broadcast Message \u003e Manage broadcasts*.\n2. From the broadcast summary table click the *edit* (cog) icon on the table row that corresponds to the broadcast you want to edit.\n\n![actions](/pix/actions.png?raw=true)\n\n3. The edit broadcast modal window form is displayed.\n4. Change any or all of the details of the broadcast.\n5. Click the *Update broadcast* button.\n6. The broadcast summary table will show the updated broadcast details.\n\n## Copying a broadcast\n\nTo copy a broadcast message:\n\n1. Navigate to: *Site administration \u003e Broadcast Message \u003e Manage broadcasts*.\n2. From the broadcast summary table click the *copy* (two pages) icon on the table row that corresponds to the broadcast you want to copy.\n\n![actions](/pix/actions.png?raw=true)\n\n3. The copy broadcast modal window form is displayed.\n4. Change any or all of the details of the broadcast.\n5. Click the *Create broadcast* button.\n6. The broadcast summary table will show the new copied broadcast details.\n\n## Viewing the Broadcast acknowledgement report\n\nWhen a user acknowledges a broadcast message a record is kept of where the user saw the message, the user that acknowledged the message and the time that it was acknowledged. These details can be viewed for every broadcast in the *Broadcast acknowledgement* report.\n\n![acknowledgement report](/pix/ack_report.png?raw=true)\n\nThere are two ways to view the Broadcast acknowledgement report. The first way is from the broadcast summary table. The second is via the site administration menu.\n\nTo view the Broadcast acknowledgement report from the broadcast summary table:\n\n1. Navigate to: *Site administration \u003e Broadcast Message \u003e Manage broadcasts*.\n2. From the broadcast summary table click the *report* icon on the table row that corresponds to the broadcast you want to view the report for.\n\n![actions](/pix/actions.png?raw=true)\n\n3. The Broadcast acknowledgement report will be displayed.\n\nTo view the Broadcast acknowledgement report directly:\n\n1. Navigate to: *Site administration \u003e Reports \u003e Broadcast acknowledgement*.\n2. The Broadcast acknowledgement report will be displayed.\n\n# User Broadcast display\n\nBroadcast messages are displayed to users as a modal window. With an acknowledgement button.\n\n![actions](/pix/broadcast_modal.png?raw=true)\n\nIt doesn't matter how a user closes a broadcast modal (clicking escape etc.). All actions that close the modal count as an acknowledgement. All user acknowledgements are recorded and displayed in the report.\n\n# Crafted by Catalyst IT\n\nThis plugin was developed by Catalyst IT Australia:\n\nhttps://www.catalyst-au.net/\n\n![Catalyst IT](/pix/catalyst-logo.png?raw=true)\n\n# Contributing and Support\n\nIssues, and pull requests using github are welcome and encouraged! \n\nhttps://github.com/catalyst/moodle-tool_broadcast/issues\n\nIf you would like commercial support or would like to sponsor additional improvements\nto this plugin please contact us:\n\nhttps://www.catalyst-au.net/contact-us\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatalyst%2Fmoodle-tool_broadcast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcatalyst%2Fmoodle-tool_broadcast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcatalyst%2Fmoodle-tool_broadcast/lists"}