Installation

Requirements#

• Omeka Classic 3.1 or later (tested with 3.2.2)
• PHP 8.1 or later
• MySQL or MariaDB (any version Omeka Classic supports)

The plugin has no external dependencies and loads nothing from a CDN. Batch rollback and pruning run as Omeka background jobs, so the PHP command-line path Omeka uses for its jobs must work for those two features. A single restore runs at once, in the request.

Installing#

1. Copy the ResourceVersioning folder into your Omeka Classic plugins/ directory.
2. Sign in to the admin as a super user.
3. Go to Plugins and click Install next to Resource Versioning.

Installing creates two tables, resource_versions (the history) and resource_version_runs (batch rollbacks and prunes run in the background), each with your installation's table prefix, and writes the default settings listed in Configuration. Existing records are not touched: the first time one of them is edited, its state before the edit is kept as a baseline version.

After installing:

• A Version History panel appears in the sidebar of every admin item, collection and file page.
• Resource Versions appears in the admin's main menu, at /admin/resource-versioning.
• Items, collections and files are all versioned. Nothing else needs setting up.

Upgrading#

Replace the plugins/ResourceVersioning folder with the new version, then visit Plugins. If Omeka offers an upgrade, click Upgrade. The history is kept.

Uninstalling#

Go to Plugins and click Uninstall next to Resource Versioning. Uninstalling:

• drops the resource_versions and resource_version_runs tables, which deletes the whole history for good, and
• removes the plugin's six resource_versioning_* settings.

Items, collections and files are not affected. Restores already made stay made: a restore is an ordinary save of the record.

To stop recording but keep the history, deactivate the plugin instead, or turn Record versions off in its settings.