Getting Started Omeka S module

Installation

Requirements

  • Omeka S 4.1 or later. The module declares omeka_version_constraint = "^4.1": its blocks support theme block templates, and the container blocks build on the core block group editor (drop zones, spans, the SortableJS block list).
  • PHP 8.1 or later.

The module has no external dependencies and creates no database tables.

Installing

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

There is nothing to configure. The blocks appear immediately in the Add new block sidebar when you edit any site page (Admin > Sites > (site) > Pages > (page)), all with the BlockSuite: prefix:

  • BlockSuite: Call to Action
  • BlockSuite: Card Slider
  • BlockSuite: Column
  • BlockSuite: Columns (Blocks)
  • BlockSuite: Hero
  • BlockSuite: Item Slider
  • BlockSuite: Search Box
  • BlockSuite: Statistics
  • BlockSuite: Tab / Section
  • BlockSuite: Tabs (Blocks)
  • BlockSuite: Tabs (HTML)
  • BlockSuite: Timeline

See Configuration for what the module changes in Omeka S and the Usage pages for each block.

Upgrading

Copy the new version over the existing modules/BlockSuite folder, then visit Admin > Modules. If the module shows Upgrade available, click Upgrade. Until you do, Omeka S keeps the module deactivated and its blocks render nothing on the public site, so upgrade right after copying the files.

There are no upgrade migrations; block data saved by earlier versions is read as-is, and existing blocks keep their look apart from the new theme colors.

Upgrading to 1.2.0

  • Omeka S 4.1 or later is now required.
  • The public stylesheet card-slider-tabs.css and script card-slider-tabs.js were replaced by bst-base.css, bst-slider.css, bst-tabs.css, bst-content.css and bst.js. Blocks now take their colors from the theme. If your theme overrode the old styles, review them against Theming and Markup.
  • Theme copies of card-slider.phtml, item-slider.phtml, tabs.phtml or tabs-group.phtml keep working, but they miss the new display options and accessibility fixes. Compare them with the module's templates.

Uninstalling

Uninstalling from Admin > Modules removes the block layouts and the pageLayout helper override. Nothing is deleted from the database because the module owns no tables.

Blocks you created with the module stay on their pages. Omeka S shows them in the page editor as Unknown [cardSlider], Unknown [tabsGroup] and so on, and renders them as empty on the public site. Blocks that were inside a Tabs (Blocks) container become ordinary blocks again and render in page order. Delete the unknown blocks from the page editor if you do not plan to reinstall.

Log in for Support