# AppleScript Support

Marked includes an AppleScript dictionary for automating preview, export, and workflow integration. You can open documents, control the preview (reload, scroll, highlights, autoscroll, speed read), read statistics, change processors and styles, copy HTML or RTF to the clipboard, and export to most of the same formats available in the File Export menu. Preview headings / table of contents via AppleScript is work in progress (see below).

For URL-based automation (shell scripts, `open` commands, and callbacks), see the URL Handler. AppleScript and the URL handler complement each other: use AppleScript when you need to target a specific document or window, and URLs when a simple `open 'x-marked://...'` call is enough.

Contents

- Viewing the dictionary
- Targeting Marked
- Documents and windows
- Application commands
- Preview control
- Autoscroll and speed read
- Statistics
- Table of contents (work in progress)
- Print with profile
- Export profiles
- Export commands
- `with` options (properties record)
- `convert_to`
- Debugging
- Errors
- Integration with other tools

## Viewing the dictionary

In Script Editor, choose File → Open Dictionary… and select Marked. The dictionary lists commands on the application, document, and window objects, plus export commands in the Marked suite.

On macOS you can browse scripting definitions with Script Editor.

## Targeting Marked

For the standard install:

    tell application "Marked"
    	-- commands here
    end tell

## Documents and windows

Application

- `documents` – open preview documents (ordered list).
- `windows` – preview windows.

Document

- `name` – display name.
- `path` – file path when the document is saved on disk.
- `modified` – whether the document has unsaved editor changes.
- `processor` – Markdown processor for this preview (read/write). Valid names: `MultiMarkdown`, `Discount`, `CommonMark (GFM)`, `Kramdown`. Setting `processor` applies a per-document override and reloads the preview; it does not change the global default in Marked Settings, Processor pane.
- `preprocessor` – preprocessor for this preview (read/write). Use `true` or `false` to enable or disable the custom preprocessor, or a preprocessor name when applicable.
- `source text` – raw Markdown source (read-only).
- `critic markup mode` – whether CriticMarkup processing is enabled (read/write). Changing it reloads the preview.
- `is autoscrolling` – whether autoscroll is active (read-only).
- `is speed reading` – whether speed read mode is active (read-only).
- Preview, reader, statistics, and export commands (see below).

Window

- `document` – the `MarkdownDocument` shown in that window.
- `style` – current preview style name (read/write). Setting `style` reloads the preview with the chosen theme (same as picking a style from the preview style menu).
- `close`, `save`, `print` – standard window commands.
- The same preview, reader, statistics, and export commands as on documents (forwarded to the window’s document).

Prefer `tell document 1` or `tell window 1's document` when exporting a specific preview. Export commands on the application use the key window or current document when no receiver is specified.

### Example: open and read path

    tell application "Marked"
    	open POSIX file "/Users/you/Documents/report.md"
    	set docPath to path of document 1
    end tell

### Example: change preview style

    tell application "Marked"
    	tell window 1
    		set style to "Amblin"
    	end tell
    end tell

Style names match the preview style menu (display name, CSS resource name such as `swiss`, or internal identifier). Custom styles you added in the Style Manager are supported.

Use `get preview style names` on the application object to list enabled style display names.

### Example: processor and source text

    tell application "Marked"
    	tell document 1
    		set processor to "Kramdown"
    		set md to source text
    		set critic markup mode to true
    	end tell
    end tell

## Application commands

These commands apply to the application object (not a specific document).

Command | Description
--- | ---
`open streaming preview` | Open a streaming clipboard preview window.
`preview clipboard` | Open a clipboard preview of the current clipboard contents (same as File New Clipboard Preview (`⇧`+`⌘`+`V`)).
`close all` | Close all open preview documents (no save prompt; Marked does not edit source files).
`get available processors` | List processor names `MultiMarkdown`, `Discount`, `CommonMark (GFM)`, `Kramdown`.
`get preview style names` | List enabled preview style display names.
`get_available_formats` | List supported `convert_to` format names.
`get_available_profiles` | List export profile names (same as the `profiles` property).

Bring Marked to the front with the standard AppleScript `activate` command:

    tell application "Marked"
    	activate
    	open streaming preview
    end tell

## Preview control

Available on document and window. Most of these require a loaded preview WebView.

