Installation

Requirements#

• Omeka S 3.x or 4.x
• PHP 8.1 or later
• MySQL or MariaDB (any version supported by Omeka S)

The module has no external PHP dependencies. It stores its data in one database table and does not add a Doctrine entity, so it has no effect on Omeka's schema cache.

Installing#

1. Copy the PageVersioning folder into your Omeka S modules/ directory so that the path is modules/PageVersioning/.
2. Log in to the Omeka S admin panel as a Global Administrator.
3. Go to Admin > Modules and click Install next to PageVersioning.

Installation creates the page_versions table and sets the retention limit to its default of 50 versions per page. Capture starts immediately: the next time any site page is created or saved, a version is recorded.

After installing, a Page Versioning entry appears in the admin sidebar, a Version history button appears on every page edit screen, and a version history icon appears on each row of a site's pages list. See Viewing Version History.

Versions are only recorded for saves made after the module is installed. Pages that existed before installation have no history until they are saved again.

Upgrading#

1. Replace the modules/PageVersioning folder with the new version.
2. Go to Admin > Modules. If the module shows an Upgrade button, click it.

The module has no upgrade migrations; the page_versions table and your retention setting are kept as they are.

Uninstalling#

Go to Admin > Modules and click Uninstall next to PageVersioning.

Uninstalling runs DROP TABLE IF EXISTS page_versions, which permanently deletes every stored version for every page, and removes the page_versioning_retention setting. The site pages themselves are not touched. Export any versions you want to keep first (see Exporting and Deleting Versions).

If the module cannot be uninstalled from the admin panel, drop the table manually and remove the module directory:

DROP TABLE IF EXISTS page_versions;