37 lines
1.9 KiB
Markdown
37 lines
1.9 KiB
Markdown
# FFLOW — Frontmatter Flow
|
|
|
|
Set frontmatter properties from the editor with trigger symbols, the way `#` autocompletes tags.
|
|
|
|
Type `@mee`, pick `meeting`: the text `@mee` disappears and the note gets `type: meeting`.
|
|
|
|
## Triggers
|
|
|
|
Each trigger (Settings → FFLOW) has:
|
|
|
|
- **Symbol**: one character that is not a letter, digit or space. `# [ / :` are reserved (tags, links, slash commands, emoji). Default: `@`.
|
|
- **Values from**: *Vault (open list)* lists every value already used for that property in the vault, ranked by use, and accepts new values. *Fixed list* only offers the values listed in the settings. *Flow: …* offers the steps of a flow (see below).
|
|
- **Property** and **value mode** (open and fixed lists): the frontmatter key to write (default `type`); *Single value* replaces the value, *List* appends without duplicates.
|
|
|
|
A trigger fires only at the start of a word (line start or after a space), and never inside frontmatter or code.
|
|
|
|
## Flows
|
|
|
|
A flow is an ordered list of values for one property, e.g. `status`: `todo` → `started` → `in-progress` → `done`.
|
|
|
|
- Each flow adds two commands, **FFLOW: <name>: next step** and **previous step**. Assign hotkeys in Settings → Hotkeys (the *Hotkeys* button opens it filtered on FFLOW).
|
|
- A note without a value, or with a value outside the flow, enters at the first step. At the ends, the move stops unless **Loop** is on.
|
|
- Each step can list cssclasses (space-separated). Moving to a step removes the classes of the flow's other steps from `cssclasses` and adds its own; other classes are kept.
|
|
- A trigger whose values come from a flow applies the same cssclasses, so `!done` and the hotkey give the same result.
|
|
- cssclasses change only through FFLOW (hotkeys or triggers), not when the property is edited by hand.
|
|
|
|
## Development
|
|
|
|
```
|
|
npm install
|
|
npm run build
|
|
```
|
|
|
|
Copy `main.js`, `manifest.json` and `styles.css` to `<vault>/.obsidian/plugins/fflow/`.
|
|
|
|
See [ROADMAP.md](ROADMAP.md) for planned features.
|