Escribal
Back to Docs

Text Doc

Lists

This group of instructions creates and manages bulleted and numbered lists in a document: turning paragraphs into a bullet or numbered list, defining a multilevel (nested) list, changing the bullet symbol or the number format of an existing list, promoting or demoting list items between levels, and controlling whether a list continues the previous numbering or restarts.

Prerequisite: before using any of these instructions, the workflow must already have a DOCX document created or opened (with Create text doc), which these instructions will act upon.

These concepts recur across several 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.

  • Dynamic values (@name): in any text field you can type @ followed by the name of a value saved earlier in the workflow, and it will be replaced by that value. For example, if you saved a bullet symbol in myBullet, you can type @myBullet in the Bullet char field.

  • Numbering Id — how lists are identified: every list created in the document gets a numbering Id, a number that identifies it. The three Insert… instructions can save the Id of the list they create (see Save numbering Id in), and the instructions that change an existing list (Change Bullet Char, Change Numbering Format, Set List Numbering Continuation, and optionally Change List Item Level) use a Numbering Id field to say which list they act on. Save the Id when you create the list and reuse it later.

  • Search text — which paragraphs are affected (for Insert Bullet List, Insert Numbered List, Change List Item Level, and Set List Numbering Continuation): these instructions have a Search text field that decides which paragraphs they change:

    • If you leave it empty, the instruction is applied to every paragraph in the document.
    • If you type some text, only paragraphs whose text contains that text are affected.
  • Case sensitive: for the instructions that use Search text, this decides whether the match distinguishes between upper- and lower-case. It is off by default (so Title also matches title).

  • The value -1 means “all” (only for Change Bullet Char): its Level number field accepts -1 (the default) to change all bullet levels of the list at once.

  • Saving a result: the three Insert… instructions offer a Save numbering Id in field that stores the new list’s Id under a name, so you can reuse it later. If left empty, nothing is saved.

  • “From variable” fields: the @name trick only works in text fields. So that a numeric field (like Numbering Id, Level number, Start at, or Level count) or a yes/no field (like Restart) can also take its value from a saved value, each one has a companion “from variable” field:

    • If you leave it empty, the value 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 uses that variable’s value.

    This is mainly for chaining instructions. For example, an Insert Numbered List instruction can save the Id of the list it creates; then a Set List Numbering Continuation with the Numbering Id (from variable) field pointing at that value will act on exactly that list, without you having to know its number in advance. If you only work with fixed values, you can ignore these fields.

Change Bullet Char .docx

Changes the bullet symbol (and its font) of an existing bullet list.

When to use it: to swap the bullet character of a list you already created — for example, from • to a dash.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Numbering Id Id of the list to change 1 No
Level number Which level to change (1 = the first level); -1 changes all bullet levels -1 (all) No
New bullet char The new bullet symbol. Supports @name • No
Bullet font Font used to draw the bullet symbol. Supports @name Symbol No
Numbering Id (from variable) Reads the Id from a saved value (empty) No
Level number (from variable) Reads the level number from a saved value (empty) No

Important behavior: only levels whose format is bullet are changed; numeric levels are skipped — pointing this instruction at a numbered list does nothing (use Change Numbering Format to turn a level into a bullet first). If the list Id (or its definition) does not exist, nothing happens.


Change List Item Level .docx

Promotes or demotes the matching list items by one level (outdent or indent within the list hierarchy).

