Examples¶

Copy one as a starting point, or open it in Omeka S Playground. Every example is validated against the schema in CI.

First blueprint¶

Installs Omeka S with two modules, an editor and a public site.

{
  "$schema": "https://omeka-s-contrib.github.io/omeka-s-blueprints/schema/v0/blueprint-schema.json",
  "install": {
    "title": "Demo",
    "locale": "en_US",
    "timezone": "UTC",
    "admin": { "name": "Admin", "email": "admin@example.com" }
  },
  "modules": [
    { "name": "Common", "state": "activate" },
    { "name": "Mapping", "source": "https://github.com/omeka-s-modules/Mapping/releases/download/v2.1.0/Mapping-2.1.0.zip" }
  ],
  "users": [
    { "email": "editor@example.com", "role": "editor" }
  ],
  "sites": [
    { "title": "Demo site", "slug": "demo", "theme": "default" }
  ]
}

Modules and themes¶

Every way to name an add-on: from omeka.org by name and version, a ZIP release, and a GitHub repository.

Try in Playground JSON file

{
  "$schema": "https://omeka-s-contrib.github.io/omeka-s-blueprints/schema/v0/blueprint-schema.json",
  "modules": [
    "Common",
    { "name": "EasyAdmin", "version": "3.4.30" },
    { "name": "Mapping", "source": "https://github.com/omeka-s-modules/Mapping/releases/download/v2.1.0/Mapping-2.1.0.zip" },
    { "name": "Log", "source": "gh:Daniel-KM/Omeka-S-module-Log", "state": "install" }
  ],
  "themes": [
    "default",
    { "name": "freedom", "source": "gh:omeka-s-themes/freedom" }
  ],
  "sites": [
    { "title": "Freedom site", "slug": "freedom", "theme": "freedom", "setAsDefault": true }
  ]
}

Users and sites¶

Two sites, an editor who can only work on one of them, and an item in each.

Try in Playground JSON file

{
  "$schema": "https://omeka-s-contrib.github.io/omeka-s-blueprints/schema/v0/blueprint-schema.json",
  "users": [
    {
      "email": "editor.a@example.com",
      "role": "editor",
      "settings": { "limit_to_granted_sites": true }
    }
  ],
  "sites": [
    {
      "title": "Site A",
      "slug": "site-a",
      "setAsDefault": true,
      "permissions": [{ "user": "editor.a@example.com", "role": "admin" }]
    },
    { "title": "Site B", "slug": "site-b", "isPublic": false }
  ],
  "items": [
    { "title": "Document A1", "sites": ["site-a"] },
    { "title": "Document B1", "sites": ["site-b"] }
  ]
}

Sample content¶

An item set with two items, each with an image.

Try in Playground JSON file

{
  "$schema": "https://omeka-s-contrib.github.io/omeka-s-blueprints/schema/v0/blueprint-schema.json",
  "itemSets": [
    { "title": "Paintings", "description": "Public domain paintings." }
  ],
  "items": [
    {
      "title": "The Garden of Earthly Delights",
      "creator": "Hieronymus Bosch",
      "itemSets": ["Paintings"],
      "media": [
        {
          "type": "url",
          "url": "https://ateeducacion.github.io/omeka-s-playground/assets/samples/garden-of-earthly-delights.png",
          "title": "The Garden of Earthly Delights"
        }
      ]
    },
    {
      "title": "Thomas Carlyle",
      "creator": "George Frederic Watts",
      "itemSets": ["Paintings"],
      "media": [
        {
          "type": "url",
          "url": "https://ateeducacion.github.io/omeka-s-playground/assets/samples/thomas-carlyle-oil-painting-1868.jpg",
          "altText": "Oil portrait of Thomas Carlyle, 1868"
        }
      ]
    }
  ],
  "sites": [
    { "title": "Collection", "slug": "collection", "setAsDefault": true }
  ]
}