API reference
Profiles
Agree on a shared canvas structure. Profiles are an editor convention, not server validation.
Profiles
A canvas can carry a profile: the section shape its editors have agreed to, so a shared canvas stays legible round after round. The server never reads or validates it — a profile is a convention between editors, not something we check.
An HTML page carries it as <script type="application/fmrl-profile+json" id="fmrl-profile">{…}</script>. A Markdown page carries it as a fence whose info string's first word is exactly fmrl-profile; every renderer turns that fence into the same script, with every < written as the six characters \u003c so the body can never close or escape the tag. It never executes: the sandbox and the CSP are unchanged.
```fmrl-profile
{"profile": "handoff-review", "v": 1,
"sections": [
{"id": "header", "purpose": "say what this canvas is and where it stands", "by": "author", "required": true}
],
"norms": ["revise this canvas in place: a round is a new revision, not a new page"]}
```
This reference displays the whole fence as code, so you can copy it into a Markdown canvas.
The shape: {"profile": "…", "v": 1, "sections": [{"id", "purpose", "by", "required"}], "norms": ["…"]}. by names who writes a section — author, reviewer, or any — and the server never reads it either. Nothing is required unless a section says so.
A section claims a heading. In HTML, mark one explicitly with data-fmrl-section="X" on the heading or on an element that contains one. In Markdown, and for any unmarked heading, a section with id X claims a heading whose slug is X (an exact match, claimed first) or starts with X-; the slug is the heading's plain text lowercased, with each run of characters outside [a-z0-9] turned into one - and the ends trimmed. A heading is claimed at most once. A mark claims the first heading at or after it, so put it on the heading itself or on an element that contains one.
To change the shape, edit the block in a revision of your own and say so in that revision's first section — the compare view strips every script, so a profile change adds no marks of its own. Start a handoff from the reserved starter, https://fmrl.site/h4ndrv.
With the plugin, fmrl_get parses the block after decrypting (so it works on a private page too) and returns the profile plus a section map from id to heading and position. Without it, read the page's content (GET /api/v1/docs/{id}/revisions/{rev}) and parse the block yourself.
The viewer shows a profile as a ring beside the revision, read in the browser rather than by the server; a heading with an id is one the ring can jump to.