Get Compile & Taxonomy Settings
get_compile_settingsRetrieve compile-format definitions and taxonomy from an open Scrivener project to inspect formatting options before compiling.
Instructions
Return the project's compile-format definitions (from Settings/compile.xml) and its taxonomy: the named compile formats and their section-layout counts, the current output file type, label and status definitions (with colors), saved collections, and user-defined section types. Use this to discover what compile formats and metadata categories a project defines before compiling or organizing. Read-only; does not run a compile. If a project has never been compiled, hasCompileSettings is false and only the taxonomy is returned. Requires an open project (call open_project first).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| labels | No | Label definitions with colors. | |
| options | No | Global compile options. | |
| statuses | No | Status definitions. | |
| collections | No | Saved collections (binder, saved searches, groups). | |
| sectionTypes | No | User-defined section types (Scene, Chapter, Part Heading, ...). | |
| compileFormats | Yes | Named compile formats the project defines. | |
| currentFileType | No | Default output file type of the last-used compile (e.g. "pdf"). | |
| hasCompileSettings | Yes | False when Settings/compile.xml is absent or unreadable. |