Styled plugins
The theme includes templates and styles for these plugins, so they follow your colors, fonts and dark mode, and work on phones:
| Plugin | What the theme does |
|---|---|
| Admin bar (Omeka) | The bar above the site (Log in, Register, Log out) takes your fonts and colors instead of Omeka's grey bar. |
| Coins | The hidden citation data for Zotero and other reference managers stays hidden and takes no space. |
| Collection Tree | The Collection Tree page and the tree on a collection's page show nested collections as an indented list with item counts; the collection you are on is marked. A collection with no parent or child collections shows no tree. |
| Commenting | Comments and replies as cards, with the commenter's initial instead of a Gravatar picture (no visitor's email address is sent to gravatar.com), dates, and Reply links that say whose comment they answer. The comment form uses the theme's fields, and its editor switches to a dark toolbar in dark mode. |
| Contribution | The Contribute page, its terms, the thank-you page and My Contributions use the theme's page layout and form style. Choosing a contribution type still loads its fields without reloading the page. |
| Docs Viewer | The viewer fills the width of the page. |
| Exhibit Builder blocks from plugins | Geolocation maps, Neatline exhibits (with a title and a link to open the exhibit on its own page) and Neatline Time timelines inside exhibit pages. |
| Geolocation | The map page lists the items next to the map on wide screens and below it on phones; each entry opens its marker. Map controls, popups and clustered markers take your colors, and in dark mode the map is shown in dark tones. The location fields of the advanced search have plain-language labels, and a place that cannot be found is reported under the field instead of in a pop-up box. |
| Guest User | Register, Log in, Forgot password, Update account and the My Account dashboard use the theme's page layout and fields. Omeka's old 960-pixel grid, which the plugin loads on its forms, is switched off. |
| Html5 Media | Audio and video players span their column, with the player bar in your theme's dark color. |
| Item Relations | Related items are listed by relation ("References", "Referenced by", "Is part of"…), reading the right way round from the item you are on. |
| Neatline | Exhibit pages show the title and links in the page column and the exhibit across the full width, with the narrative below. Bubbles and map controls take your colors, and map tiles darken in dark mode. |
| Neatline Time | Timelines in your colors in both color schemes, with a link to the same items as a list. |
| PDF Embed | PDFs fill the width of their column. |
| Scripto | Transcription pages, tables and the change history (additions and deletions) in your colors. |
| Search by Metadata | Linked values look like the theme's other links. |
| Shortcode Carousel | [carousel], [featured_carousel] and [recent_carousel] show pictures at the theme's card shape, one link per slide, with arrow buttons and labelled dots. A carousel set to scroll by itself gets a Pause button and stays still for visitors who ask their device for reduced motion. |
| Simple Contact Form | The contact page gets a title, the theme's form style and the browser's autofill. |
| Social Bookmarking | The share links become quiet buttons. |
| Universal Viewer | The viewer keeps its own interface; the theme's headings, buttons and links don't reach into it. |
Any other plugin's pages inherit the theme's styles for headings, text, links, forms, buttons and tables in both color schemes, and sit in the page column like the theme's own pages.
Setting up plugins
Geolocation. The plugin's default map style, CARTO Voyager, now asks for an API key and shows "API key required" on every tile. In Plugins › Geolocation › Configure, choose another base map, such as OpenStreetMap › Standard or one of the Esri maps. In dark mode the theme shows the light map in dark tones; if you choose a dark base map yourself, add this to Custom CSS so it is not inverted back:
.leaflet-tile-pane, #neatline .olTileImage { filter: none; }
The map page is at /geolocation/map/browse. Geolocation adds a "Map" link to your menu: in Appearance › Navigation you can show it, hide it or move it.
Commenting. Comments appear on item and collection pages. To hold visitors' comments for approval, tick "Require moderation for all public comments?" in the plugin's settings; the form then tells visitors their comment will appear once approved.
Guest User. When it is active, the bar with "Log in" and "Register" appears at the top of every page for every visitor. Untick "Allow open registration?" if visitors should not create accounts. Registration and confirmation send email, so your site must be able to send mail.
Contribution needs Guest User. To let visitors contribute without an account, tick "Allow Non-registered Contributions" in Contribution › Settings. Write your terms under "Text of Terms of Service": the theme shows them on their own page and links to them from the form.
Html5 Media. Name a caption file like its video (interview.mp4 and interview.vtt) and add both to the same item: the player shows the captions. On an item page the first file is shown large; open the other files from the list below it to play them.
PDF Embed shows PDFs with the browser's own viewer ("object") or with PDF.js. The PDF.js viewer follows the visitor's device setting for light or dark, not the theme's switch.
Docs Viewer shows documents through Google's viewer, which has to download each file from your site: it does not work on a site that is private, behind a login, or running on your own computer, and it shows PDFs a second time if PDF Embed is also active.
Universal Viewer adds itself below every item's files, which repeats the pictures the theme already shows. Untick Append to "Item show" and Append to "Collection show" in its settings and link to the viewer instead (/items/play/<id>), or use its Exhibit Builder block. It needs the GD or Imagick extension of PHP. Its [uv] shortcode is broken in the current version.
Scripto needs a MediaWiki installation that your Omeka site can reach. Don't activate it without one: every item page asks MediaWiki for the current user, and fails if it can't.
Neatline. The theme loads the OpenStreetMap layer over https, so maps also work on sites served over plain http. The Google layers need a Google Maps key in the plugin's settings, and the Stamen layers no longer exist. Fill in the exhibit's "Accessible URL" to link visitors to a text version. After installing, delete the folder plugins/Neatline/views/shared/javascripts/dist/production/ckeditor/samples: it holds a sample page that fails on current PHP and can be reached from the web.
Neatline Time. Timelines are dragged with a mouse or a finger; the "See these items as a list" link below each timeline gives everyone, including keyboard and screen reader users, the same items.
Shortcode Carousel. Add showtitles=true to show titles under the pictures. Avoid autoscroll=true unless the slides are decorative: moving content is hard to read for many visitors (the theme adds a Pause button).
Social Bookmarking repeats the theme's own Share panel on item pages. Use one or the other: turn off the theme's "Share" panel in Appearance › Themes › Configure, or untick the plugin's "Add to Items" and "Add to Collections".
Search by Metadata. Don't choose the Title field: titles are already links on browse pages, and a linked title inside a page heading is confusing.
Item Relations. Set "Relation Format" to "label" so relations read "References" rather than "dcterms:references".
Collection Tree. Tick "Browse root-level collections only" so child collections are reached through their parents.
reCAPTCHA (Settings › Security). On the contact and contribution forms the check matches the theme's light or dark mode. Google draws it in a frame the theme cannot restyle, and the Commenting and Guest User forms always show the light version.
Loading jQuery from your own site. Omeka loads jQuery and jQuery UI from code.jquery.com. To serve them from your own site, add theme.useInternalAssets = true to application/config/config.ini.
Known limits
- The Commenting form and Guest User forms are built by the plugins: the theme styles them but cannot change their wording or order.
- Comments are shown on item and collection pages, not on Simple Pages or exhibit pages.
- Google's Docs Viewer, the Universal Viewer and SIMILE's timeline draw their own interfaces: the viewer stays white, the Universal Viewer stays dark grey, and the timeline cannot be moved with the keyboard.
- Neatline's extra widgets (Waypoints, SIMILE, Text) are separate plugins and were not tested with the theme.
- When a plugin adds a page to your site (Map, Contribute, Contact…), Omeka adds its link to the main menu. Hide or move it in Appearance › Navigation.
For theme developers
The engine's templates for plugin pages are in engine/view/ at the paths Omeka looks for them (geolocation/map/browse.php, contribution/contribution/contribute.php, comments.php…); a theme replaces one by putting its own file at the same path. Some plugin stylesheets are replaced by files of the same name in engine/view/css/ (admin-bar.css, skeleton.css, guest-user.css, commenting.css, jcarousel.responsive.css, geolocation-marker.css, neatlinetime-timeline.css). Everything else is in engine/asset/css/integrations.css, which loads after the plugins' stylesheets: the rules for the engine's own .v-* classes sit in the engine.components layer (change them from your stylesheet's theme layer), and the rules for plugin markup are unlayered (change them from a stylesheet listed under integration_stylesheets in config/design.php).
Plugins can read the theme's colors with the same --theme-* custom properties as on Omeka S, for example var(--theme-primary, #3a6fa8).