Escribal
Back to Docs

PDF

Links & bookmarks

This group adds navigation to a PDF: clickable links and the bookmarks they can jump to. You can link out to a web address, link from one place in the document to a named spot elsewhere in the same document, and mark those spots so links can find them. It also lets you turn a rectangular area of a page into a clickable “hotspot” that jumps to another page.

Prerequisite: before using any of these instructions, the workflow must already have a PDF created (with Create PDF).

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 PDF), the instruction simply does nothing.

  • Bookmarks and links work together. A bookmark is an invisible named marker placed at a spot in the document; a bookmark link is clickable text that jumps to a bookmark with that name. Create the bookmark with Insert Bookmark, then point a link at it by its name. A link to a name that doesn’t exist simply won’t navigate.

  • Link styling has defaults you can change. The clickable text created by Insert Bookmark Link and Insert External Hyperlink comes out blue and underlined (the usual link look), but Color (hex) and Underline let you change both, and you can additionally make it bold and/or italic. Leaving Color (hex) empty keeps the paragraph’s own color.

  • Where the link appears. Insert Bookmark Link and Insert External Hyperlink each add a new paragraph at the end of the document with the link inside it. Insert Page Link is different: it places an invisible clickable rectangle on a page and adds no visible text.

  • Dynamic values (@name): in a text field (link text, URL, bookmark name) you can type @ followed by the name of a value saved earlier in the workflow, and it will be replaced by that value.

  • “From variable” fields: the @name trick only works in text fields. In this group only Insert Page Link has numeric fields, and every one of them — the two page numbers and the four position and size fields — 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 number from that variable.

    This is mainly for chaining instructions — for example, placing the clickable area wherever an earlier instruction left it. If you only work with fixed values, you can ignore these fields.

Insert Bookmark .pdf

Places an invisible named marker at the current position in the document, so that links elsewhere can jump to it.

When to use it: to mark a destination — a chapter start, a section, a “top of page” — that an Insert Bookmark Link can point to by name.

Parameter Meaning Default Required
Document Document the instruction applies to (current document) No
Bookmark name Name (identifier) of the bookmark; accepts @name my_bookmark Yes (empty = no action)

Important behavior: the bookmark is invisible — it adds no visible text. It is attached to the last paragraph if the document already has one; otherwise a new empty paragraph is created to hold it. If the bookmark name is empty, nothing happens.


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