Requirements
- Omeka S 3.x or 4.x
- PHP 8.1 or later
- For email notifications only: a mail transport configured in Omeka S (
config/local.config.php) and Omeka's background jobs running
The module has no other dependencies.
Installing
- Copy the
Announcementsfolder into your Omeka Smodules/directory. - Sign in to the Omeka S admin as a Global Administrator.
- Go to Admin > Modules and click Install next to Announcements.
Installation creates four database tables (announcement, announcement_target_role, announcement_target_user and user_announcement) and two settings, then opens the module settings. The defaults (archive expired announcements, no automatic cleanup) are fine to start with; see Configuration.
From then on, every signed-in user sees a bell next to their name at the top of the admin, an Announcements entry in the sidebar that opens their inbox, and an Announcements panel on the dashboard. Supervisors and Global Administrators can send announcements from Announcements > All announcements.
Upgrading
Copy the new version over the existing modules/Announcements folder, then go to Admin > Modules and click Upgrade next to Announcements. Announcements, inboxes and settings are kept.
Upgrading from 1.0.x converts stored expiry dates to UTC, reading them in the installation's time zone (Admin > Settings > Time zone), which is how 1.1.0 and later store every time.
Uninstalling
Uninstalling drops the four tables, which permanently deletes every announcement and every user's inbox, and removes the module's settings and each user's Receive announcement emails preference.
If the module cannot be uninstalled from the admin, drop the tables by hand and remove the module folder:
DROP TABLE IF EXISTS user_announcement;
DROP TABLE IF EXISTS announcement_target_user;
DROP TABLE IF EXISTS announcement_target_role;
DROP TABLE IF EXISTS announcement;