diff --git a/README.md b/README.md index edacb05..b9b1e1d 100644 --- a/README.md +++ b/README.md @@ -182,6 +182,47 @@ A single number (`## Word Count Target: 1800`) sets a point goal; ranges accept `-`, `–`, `to`, and grouped digits (`1,500`). Like the other header lines, the target is stripped from the exported document. +### YAML frontmatter for planning metadata + +For projects using the **snowflake template** or similar structured workflows, files +can store planning metadata in **YAML frontmatter** at the top of the file. This keeps +all planning information (target word count, POV, characters, setting, etc.) together with +the draft content in a single file, while allowing the metadata to be collapsed in the +editor. + +```markdown +--- +title: "Chapter One: The Beginning" +slug: chapter-one-the-beginning +act: 1 +chapter: 1 +scene: 1 +type: chapter +status: draft +word_count_target: 2000 +word_count_min: 1800 +word_count_max: 2200 +pov: "Bixby" +characters: + - Bixby + - Mom +setting: "The Old Reynold's House" +--- + +# Chapter One: The Beginning + +The prose begins here... + +### Rough Draft: + +Actual draft content... +``` + +The YAML frontmatter (delimited by `---` lines) is automatically detected and can be +collapsed in the editor using the **Collapse header** toggle in the top bar. The +draft marker (`### Rough Draft:`) is still supported for backward compatibility with +legacy files. + ## Project mode Open a **project root** — a folder holding the manuscript alongside the @@ -189,7 +230,7 @@ characters, outline, premise and the rest — and the app recognises the layout instead of treating every file in it as a chapter. The trigger is simple: if the folder you open contains a subfolder named like -the **manuscript folder** (`06-First Draft` by default), it is a project. A +the **manuscript folder** (`05-First Draft` by default), it is a project. A plain folder of chapters has no such subfolder, so it behaves exactly as before — everything in it is the manuscript. @@ -212,9 +253,8 @@ In a project: * **File ▸ New project…** opens the project root, not the drafting folder. Set which folder is the manuscript under **Settings ▸ New project… ▸ Manuscript -folder**. The number is optional — `First Draft` matches `06-First Draft` — and +folder**. The number is optional — `First Draft` matches `05-First Draft` — and the setting is global, so every project on this machine uses the same layout. -If your writing actually lives in `05-Plot`, point it there. ### Hidden folders @@ -531,7 +571,7 @@ Nothing is written until you press **Create**; generation runs in the background so a template whose hooks talk to the network doesn't freeze the editor. When it finishes, the app opens the project root as the workspace, -with the **`06-First Draft`** folder (where the snowflake template keeps the +with the **`05-First Draft`** folder (where the snowflake template keeps the chapter files in `Act 1/`, `Act 2/` and `Act 3/` subfolders) automatically expanded in the file list. If the template didn't produce that folder, the status bar notes that nothing is marked as the manuscript. @@ -551,7 +591,7 @@ rendering. | Setting | Meaning | |---|---| | **Template** | the folder holding the template's `cookiecutter.json`. Defaults to the bundled `templates/snowflake`; falls back to `~/Documents/Cookiecutters/snowflake` | -| **Open subfolder** | which folder of the generated project becomes the workspace (default `06-First Draft`; blank opens the project root) | +| **Open subfolder** | which folder of the generated project becomes the workspace (default `05-First Draft`; blank opens the project root) | | **Publish to Gitea after creation** | when enabled and Gitea credentials are configured below, a new repository will be created and the project pushed to it | | **Gitea** | server URL, user and token, used to create repositories when publishing is enabled | @@ -667,7 +707,7 @@ Word list…** is that place. every name in them at once. It looks for a `Characters` folder (a numeric prefix like `03-Characters` is fine) beside the workspace and up to three levels above it, so it still finds them while you are editing in - `06-First Draft`. Both `# Bixby Reynolds` and `# Name: Jonathan Bronski` + `05-First Draft`. Both `# Bixby Reynolds` and `# Name: Jonathan Bronski` headings are understood, and an unfilled template sheet (`# Name`, `# Protagonist`) contributes nothing. Each part of a name is listed separately, since prose says *Bixby* far more often than *Bixby Reynolds*.