Skip to main content

RQML Reference

The current RQML schema is served at /schema/rqml-2.1.0.xsd. Use this page as an entry point to the element/attribute reference.

Common patterns​

  • IDs: IdType tokens, 2–80 chars, start with a letter; allow letters, digits, ., _, -. Keep stable across revisions.
  • References: goalLink, edge locators, and testSuite/members all point to existing IDs; the schema enforces this with keyrefs.
  • Trace endpoints: edge elements use structured locator elements with local (same document, keyref-validated), doc (cross-document), or external (non-RQML URI) references.
  • Language: Use clear, testable prose; avoid ambiguity. Text blocks allow mixed content for formatting.
  • Cardinality: Required elements are noted in each element page; optional sections may be omitted entirely.

Versioning​

  • Documents must set rqml@version to match the schema version, along with required docId and status.
  • Validate with xmllint --schema /path/to/rqml-x.y.z.xsd yourfile.rqml --noout.

Elements A–Z​

B​

C​

D​

G​

I​

M​

R​

S​

T​

V​

Attributes A–Z​

A​

C​

D​

I​

M​

O​

P​

S​

T​

V​