Getting Started Omeka Classic plugin

Installation

The screenshots in these pages show Block Suite with the Vitrine theme on Tincup Mountain, a fictional ski area's collection, running on Omeka Classic.

A Hero block on Tincup Mountain: the heading Fifty-six winters on Tincup Mountain and a Read the story button over a night-skiing poster
Block Suite's Hero on Tincup Mountain

Requirements

  • Omeka Classic 3.1 or later. Block Suite is built and tested on 3.2.2.
  • PHP 7.4 or later.
  • Exhibit Builder (bundled with Omeka Classic) for the sixteen exhibit layouts. Simple Pages is optional: it is where most shortcodes go. Without Exhibit Builder the shortcodes still work.

Block Suite creates no database tables. It has one setting, on by default: Keep page markup when Omeka filters HTML (see Configuration). Installing turns it on and adds the HTML5 elements and attributes it needs to the allowed HTML lists under Settings › Security.

Installing

  1. Unzip BlockSuite-1.0.0.zip and copy the BlockSuite folder into your Omeka Classic plugins/ folder.
  2. Log in to the admin as a Super User and go to Settings > Plugins (the Plugins link at the top of the admin).
  3. Click Install next to BlockSuite.

The layouts then appear in the exhibit page editor (Exhibits > (exhibit) > Edit > (page) > Edit, under New Block), after Exhibit Builder's own five:

Hero, Lead Paragraph, Callout, Pull Quote, Columns, Call to Action, Statistics, Timeline, Item Cards, Spotlight, Item Slider, Logo Wall, Search Box, Tabs, Accordion and Divider.

The shortcodes ([bs_search], [bs_stats], [bs_cta], [bs_items], [bs_timeline], [bs_divider]) work at once in Simple Pages, the home page welcome text of RefBytes themes and exhibit text blocks. See Shortcodes.

Upgrading

Deactivate the plugin, replace the plugins/BlockSuite folder with the new version, then click Upgrade (or Activate) on the Plugins page. Block options are stored by Exhibit Builder with each block, so nothing is lost.

Uninstalling

Click Uninstall on the Plugins page, then delete the folder. The elements and attributes Block Suite added to the allowed HTML lists under Settings › Security stay there; remove them yourself if you no longer want them (without Block Suite, Omeka's filter does not support the HTML5 ones and warns about them). Exhibit blocks that used a Block Suite layout stay on their pages: Exhibit Builder shows them with its File with Text layout (its fallback for unknown layouts), keeping their text and items, so you can change their layout. Shortcodes stay in the text as typed.

Log in for Support