When to use it: to turn a top-level item into a sub-item, or vice versa, without rebuilding the list.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Search text Only paragraphs containing this text are affected; empty = all. Supports @name (empty) No
Direction down demotes (deeper level), up promotes (shallower level). Supports @name down No
Numbering Id Id of the list whose items are affected; -1 = every list -1 (all) No
Case sensitive Whether the search-text match is case-sensitive No No
Numbering Id (from variable) Reads the Id from a saved value (empty) No
Case sensitive (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: only paragraphs that are already list items are affected. down increases the level (up to a maximum of 8), up decreases it (down to 0). Any Direction other than up is treated as down.


Change Numbering Format .docx

Changes the number format of one level of an existing list.

When to use it: to switch a numbered list from, say, 1, 2, 3 to I, II, III, or to convert a level to bullets.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Numbering Id Id of the list to change 1 No
Level number Which level of the list to change (1 = the first level); -1 changes all levels -1 (all) No
Format The list format, chosen from a fixed list: Bullet · Decimal (1, 2, 3) · Upper roman (I, II, III) · Lower roman (i, ii, iii) · Upper letter (A, B, C) · Lower letter (a, b, c) · Ordinal (1st, 2nd, 3rd) Decimal No
Numbering Id (from variable) Reads the Id from a saved value (empty) No
Level number (from variable) Reads the level number from a saved value (empty) No

Important behavior: the level text and font are synced to the new format automatically: a bullet level gets a • in the Symbol font, while a numeric level gets a number pattern (like 1.) and drops the bullet font. If the list or the level does not exist, nothing happens.


Insert Bullet List .docx

Turns the matching paragraphs into a bulleted list.

When to use it: to convert plain paragraphs into a bullet list with a chosen symbol.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Search text Only paragraphs containing this text become bullets; empty = all paragraphs. Supports @name (empty) No
Bullet char The bullet symbol. Supports @name • No
Bullet font Font used to draw the bullet symbol. Supports @name Symbol No
Case sensitive Whether the search-text match is case-sensitive No No
Case sensitive (from variable) Reads the yes/no value from a saved value (empty) No
Save numbering Id in Name under which to save the new list’s Id (empty) No

Important behavior: this creates a new single-level bullet list and applies it to the matching paragraphs. Save its Id if you plan to change or continue the list later.


Insert Multilevel List .docx

Defines a multilevel (nested) list with a chosen number of levels.

When to use it: to prepare a nested outline structure — for example 1 → 1.1 → 1.1.1 — or nested bullets with a different symbol per level.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Level count Number of levels, from 1 to 9 3 No
Format The list format, chosen from the same fixed list as the other list instructions: Bullet · Decimal (1, 2, 3) · Upper roman (I, II, III) · Lower roman (i, ii, iii) · Upper letter (A, B, C) · Lower letter (a, b, c) · Ordinal (1st, 2nd, 3rd) Decimal No
Level count (from variable) Reads the level count from a saved value (empty) No
Save numbering Id in Name under which to save the new list’s Id (empty) No

Important behavior: with Bullet, each level gets its own symbol; with any of the numbering formats, levels are nested and numbered in that format (1.1.1., I.II.III., and so on). Level count is clamped to the range 1–9. This instruction creates the list definition and saves its Id but does not, by itself, attach the list to any paragraph.


Insert Numbered List .docx

Turns the matching paragraphs into a numbered list.

When to use it: to convert plain paragraphs into an ordered list, optionally in Roman numerals or letters and starting from a chosen number.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Search text Only paragraphs containing this text are numbered; empty = all paragraphs. Supports @name (empty) No
Format The numbering format, chosen from a fixed list: Decimal (1, 2, 3) · Upper roman (I, II, III) · Lower roman (i, ii, iii) · Upper letter (A, B, C) · Lower letter (a, b, c) · Ordinal (1st, 2nd, 3rd) Decimal No
Start at The first number of the list 1 No
Case sensitive Whether the search-text match is case-sensitive No No
Start at (from variable) Reads the starting number from a saved value (empty) No
Case sensitive (from variable) Reads the yes/no value from a saved value (empty) No
Save numbering Id in Name under which to save the new list’s Id (empty) No

Important behavior: this creates a new single-level numbered list and applies it to the matching paragraphs.


Set List Numbering Continuation .docx

Makes the matching list paragraphs either continue the previous numbering or restart it from a chosen value.

When to use it: when a numbered list has been interrupted and you want the later part to keep counting on from where it left off, or to restart at a specific number.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Search text Only paragraphs containing this text are affected; empty = all. Supports @name (empty) No
Numbering Id Id of the list to apply 1 No
Restart No = continue the previous numbering; Yes = restart from Restart value No (continue) No
Restart value The number to restart from (used only when Restart is Yes) 1 No
Case sensitive Whether the search-text match is case-sensitive No No
Numbering Id (from variable) Reads the Id from a saved value (empty) No
Restart (from variable) Reads the yes/no value from a saved value (empty) No
Restart value (from variable) Reads the restart value from a saved value (empty) No
Case sensitive (from variable) Reads the yes/no value from a saved value (empty) No

Important behavior: if the list Id does not exist, nothing happens. When Restart is Yes the numbering restarts from Restart value; when No, any restart override is removed so the list continues. The matching paragraphs are assigned to the list — a paragraph that already has a level keeps it, and one without a level starts at the first level.


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