Dublin Core renderings
Render every folio-dublin-core/v1 record a catalogue item names as Dublin Core XML (qualified DC, per DCMI’s XML guidelines) and as JSON-LD bound to DCMI Metadata Terms. Both are written into the instance’s published root (<instanceRoot>/dublin-core/<stem>.dc.xml and .dc.jsonld), so the site mount publishes them beside the item pages. Deterministic. --check fails on a missing, stale or orphaned rendering. Governed by the dublin-core-renderings skill.
Skills it satisfies
A skill states the capability; this Tool is one way to exercise it. Each skill’s declared input and output contract follows, where it has one.
dublin-core-renderings
Render a catalogue’s Dublin Core records in the two standard forms an outside reader can use: Dublin Core XML, which a harvester reads, and JSON-LD bound to DCMI Metadata Terms. Each rendering is published beside the item’s page. Covers which records get one, which XML form is used and why, how every field maps from the record’s own data (never composed), what cannot be expressed and how that is reported, and the gate. Read this before changing the mapping, adding a catalogue layer, or linking a rendering from a page.
Source: folio-assistant-core/skills/library/catalogue/dublin-core-renderings.md.
The skill declares no I/O contract (schemas/skills/dublin-core-renderings/{input,output}.schema.json).
Inputs and outputs
Each port names a shared type by IRI, so two Tools for one skill can be checked for interchangeability.
| port | type | required | description | constraint | |
|---|---|---|---|---|---|
| in | instance | RepoPath | yes | The catalogue instance’s root, e.g. an IRIS mirror’s directory. It must hold catalogue/catalogue.json and declare a directory with instanceRoot: true. | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. |
| in | check | Flag | Write nothing. Exit 1 if any rendering is missing, stale or orphaned. | boolean · A boolean switch — projects to a bare flag, with no value word | |
| out | renderings | RepoPath | <published root>/dublin-core/: one .dc.xml and one .dc.jsonld per record. A one-line summary goes to stdout. | string · pattern ^[A-Za-z0-9._][A-Za-z0-9._/-]*$ · A path relative to the repository root. No .. segments. |
Processes and tasks
No process step names a skill this Tool satisfies.
How it is deployed and reached
- Command line. From the repository root:
bun run folio-assistant-core/scripts/dc-render.ts. - GitHub Actions. No workflow in this checkout runs its command.
As an API: its operation in the OpenAPI document and the MCP tool list of its layer.
| install | none |
| runtime | bun |
| network | no |
| when to choose it | |
|---|---|
| when | A catalogue record changed, a catalogue item was added or removed, or the DCMI mapping changed. The renderings must then be regenerated before the gate passes. |
| limits | Renders only records a catalogue item names. Fields with no DCMI term keep a minted predicate in JSON-LD and are reduced to their DC element in XML. A non-dc schema field cannot appear in XML at all, and is listed in a header comment. Not OAI-PMH oai_dc. |
| cost | Milliseconds per record. Reads the catalogue nodes and records; no network. |
What it is made of
| role | file | |
|---|---|---|
| definition | folio-assistant-core/tools/dublin-core-render/dublin-core-render.ts | |
| script | folio-assistant-core/scripts/dc-render.ts |
Linked data
The Tool is published as its own JSON-LD document at its IRI, https://litlfred.github.io/folio-assistant/folio-assistant-core/tools/dublin-core-render.jsonld, partOf its layer’s document. The node below is the definition this page was drawn from, and is embedded in the page as application/ld+json.
{
"@context": "https://litlfred.github.io/folio-assistant/folio-assistant-core/folio-assistant-core.context.jsonld",
"@id": "https://litlfred.github.io/folio-assistant/folio-assistant-core/tools/dublin-core-render.jsonld",
"@type": "https://litlfred.github.io/cat-harness/v0/ns/Tool",
"partOf": "https://litlfred.github.io/folio-assistant/folio-assistant-core/folio-assistant-core.jsonld",
"name": "dublin-core-render",
"title": "Dublin Core renderings",
"description": "Render every `folio-dublin-core/v1` record a catalogue item names as Dublin Core XML (qualified DC, per DCMI's XML guidelines) and as JSON-LD bound to DCMI Metadata Terms. Both are written into the instance's published root (`<instanceRoot>/dublin-core/<stem>.dc.xml` and `.dc.jsonld`), so the site mount publishes them beside the item pages. Deterministic. `--check` fails on a missing, stale or orphaned rendering. Governed by the `dublin-core-renderings` skill.",
"install": {
"none": true
},
"invoke": {
"shell": "bun run folio-assistant-core/scripts/dc-render.ts"
},
"io": {
"inputs": [
{
"name": "instance",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"description": "The catalogue instance's root, e.g. an IRIS mirror's directory. It must hold `catalogue/catalogue.json` and declare a directory with `instanceRoot: true`.",
"required": true,
"arg": {
"positional": 0
}
},
{
"name": "check",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/Flag",
"description": "Write nothing. Exit 1 if any rendering is missing, stale or orphaned.",
"required": false,
"arg": {
"flag": "--check"
}
}
],
"outputs": [
{
"name": "renderings",
"schema": "https://litlfred.github.io/folio-assistant/cat-harness/tool-types.schema.json#/$defs/RepoPath",
"description": "`<published root>/dublin-core/`: one `.dc.xml` and one `.dc.jsonld` per record. A one-line summary goes to stdout."
}
]
},
"satisfies": [
"dublin-core-renderings"
],
"requirements": {
"runtime": [
"bun"
],
"network": false
},
"selection": {
"when": "A catalogue record changed, a catalogue item was added or removed, or the DCMI mapping changed. The renderings must then be regenerated before the gate passes.",
"limits": "Renders only records a catalogue item names. Fields with no DCMI term keep a minted predicate in JSON-LD and are reduced to their DC element in XML. A non-`dc` schema field cannot appear in XML at all, and is listed in a header comment. Not OAI-PMH `oai_dc`.",
"cost": "Milliseconds per record. Reads the catalogue nodes and records; no network."
}
}