Attributes

HTML attributes recognised by the <jinn-tap> element. Of these, debug, url, schema, block-typing and format are observed (they take effect when changed after connection); the rest are read once when the component initialises.

Content & format

url

Fetch and load a TEI/JATS document from a URL.

<jinn-tap url="document.xml"></jinn-tap>

format

The document format, tei (default) or jats.

format controls the editor end-to-end: it selects the default built-in schema (unless you provide a custom schema), changes the HTML custom-element prefix used in the editor (tei- / jats-), and switches the XML import/export rules.

In particular:

• tei assumes TEI XML with namespace http://www.tei-c.org/ns/1.0 and uses TEI defaults for notes/anchors.
• jats assumes JATS-style markup in no default XML namespace (export/import uses an empty namespace) and uses JATS defaults for notes/anchors.

format is observed, so changing the attribute will rebuild the editor using the other built-in defaults (but if you set schema, your custom schema remains).

To wire up a third dialect (config, schema, XQuery import/export, styles), see Adding a format.

<jinn-tap format="jats"></jinn-tap>

schema

URL of a custom schema JSON to use instead of the built-in schema for the active format (src/tei-schema.json for TEI, src/jats-schema.json for JATS). See the Schema reference.

<jinn-tap schema="./my-schema.json"></jinn-tap>

Relative paths in the schema's top-level css property are resolved against this URL, so a custom schema can ship its stylesheet beside the JSON file.

no-schema-css

When present, skip auto-injecting the stylesheet declared by the schema's css property. Use this if the host page already loads document styles (or wants none).

<jinn-tap no-schema-css></jinn-tap>

Layout

sidebar

CSS selector of an element to host the attribute panel. If omitted, the panel is rendered as a bottom dock inside the component. Attributes on elements with an authority connector use a connector panel whose layout is controlled by --jinn-tap-content-max-width and --jinn-tap-connector-panel-width: when there is room beside the capped content width, the panel docks in a reserved right column; otherwise it opens as a slide-over overlay with a collapsed summary in the bottom bar. Normal attributes always use the bottom dock. Use sidebar when you want a permanent side panel in your own layout.

toolbar

CSS selector of an element to host the toolbar. If omitted, a toolbar is created inside the component.

Extra toolbar items and attribute-panel content can also be provided with the toolbar and aside slots.

fullscreen

When present, adds a toolbar button that toggles browser fullscreen on the editor (or its nearest .jinn-tap-embed wrapper, when used in an embed).

<jinn-tap fullscreen url="document.xml"></jinn-tap>

fill

When present, the editor fills its parent’s height and scrolls only the editor area. Use this in embeds and workbench hosts with a fixed pane. Without fill, the component grows with content and the toolbar sticks while the page scrolls.

<div style="height: 40rem">
  <jinn-tap fill url="document.xml"></jinn-tap>
</div>

Editing behaviour

block-typing

When present, disables direct text typing (and the cut / delete / backspace shortcuts) while keeping the toolbar and its commands active — useful for documents that should be structured only through commands.

debug

Enables debug mode.

Notes

notes

How footnotes relate to their anchors. connected links notes to anchors; the default (disconnected) allows notes without an anchor.

notes-wrapper

The element name that wraps the notes/annotations list (default listAnnotation).

Collaboration

Real-time collaboration is enabled when server is set. See Embedding → collaboration.

user and color fall back to localStorage values (jinn-tap.username, jinn-tap.color) when omitted.