Skip to content

Commit 4705958

Browse files
committed
Document IWAC-SEO as a sibling, and align CITATION.cff with its module
The README listed only the two design-token consumers under "Sibling Modules", which left the citation coupling undocumented here. IWAC-SEO is a sibling of a different kind: it reads no theme tokens and ships no public CSS (verified — no var(--) anywhere in the module), but it owns the "How to cite" panel's formatters and registers the iwacCitation resource page block, while this theme supplies only view/common/citation.phtml. Splitting the section on that distinction keeps someone from looking for tokens in IWAC-SEO, or for citation formatting in here. CITATION.cff now follows the field order, quoting and header comment of the one already in IWAC-SEO so the two read as a set. Still validates against citation-file-format 1.2.0; the version gate parses either form.
1 parent 093cd67 commit 4705958

2 files changed

Lines changed: 52 additions & 38 deletions

File tree

CITATION.cff

Lines changed: 38 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,59 @@
1+
# Citation metadata for this repository, in Citation File Format 1.2.0.
2+
# https://citation-file-format.github.io/
3+
#
4+
# GitHub reads this file to render the "Cite this repository" button and to
5+
# generate APA and BibTeX strings. Keep `version` and `date-released` in step
6+
# with config/theme.ini and package.json — .github/workflows/release.yml fails
7+
# the release if the three disagree with the tag.
18
cff-version: 1.2.0
2-
title: "IWAC Theme: An Omeka S Theme for the Islam West Africa Collection"
3-
message: >-
4-
If you use this theme, or reuse its design system, please cite it
5-
using the metadata in this file.
9+
message: "If you use this software, please cite it using the metadata below."
10+
title: "IWAC Theme: an Omeka S theme for the Islam West Africa Collection"
11+
abstract: >-
12+
IWAC Theme is the Omeka S 4.2+ theme of the Islam West Africa Collection
13+
(IWAC), a bilingual open-access archive of press articles, Islamic
14+
publications, archival documents and audiovisual records on Muslim public
15+
life in Benin, Burkina Faso, Côte d'Ivoire, Niger, Nigeria and Togo, hosted
16+
at Leibniz-Zentrum Moderner Orient (ZMO), Berlin. It implements a
17+
"press archive" design register — masthead wordmark, ink rules, datelines
18+
and ledger rows — over an OKLCH design-token system derived from a single
19+
admin-set brand seed, with a light/dark mode toggle, a per-site installable
20+
web app manifest, English/French interface translations and WCAG 2.1 AA
21+
accessibility. Its tokens are the single source of truth for the sibling
22+
IwacSearch and IwacVisualizations modules, which consume them through a
23+
generated tokens.json contract instead of defining their own palette.
624
type: software
725
authors:
8-
- given-names: Frédérick
9-
family-names: Madore
26+
- family-names: Madore
27+
given-names: Frédérick
1028
orcid: "https://orcid.org/0000-0003-0959-2092"
11-
affiliation: University of Bayreuth
29+
affiliation: "University of Bayreuth"
30+
version: "2.9.5"
31+
date-released: "2026-08-05"
32+
license: GPL-3.0-or-later
1233
repository-code: "https://github.com/fmadore/IWAC-theme"
1334
url: "https://islam.zmo.de/s/westafrica/"
14-
abstract: >-
15-
An Omeka S 4.2+ theme built for the Islam West Africa Collection
16-
(IWAC), an open-access archive of press articles, Islamic
17-
publications, archival documents and audiovisual records on Muslim
18-
public life in Benin, Burkina Faso, Côte d'Ivoire, Niger, Nigeria and
19-
Togo, hosted at Leibniz-Zentrum Moderner Orient (ZMO), Berlin. The
20-
theme implements a bilingual (English/French) "press archive" design
21-
register with an OKLCH design-token system derived from a single
22-
admin-set brand seed, a light/dark mode toggle, a per-site installable
23-
web app manifest, and WCAG 2.1 AA accessibility. Its design tokens are
24-
the single source of truth for the sibling IwacSearch and
25-
IwacVisualizations modules, which consume them via a generated
26-
tokens.json contract.
2735
keywords:
2836
- Omeka S
29-
- theme
37+
- Omeka S theme
3038
- digital humanities
3139
- digital archives
32-
- West Africa
33-
- Islam
3440
- design system
3541
- design tokens
42+
- OKLCH
3643
- accessibility
3744
- multilingual
38-
license: GPL-3.0-or-later
39-
version: 2.9.5
40-
date-released: "2026-08-05"
45+
- Islam West Africa Collection
46+
- West Africa
4147
references:
4248
- type: software
4349
title: Freedom
4450
abstract: >-
45-
The Omeka S theme that IWAC Theme was forked from in 2024, and has
46-
since diverged substantially from.
51+
The Omeka S theme IWAC Theme was forked from in 2024, and has since
52+
diverged substantially from.
4753
authors:
48-
- name: Corporation for Digital Scholarship
49-
- given-names: Nelson
50-
family-names: Amaya
54+
- name: "Corporation for Digital Scholarship"
55+
- family-names: Amaya
56+
given-names: Nelson
5157
repository-code: "https://github.com/omeka-s-themes/freedom"
5258
license: GPL-3.0-or-later
53-
version: 1.1.0
59+
version: "1.1.0"

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -209,17 +209,25 @@ The language switcher displays:
209209
- Dropdown with available translations for the current page
210210
- Links styled consistently with the theme
211211

