Errors

Every error and warning that tramlines prints contains a key, such as TL_54 in error[TL_54]. The key names the rule of the specification that the document or the schema breaks. Keys that start with TL_ come from the core specification, which every format shares. Keys that start with TLMD_ come from the Markdown specification. Each of the following pages explains the errors of one part of a schema or a document. To find a key, search for it on the site.

Pages

• The schema: faults in the YAML, keys, values, and regular expressions of the schema itself.
• Shapes and templates: the one shape of each rule, and the holes of a template.
• Schema types and keys: the types, keys, key derivations, and bounds of a schema.
• Lifecycle and ids: the lifecycle of a schema, the rules that it gates, and the id template.
• Formats: line formats, and a line that lacks the key of its format.
• Examples and guidance: the examples of the rules and formats of a schema, and its examples.
• Frontmatter: the frontmatter of a document.
• Lines and length: the shape of the lines of a document, its bans, and its length.
• Headings and sections: the headings of a document and the sections they open.
• Sections inside sections: sections that declare a parent, and their numbers.
• Blocks: the blocks that a section contains, and the number of units in each block.
• Kinds of block: the keys, tags, columns, and HTML that each kind of block allows.
• Units: the paragraphs and items that the rules of a block take, select, and count.
• Lines and pairings: the lines of a code block, and the items that pair with the keys of another rule.
• Markers: the markers of a scaffold that a document keeps.
• Scaffolds: the scaffold that a schema derives for a new document.
• Keys and repairs: keys and their anchors, and the text that a repair rewrites.
• The command: errors that stop tramlines validate before it checks a document.

How an error reads

<file>:<line>: error[<KEY>]: <message> (schema <id>, <place of the rule>)

The end of the message names the rule in your schema that the document breaks, by its rule-id, or by its section and its position in the section. A message that quotes an example line shows what the rule expects. An error in the schema file itself names no rule, because the fault is in the schema.