Command | Parameters | Description
--- | --- | ---
`refresh preview` | — | Reload the preview from the source file (same as Preview Refresh).
`reveal in finder` | — | Reveal the document file in Finder.
`show highlights` | — | Enable keyword highlighting (avoid words, alternates, passive voice, custom lists).
`full screen` | optional `enabled` boolean | Enter, leave, or toggle full-screen preview mode.
`scroll to heading` | `title` or `id` | Scroll to a heading by visible title text or DOM `id`.
`scroll to position` | `percent` or `line` | Scroll by percentage of document height or approximate line number.
`copy html` | — | Copy preview HTML to the clipboard (gear menu or `⇧`+`⌘`+`C`; see Copy HTML).
`copy rtf` | — | Copy rich text to the clipboard.

    tell application "Marked"
    	tell document 1
    		refresh preview
    		show highlights
    		scroll to heading id "introduction"
    		scroll to position percent 50
    		full screen with enabled true
    	end tell
    end tell

## Autoscroll and speed read

Command | Description
--- | ---
`autoscroll` | Start autoscroll. Optional `wpm` integer sets words per minute before starting.
`stop autoscroll` | Stop autoscroll.
`pause autoscroll` | Pause or resume autoscroll.
`speed read` | Start or toggle speed read.
`stop speed read` | Stop speed read.
`pause speed read` | Pause or resume speed read.

Check state with the `is autoscrolling` and `is speed reading` document properties.

    tell application "Marked"
    	tell document 1
    		autoscroll with wpm 250
    		-- or: speed read
    	end tell
    end tell

## Statistics

`get statistics` returns a `statistics_record` with numeric values computed from the current Markdown source (not the formatted strings shown in the statistics drawer).

Property | Description
--- | ---
`word_count` | Word count
`sentence_count` | Sentence count
`character_count` | Character count
`paragraph_count` | Paragraph count
`average_words_per_sentence` | Average words per sentence
`average_syllables_per_word` | Average syllables per word
`complex_word_percentage` | Complex word percentage
`reading_ease` | Flesch reading ease
`fog_index` | Gunning fog index
`grade_level` | Flesch–Kincaid grade level
`gulpease` | Gulpease index (Italian readability; `0` when not applicable)
`gulpease_band` | Gulpease band `1`–`4` (when applicable)
`reading_time_minutes` | Reading time at 250 WPM

    tell application "Marked"
    	set stats to get statistics of document 1
    	set wc to stats's word_count
    	set fog to stats's fog_index
    end tell

## Table of contents (work in progress)

Planned behavior (when complete): nested `heading_item` records from headings in the preview (`h1`–`h6`), not from raw Markdown.

Property | Description
--- | ---
`title` | Heading text
`id` | DOM `id` attribute (empty string when absent)
`level` | Heading level `1`–`6`
`children` | Nested list of `heading_item` records

`headings` (document property) — all levels. `headings levels {2, 3}` (command) — optional filter: only those heading depths (not a range).

    -- Planned; do not rely on this yet
    tell application "Marked"
    	set toc to headings of document 1
    	set filtered to headings levels {2, 3} of document 1
    end tell

Use `id` values with `scroll to heading id "..."` once headings automation is stable.

## Print with profile

`print with profile` applies an export profile’s print settings temporarily, then prints the document (same preference bundle as export profiles from Marked Settings, Export pane).

    tell application "Marked"
    	tell document 1
    		print with profile "Print Letter"
    	end tell
    end tell

Profile names are case-sensitive. After printing, Marked restores the previously active export profile.

## Export profiles

Export profiles store bundles of export/print preferences (margins, headers, TOC options, and similar settings from Marked Settings, Export pane).

Read profile names

    tell application "Marked"
    	set profileList to profiles
    	-- or: get_available_profiles
    end tell

Export with a profile

    tell application "Marked"
    	tell document 1
    		export html to "/Users/you/Desktop/report.html" with profile "My Profile"
    	end tell
    end tell

Profile names are case-sensitive and must match a saved profile exactly.

## Export commands

Export commands are available on the application, document, and window objects. Each command requires a `to` parameter with the output path (POSIX path string or `file` object).

Command | Output
--- | ---
`export markdown` | Markdown (.md)
`export html` | HTML
`export paginated pdf` | Paginated PDF (print layout)
`export continuous pdf` | Continuous-scroll PDF
`export epub` | EPUB
`export docx` | Microsoft Word (.docx)
`export odt` | OpenDocument Text
`export textbundle` | TextBundle
`export rtf` | RTF
`export opml` | OPML

Notes

- Paginated PDF uses the same HTML-to-PDF pipeline as File Export As Save PDF (`Paginated`). It is not available for raw HTML preview documents.
- HTML export uses the rendered preview (what you see in the WebView), not the raw Markdown source file.
- Continuous PDF captures the current preview WebView layout.

