Escribal
Back to Docs

Markdown

Block elements

This group adds structural pieces to a Markdown document: headings, paragraphs, quotes, code blocks, horizontal rules, footnotes, abbreviations and math (block or inline). Each instruction appends its content to the end of the document.

Prerequisite: the workflow must already have a Markdown document created (with Create Markdown) or opened. Every instruction here works on that open document.

These concepts recur across the instructions in this group; they are explained here once.

  • Document: indicates which document in the workflow the instruction applies to. If left empty, the current document is used. If the document doesn’t exist (or is not a Markdown/text document), the instruction simply does nothing.

  • These instructions add content to the end of the document. They don’t search or replace; each one appends a new element after whatever is already there.

  • Dynamic values @name: every text field (such as Text, Code, Language, Term, Definition, Latex, Reference id) accepts a saved value: type @ followed by its name and the engine substitutes the value at run time. This does not apply to numeric fields.

  • “From variable” fields: the only numeric field in this group, Level (in Insert Heading), has a companion “from variable” field:

    • If you leave it empty, the number typed in the normal field is used.
    • If you fill it in with the name of a saved value, the engine ignores the normal field and reads the level from that variable.

    This is mainly for chaining instructions (for example, an earlier instruction saves a heading level that Insert Heading then reads). If you only work with fixed values, you can ignore it.

  • An empty essential field means “do nothing”: every instruction here needs its main content (Text, Code, Latex, Term, Reference id). If that field is empty, the instruction is skipped rather than writing an empty or broken element into the document.

  • No results are saved: the instructions in this group only add content; none of them save a value.

Insert Abbreviation .md

Adds an abbreviation definition. Wherever the term later appears in the document, it is shown as an abbreviation with the meaning you give here.

When to use it: to declare what an acronym or short term stands for (for example, “HTML” → “HyperText Markup Language”).

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Term The abbreviation itself (accepts @name) (empty) Yes
Definition What the term stands for (accepts @name) (empty) No

Important behavior: if Term is empty, nothing happens. The definition is written as *[Term]: Definition on its own line.

Insert Blockquote .md

Adds a block quote — the given text with each line marked as a quotation.

When to use it: to highlight a citation, a note or an excerpt set apart from the regular text.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Text The text to quote (accepts @name) (empty) Yes

Important behavior: if Text is empty, nothing happens. Multi-line text is quoted line by line (each line gets a > marker).

Insert Code Block .md

Adds a fenced code block, optionally tagged with a programming language for syntax highlighting.

When to use it: to show a snippet of code or any text that must be kept exactly as typed, in a monospaced block.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Code The code (or text) to place in the block (accepts @name) (empty) Yes
Language The language name for highlighting, e.g. python (accepts @name) (empty) No

Important behavior: if Code is empty, nothing happens (no empty code block is left behind). Language is optional; leave it empty for a plain code block.

Insert Footnote .md

Inserts a footnote: a small reference marker in the text plus its definition below.

When to use it: to add a note, a source or a clarification that is linked from a point in the text.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Reference id The footnote’s identifier, e.g. 1 (accepts @name) 1 Yes
Definition text The note’s content (accepts @name) (empty) No

Important behavior: if Reference id is empty, nothing happens (a footnote without an identifier would be invalid). Otherwise the instruction adds both the marker [^id] and its definition line [^id]: text. Use the same Reference id to keep marker and definition linked.

Insert Heading .md

Adds a heading at the level you choose (1 = top level, 6 = deepest).

When to use it: to start a new section or subsection in the document.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Text The heading text (accepts @name) (empty) Yes
Level The heading level, from 1 (top) to 6 (deepest) 1 No
Level (from variable) Reads the level from a saved value (empty) No

Important behavior: if Text is empty, nothing happens. The level is clamped to the 1–6 range (values outside it are brought back into range).

Insert Horizontal Rule .md

Adds a horizontal rule — a full-width dividing line.

When to use it: to separate two parts of the document with a visible break.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No

Important behavior: always adds a --- divider followed by a blank line. It has no other options.

Insert Inline Math .md

Adds a math expression inline — written in LaTeX and rendered within the surrounding text.

When to use it: to include a formula or symbol in the middle of a sentence.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Latex The math expression in LaTeX (accepts @name) (empty) Yes

Important behavior: if Latex is empty, nothing happens. Otherwise the expression is inserted between single $ markers, in line with the text (no surrounding blank lines).

Insert Math Block .md

Adds a block-level math expression — written in LaTeX and displayed on its own, centered line.

When to use it: to present an important or standalone formula separated from the text.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Latex The math expression in LaTeX (accepts @name) (empty) Yes

Important behavior: if Latex is empty, nothing happens. The expression is placed between $$ fences on their own lines.

Insert Paragraph .md

Adds a paragraph of regular text.

When to use it: to write ordinary body text into the document.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Text The paragraph text (accepts @name) (empty) Yes

Important behavior: if Text is empty, nothing happens (no blank paragraph is added). Otherwise the paragraph is added, followed by a blank line.

Insert Table Of Contents .md

Inserts an index of the headings of the document, with a link to each one.

When to use it: for a long document that is read on screen — documents and PDF already had their own index, Markdown could only read it, not write it.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Max level Deepest heading level to list, 1 to 6 6 No
At top Yes = at the beginning, No = at the end Yes No
Max level (from variable) Reads the level from a saved value (empty) No
At top (from variable) Reads yes/no from a saved value (empty) No

Important behavior: if the document has no headings, nothing is inserted — an empty index is worse than no index. The level is capped between 1 and 6. The index is written where you choose, and the document is kept as it was.

This documentation is the help of the application, and it comes underCreative Commons Attribution 4.0.