Block Plus (module for Omeka S)
New versions of this module and support for Omeka S version 3.0 and above are available on GitLab, which seems to respect users and privacy better than the previous repository.
Block Plus is a module for Omeka S that adds some new blocks for the static pages and improves some of the existing ones: image gallery, D3 graph, mirror page, search form, assets, item set showcase, exhibits, footnotes, etc.
Furthermore, each block can use multiple templates, so it's possible to theme a block differently in different pages.
First, install the optional module [Generic] if wanted.
The module uses external js libraries for some blocks, so use the release zip to install it, or use and init the source.
- From the zip
Download the last release BlockPlus.zip from the list of releases (the master
does not contain the dependency), and uncompress it in the
- From the source and for development:
If the module was installed from the source, rename the name of the folder of
the module to
BlockPlus, and go to the root module, and run:
composer install --no-dev
Then install it like any other Omeka module.
See general end user documentation for Installing a module and follow the config instructions.
Select them in the view "Page edit". You may theme them too: copy the block
templates that are in
view/common/block-layout/ in the same place of your
Improvements in all blocks
The core blocks (Browse preview, Html, Item metadata, Item showcase, List of pages, List of sites, Page title, Table of contents) are improved with two new options:
Most of the blocks have an option to set a title.
Most of block have an option to set a specific template, so it’s possible to display these blocks differently in the same page or on different pages.
When a block allows to select a template, the filename must start with the same string than the original template, for example "table-of-contents-pages.phtml" for the block "TableOfContents".
Furthermore, it should exists in a module or in the current theme. When the template is missing, for example when switching into another theme, the default of the template is used. Thereby, when the module or the theme that has this template is replaced, you have to check the pages that use it.
New blocks and specific improvements
Since the integration of "asset" in Omeka 3.1, this block is an improved version of the core block "asset". It can list assets with optional link to pages, labels and caption. The assets are not required to be filled, so it allow to display any list of contents.
Unlike the upstream version, it has a specific
class option at asset level and
supports templates. Some templates are available: "asset-block", "asset-hero-bootstrap",
"asset-left-right" and "asset-partners".
This block provides the same information than the view helper
(see below), but from a block. It is usefull with the simple block to extract
params, or to get some informations about the page from anywhere in the theme.
// A simple check is done to make the theme more generic. $blockMetadata = $plugins->has('blockMetadata') ? $plugins->get('blockMetadata') : null; if ($blockMetadata): $data = $blockMetadata('params_key_value'); endif;
Browse preview (improvements)
The block Browse preview has new fields to display sort headings and pagination, so it's now possible to have a specific list of items, like the main browse view.
It has some specific templates too:
- simple carousel ("browse-preview-carousel"): this is an upgrade of the plugin
Shortcode Carousel for Omeka Classic.
- gallery display with a quick viewer too ("browse-preview-gallery"). This one
has a specific option to add to the query to display thumbnails as square or
thumbnail_size=medium. You can see an example on the site Ontologie du christianisme médiéval en images,
from French Institut national de l’histoire de l’art.
To use them, simply select the wanted template:
The D3 graph adds the D3 library to display relations between items in a graph: links between subjects and objects, links between items and item sets, etc.
Similar to media with html, but to display an external asset that is not a resource neither an asset file, so currently not manageable inside Omeka. It may be used to display a html text with a video on the home page.
Two new options are added in main settings:
- Display the html field as a document, that is a lot easier when editing long articles. Furthermore, the field can be maximized.
- Use the default or advanced toolbar. The advanced toolbar is the CKEditor one and contains more possibilities to edit advanced text.
Furthermore, it is possible to add footnotes inside each html field.
Item Set showcase
This is similar to the block Item Showcase, but for item sets.
Allow to use a page as a block, so the same page can be use in multiple sites, for example the page "About" or "Privacy". Of course, the page is a standard page and can be more complex with multiple blocks. May be fun. This is an equivalent for the shortcode as a page in Omeka Classic too.
Display the date of the creation and/or modification of the current page. See Omeka issue #1706.
Redirect to URL
Allow to redirect the page to another page, inside or outside Omeka. It is useful for hard coded links in the footer, to keep track of some clicks, to use the page item/browse as a the home page, or some other use cases.
Resource with html
Include a specific search form in a specific page. The default query may be adapted to the page via the theme.
Search form and results
Create a full search page with a simple or complex form and the results on the
same page. All options should be managed via the theme. To replace item/browse,
item-set/browse and even media/browse, you may need to set the page as default
action for the search in default template
Allow to set a div with a specific class between two blocks. May be useful to fix some css issues, or to increase space between some blocks.
Allow to wrap a block or multiple block with a
div. in particular to create
columns. Divisions can be nested. The css should be prepared in the theme to
managed them. By default, only a simple
aside column of 30% is available with
column align-right (or left).
A simple block allow to display a template from the theme. It may be used for a static html content, like a list of partners, or a complex layout, since any Omeka feature is available in a view.
An example layout is provided to display a dynamic tree view from a tsv/csv file. The file should be one value by a row, with the offset matching the depth:
Asia Japan Tokyo Europe France Paris Italy Roma Florence
A second example is a template to create a standard glossary (definition list):
alpha = First letter of Greek alphabet beta = Second letter of Greek alphabet
The glossary can be created with html too with the block
html and template
In that case, set a list of term and definition separated by an empty line:
alpha definition of alpha beta definition of beta definition of beta continued…
To insert a line, it is recommended to set the cursor at the start of the line. It will avoid possible issues.
This is a showcase for any resource, site, page, asset or url. It's an improved and genericized version of item showcase.
Table of contents (improvement)
The table can be displayed from the root if wanted.
Display the last messages from an account on Twitter. To use it, you may use your own developer bearer token, else the module will try to use an anonymous one.
Technical note: Since December 2020, it is required to get a dev account to fetch messages of a user, because Twitter disabled any standard html endpoint (see this issue on StackOverflow). If you use a dev account, it is not necessarily the one of the thread to follow.
Nevertheless, it is still possible to fetch them with an anonymous bearer token.
To get it, check the urls in the dev tools of your browser in the "network" tab.
The token is set in the header of the requests to https://api.twitter.com with
Authorization, for example
This token will be available for the next two years, or less. Anyway, the
module fetches it automagically. Nevertheless, it uses some hard coded urls that
Check how to generate a bear token. You need to create an app in your account too. If you can't, try to check the option to use the Api version 1.1.
In all cases, there is a rate limit, but generally largely enough for a common digital library.
Theme view helpers
Allow to add a type to the page, so it’s simpler to have different templates for different pages. It allows in particular to create exhibits inside a site, without creating a new site.
You can add new types in the settings of the site. Then, in your theme, you can
get the page type
$pageType = $this->pageMetadata('type'); and many other data
about the page. If the page is an exhibit, it is possible to build a specific
navigation menu of this exhibit too, like in the site Fondation de la Maison de Salins.
To manage multiple types, it’s generally required to edit the template "view/omeka/site/page/show.phtml" of your theme and to add a check:
// A simple check is done to make the theme more generic. $pageMetadata = $plugins->has('pageMetadata') ? $plugins->get('pageMetadata') : null; if ($pageMetadata): $type = $pageMetadata('type') ?: null; switch ($type): case 'home': $class = 'home'; // Specific html code… break; case 'exhibit': $class = 'exhibit'; // Specific html code… break; case 'exhibit_page': $class = 'exhibit-page'; // Specific html code… break; case 'simple': $class = 'simple-page'; // Specific html code… break; default: // Generic html code… $class = 'page'; break; endswitch; $this->htmlElement('body')->appendAttribute('class', $class); // … endif;
This view helper allows to get the data of all pages of the same type in the current site. For example, you can get all "exhibit_page". Multiple types can be retrieved at once.
// A simple check is done to make the theme more generic. $pagesMetadata = $plugins->has('pagesMetadata') ? $plugins->get('pagesMetadata') : null; if ($pagesMetadata): $data = $pagesMetadata('exhibit_page'); endif;
- [ ] Merge more similar blocks into a main block (with automatic upgrade).
- [x] Integrate Shortcodes (module Shortcode)
- [x] Integrate Menu (module Menu)
- [ ] Integrate attachments for block Showcase
- [ ] Integrate sidebar forms for block Showcase
- [ ] Auto-create asset when image is uploaded in a Html field.
- [ ] Update site of mirror page to get good url for $resource->siteUrl().
Use it at your own risk.
It’s always recommended to backup your files and your databases and to check your archives regularly so you can roll back if needed.
See online issues on the module issues page on GitLab.
In consideration of access to the source code and the rights to copy, modify and redistribute granted by the license, users are provided only with a limited warranty and the software’s author, the holder of the economic rights, and the successive licensors only have limited liability.
In this respect, the risks associated with loading, using, modifying and/or developing or reproducing the software by the user are brought to the user’s attention, given its Free Software status, which may make it complicated to use, with the result that its use is reserved for developers and experienced professionals having in-depth computer knowledge. Users are therefore encouraged to load and test the suitability of the software as regards their requirements in conditions enabling the security of their systems and/or data to be ensured and, more generally, to use and operate it in the same conditions of security. This Agreement may be freely reproduced and published, provided it is not altered, and that no provisions are either added or removed herefrom.
One of the CKEditor ones [GPL].
CKEditor 4 footnotes
One of the CKEditor ones [GPL]. See [CKEditor-Footnotes].
Gallery of images
See MIT license here: http://tympanus.net/codrops/licensing/ The original template was fixed by KevinMwangi and updated for newer version of components (modernizr, smartresize, imagesloaded).