### Basic export

    tell application "Marked"
    	tell document 1
    		export paginated pdf to "/Users/you/Desktop/report.pdf"
    	end tell
    end tell

### Export paths and sandboxing

- Use a full POSIX path for the destination file.
- Marked can create intermediate folders when the export path is inside the folder of the open document (for example exporting to `.../MyProject/build/output.pdf` while previewing `.../MyProject/chapter.md`).
- Exports outside the document’s folder require a writable path Marked can access (saved document location, security-scoped bookmarks, or folders you have granted via Open dialogs). If the path is not writable, the command returns an error before export starts.

## `with` options (properties record)

Instead of `with profile`, you can pass a record of options using `with` or `with properties`:

    export paginated pdf to "/path/out.pdf" with {pageSize:"A4", margins:"1in", fontSize:"14"}

AppleScript recognizes these keys directly (they are mapped before export):

Key | Description | Example
--- | --- | ---
`style` | Preview style to apply before export (full preview reload) | `"Amblin"`, `"Swiss"`
`pageSize` | Print page size name | `"A4"`, `"Letter"`
`margins` | Print margins (see below) | `"1in"`, `"1in 2in"`
`fontSize` | Override export/print base font size in points (paginated and continuous PDF) | `"14"`, `"12pt"`

`fontSize` enables the same Custom font size for export/print option from Marked Settings, Export pane. It does not affect Fountain documents, which use fixed screenplay sizing.

When `style` is included, Marked applies that theme, waits for the preview to finish reloading, then exports. You do not need a separate `set style` step.

Other keys in the record can match export preference names from profiles (same keys stored in Marked Settings, Export pane, such as `printBackgrounds`, `printTOC`, `topPrintMargin`). Those values are applied temporarily for the export.

You cannot combine conflicting sources carelessly: if you use `with profile`, load that profile first; if you use a `with` record, profile keys in the record override the current settings for that export.

### Margin shorthand

The `margins` value is a string with one to four measurements. Units: `in`, `cm`, `mm`, `pt`, or `"` for inches. A number without a unit is treated as points.

Values | Meaning
--- | ---
`1in` | All sides
`1in 2in` | Top and bottom `1in`, left and right `2in`
`1in 2in 1in` | Top `1in`, left and right `2in`, bottom `1in`
`1in 2in 1in 2in` | Top, right, bottom, left

    export paginated pdf to "/path/out.pdf" with {pageSize:"A4", margins:"1in 2in"}
    export paginated pdf to "/path/out.pdf" with {style:"Amblin", margins:"1in 2in 1in 2in"}

### Combined example

    tell application "Marked"
    	tell document 1
    		export paginated pdf to "/Users/you/Documents/MyBook/build/book.pdf" with {style:"Amblin", pageSize:"A4", margins:"1in"}
    	end tell
    end tell

## File New Clipboard Preview (`⇧`+`⌘`+`V`)).>`convert_to`

The application object also exposes legacy scripting commands:

- `convert_to` – convert Markdown text or a file path to a format (`html`, `pdf`, `epub`, `docx`, `rtf`, and others), optionally with a `profile` and `output_path`.
- `get_available_formats` – list supported conversion format names.
- `get_available_profiles` – list export profile names (same as the `profiles` property).

`convert_to` remains available for older workflows and AppleScript-only automation.

## Debugging

Enable Debug mode in Marked Settings, Advanced pane (or the debug preference in Settings). Marked then logs AppleScript export steps at Info level with the prefix `[AppleScript]` in Console.app and Marked’s log viewer.

Useful log lines when tracing a paginated PDF export:

- `paginated PDF: fetching preview HTML`
- `HTMLToPDFGenerator: loadHTMLString`
- `HTMLToPDFGenerator: didFinishLoadForFrame`
- `paginated PDF: generator finished`

Long exports (especially paginated PDF) suspend the AppleScript event until completion so clients do not time out mid-export.

## Errors

Failed exports set the script error string on the command (visible in Script Editor and `on error` handlers). Common messages:

- Export path is required.
- Export directory does not exist (outside the document folder).
- Cannot create export directory or permission error writing the file.
- Unknown preview style name.
- Timed out waiting for preview to reload after style change.
- Paginated PDF export timed out or failed while generating pages.

## Integration with other tools

Applications can use Marked’s AppleScript surface to read document metadata. For shell-driven workflows, folder watchers, and editor callbacks, the URL Handler is often simpler. The Marked Bonus Pack includes additional scripts and services.

#### Next up: Command Line Utility ▶

Support Site | Legal | Privacy