Skip to main content

Bootstrap 5

By Satoru Nakamura Bootstrap 5 theme rebuilt on the Omeka S 4.2 core templates: light / dark mode, main and accent colors, citation, share and IIIF manifest links.
Download 3.0.1

Omeka-S-theme-Bootstrap5

A Bootstrap 5 theme for Omeka S 4.1 and later. Version 3 is rebuilt on the Omeka S 4.2.1 core templates. It is used by the Toyo Bunko Media Repository (app.toyobunko-lab.jp).

theme

Screenshot images: The University of Tokyo Agricultural and Life Sciences Library, CC BY 4.0, via the UTokyo Digital Archives Portal.

Successor to ldasjp8/Omeka-S-theme-Bootstrap5 (4.0.x) and to version 2 of this repository ("Bootstrap5 Modernized"). Version 3.0.0 is newer than ldasjp8's 4.0.x, although the number is smaller. The theme's version numbers do not follow those of Omeka S.

日本語の説明は下にあります。

A video guide (14 minutes, English narration with English subtitles) shows installation, the public pages and the settings:

Video guide on YouTube

Features

  • Light and dark mode. A switch in the header offers light, dark and "same as the device"; the browser remembers the choice.
  • Language switch in the header when the module Internationalisation is enabled and the site belongs to a group of translated sites. It links to the same page in the other languages, or to the homepage of the other site when the page has no translation. Nothing is shown without the module.
  • Two color settings, main and accent. Text tints for dark mode are derived from them.
  • Browse pages as a grid or a list, with a page size selector (default, 50, 100).
  • Item and media pages with breadcrumbs and a row of actions: copy the URL, a citation to copy (Japanese or English form, following the page language), share to X / Facebook / email, the IIIF manifest (with the IIIF logo) and the JSON-LD data.
  • Open Graph and Twitter card tags, so shared links show the title, description and image.
  • Sticky header on wide screens, print styles.
  • Japanese translation.
  • Bootstrap CSS 5.3.8 and Font Awesome Free 6 are bundled; nothing is loaded from a CDN. Bootstrap's JavaScript is not used.

Installation

  1. Download the release zip, or clone this repository, into themes/ of your Omeka S. Keep the folder name Omeka-S-theme-Bootstrap5.
  2. In the admin, open Sites → your site → Theme, choose "Bootstrap 5" and adjust the settings.

Omeka S stores theme settings under the theme's folder name. If you replace an earlier version in the same folder, its settings are kept.

Settings

Setting Use
Main color / Accent color Buttons, links, footer background / home banner button, current menu mark
Footer Content HTML shown in the footer
Site Sub Title HTML shown under the site title on the home banner
Top Image / Top Button url Home banner image and the target of its button
Sort properties Extra sort options on browse pages, one term,Label per line
Body properties Values shown under titles in list view, one term,Label per line
Layout for Browse Pages Grid or list as the default
Advanced Search URL Another search page (for example a module's) instead of the core one

"Show a link to collections in item pages?" is kept so that old settings load, but it has no effect, as in 4.0.x.

Upgrading from version 2

  • hero_image, hero_button_url and hero_button_text are still read when top_image and top_url are empty.
  • list_display_properties and thumbnail_display_mode are no longer used. Use "Body properties" for the values under titles.
  • The hero carousel and the faceted search sidebar are gone.

Upgrading from ldasjp8/Omeka-S-theme-Bootstrap5 4.0.x

The setting names are the same. Put version 3 in the same folder and the settings carry over. Then set the main and accent colors, which are new.

Development

scripts/dev/setup.zsh starts a local Omeka S with DDEV and copies a few public items from a live site through its API. See the comments at the top of the script. scripts/dev/seed_sample.py instead fills an empty install with the CC BY 4.0 sample used for theme.jpg.

The first commit of the version 3 history holds the Omeka S 4.2.1 core templates as they are, so git log -p -- view/<path> shows what the theme changed.

Contributing

Bug reports, feature ideas, translations and pull requests are welcome. See CONTRIBUTING.md. Please report security issues privately, as described in SECURITY.md.

Citation

If you use this theme in your research or project, please cite it. GitHub's "Cite this repository" button gives the citation from CITATION.cff.

Support

If this theme is useful to you, you can support its development through GitHub Sponsors or Ko-fi.

License

GPLv3, as the theme contains Omeka S core templates. Bundled: Bootstrap (MIT), Font Awesome Free (icons CC BY 4.0, fonts SIL OFL 1.1, code MIT), IIIF logo (from iiif.io).

日本語

Omeka S 4.1 以降で使える Bootstrap 5 のテーマです。第3版は、Omeka S 4.2.1 の本体テンプレートを土台に作り直しました。 東洋文庫メディアリポジトリ（app.toyobunko-lab.jp）で使っています。

冒頭の画面写真の資料画像は、東京大学農学生命科学図書館の所蔵資料です（東京大学デジタルアーカイブポータル、CC BY 4.0）。

使い方の動画（15分）: 入れ方、公開サイトでの見え方、管理画面での設定を順に紹介しています。章ごとに区切ってあるので、見たいところから再生できます。

使い方の動画

主な機能:

  • ライトとダークの切り替え（ヘッダー右端。端末の設定に合わせることもできます）
  • 言語の切り替え（ヘッダー。Internationalisation モジュールを入れ、言語ごとのサイトをまとめたときだけ出ます）
  • メインの色とアクセントの色の設定
  • 一覧のグリッドとリストの切り替え、表示件数の切り替え
  • 資料の画面に、パンくず、URL のコピー、引用（日本語の形）、共有、IIIF マニフェスト、JSON-LD
  • 共有したときに題名と画像が出る設定（OGP）

入れ方: themes/ の下に、フォルダ名 Omeka-S-theme-Bootstrap5 のまま置きます。 同じフォルダ名で古い版と置き換えると、テーマの設定はそのまま引き継がれます。 第2版の hero_* の設定も読みます。

3.0.0 は ldasjp8/Omeka-S-theme-Bootstrap5 4.0.x の後継です（番号は小さくなりましたが、新しい版です）。 テーマの版番号は、Omeka S の版番号とは対応していません。

不具合の報告や要望は Issue にお寄せください。日本語でも構いません。 手順は CONTRIBUTING.md にあります。セキュリティの問題は、公開の Issue ではなく SECURITY.md の方法でお知らせください。

研究などで使っていただいた場合は、引用していただけると幸いです（GitHub の "Cite this repository" から引用の形が得られます）。 開発は GitHub Sponsors や Ko-fi で支援していただけます。

Version Released Minimum Omeka version
3.0.1October 24, 2026 [info]^4.1.0
3.0.0September 25, 2026 [info]^4.1.0