Escribal
Back to Docs

Markdown

Links & images

This group adds links and images to a Markdown document: plain links, links with a tooltip, reference-style links, autolinks, images (optionally sized) and reference-style images. Each instruction appends its content at the current 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, they don’t search or replace. Each one appends its link or image after whatever is already in the document. Nothing is removed or looked up.

  • The target is required; the visible text is not. Every instruction here needs its destination — the Url, the Url or email, or the Reference id (plus the Url of its definition). If any of those is empty, the instruction does nothing, instead of writing a broken link or image such as [](). The Text and Alt text fields, on the other hand, may be left empty: an image with no alt text or a link with no label is valid Markdown.

  • Dynamic values @name: every text field (such as Text, Url, Alt text, Title, Reference id, Url or email) 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 numeric fields Width and Height (in Insert Image With Size) each have 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 size from that variable.

    This is mainly for chaining instructions (for example, an earlier instruction measures or saves a size that Insert Image With Size then reads). If you only work with fixed values, you can ignore it.

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

Insert Image .md

Adds an image, shown at its natural size.

When to use it: to place a picture in the document by its file path or web address.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Alt text Text shown if the image can’t load, and for accessibility (accepts @name) (empty) No
Url The image’s path or web address (accepts @name) (empty) Yes

Important behavior: if Url is empty, nothing happens. Otherwise it is written as ![Alt text](Url); Alt text may be left empty.

Insert Image With Size .md

Adds an image with an explicit width and/or height.

When to use it: when you need the picture shown at a specific size rather than its natural one. (Note: sizing relies on a Markdown extension; not every viewer honors it.)

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Alt text Text shown if the image can’t load, and for accessibility (accepts @name) (empty) No
Url The image’s path or web address (accepts @name) (empty) Yes
Width The width in pixels; 0 = don’t set it 0 No
Height The height in pixels; 0 = don’t set it 0 No
Width (from variable) Reads the width from a saved value (empty) No
Height (from variable) Reads the height from a saved value (empty) No

Important behavior: if Url is empty, nothing happens. Otherwise it is written as ![Alt text](Url){...} with the size attributes. Only sizes greater than 0 are written: if both are 0, no size attributes are added (it behaves like a plain image); if only one is set, only that one is written.

Insert Reference Image .md

Adds a reference-style image: an image that points to a named reference, plus the definition of that reference below.

When to use it: when the same image address is reused, or to keep long addresses out of the main text by referring to them by a short id.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Alt text Text shown if the image can’t load, and for accessibility (accepts @name) (empty) No
Reference id The short id linking the image to its definition (accepts @name) (empty) Yes
Url The image’s path or web address (accepts @name) (empty) Yes

Important behavior: if Reference id or Url is empty, nothing happens (the reference would point nowhere). Otherwise two lines are added — the reference ![Alt text][Reference id] and, below it, the definition [Reference id]: Url. Use the same Reference id to keep the two linked.

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