212-
### Sibling Modules (Shared Design System)
212+
### Sibling Modules
213213

214-
Two companion modules are part of the **same design system** and *consume* the
215-
theme's design tokens rather than defining their own. The full contract — which
216-
tokens they may use, the canonical fallback values, dark-mode rules, and the
217-
one sanctioned exception (module-owned chart/data colours) — is documented in
218-
[**`docs/DESIGN-SYSTEM.md`**](docs/DESIGN-SYSTEM.md).
214+
Three companion modules are developed alongside the theme. They couple to it in
215+
two different ways, and the distinction matters when changing either side.
216+
217+
**Design-token consumers.** These two are part of the **same design system** and
218+
*consume* the theme's design tokens rather than defining their own. The full
219+
contract — which tokens they may use, the canonical fallback values, dark-mode
220+
rules, and the one sanctioned exception (module-owned chart/data colours) — is
221+
documented in [**`docs/DESIGN-SYSTEM.md`**](docs/DESIGN-SYSTEM.md).
219222

220223
- **[IwacSearch](https://github.com/fmadore/IwacSearch)** - Typesense-backed public search (Svelte 5). The header search box (`view/common/search-form.phtml`) feeds the module's typeahead via a `data-iwac-header-search` hook; the public/admin apps mount on `[data-iwac-search-root]` / `[data-iwac-admin-root]`. All colours, type, and spacing resolve from the theme's `--*` tokens.
221224
- **[IwacVisualizations](https://github.com/fmadore/IwacVisualizations)** - ECharts/MapLibre dashboards on the homepage and resource pages. Reads theme tokens at runtime (so charts track light/dark and admin colour overrides) and uses the admin **Secondary Color** as chart series 2 / corpus B.
222225

226+
**Markup contract, not tokens.** This one ships no public-facing CSS and reads
227+
no theme tokens; the coupling is a shared template.
228+
229+
- **[IWAC-SEO](https://github.com/fmadore/IWAC-SEO)** - SEO, citation metadata and XML sitemaps. It owns the **"How to cite" panel**: the module registers the `iwacCitation` resource page block and computes the Chicago/APA/MLA renderings and the BibTeX, RIS and CSL-JSON downloads, while this theme supplies only the UI partial ([`view/common/citation.phtml`](view/common/citation.phtml)). Don't reimplement citation formatting here — and don't restyle the panel without checking the markup the module's helper actually emits. The block is placed per site via **Admin → Themes → Configure resource pages**.
230+
223231
### Other Supported Modules
224232

225233
The theme also includes styling for:

0 commit comments

Comments
 (0)