Edit a profile as Markdown
Open a profile document as Markdown, follow the shape ZotLit enforces, and read the faults the Problems area reports.
Edit the profile document itself when you would rather type Markdown than use the Workbench tabs. A profile is an ordinary note in your vault, and ZotLit keeps it editable even while it reports a fault.
Open the document as Markdown
Open the document in Obsidian's Markdown editor
In the file explorer, open the profile document like any other note. From the Workbench, select 源码 to edit the complete document in one editor, or open the pane menu and select 以 Markdown 打开, which saves the document first and then switches that pane to Obsidian's Markdown editor.
Edit the document and save
Type the change and save the file. ZotLit keeps the document editable, so a fault never costs you the text.
Return to the Workbench
The view header carries 打开模板工作台, which reopens the same document in the Workbench, with its preview and its problems. In the Workbench window, the pane switches back to the Workbench. In the main window, ZotLit opens the Workbench window and keeps the Markdown editor open.
The shape ZotLit enforces
A profile document has four parts, in this order: the manifest, the note source, an optional managed block, and the Annotation Section. Profile document carries each part, its boundaries, and a sample file.
Before you save, these must all be true:
- The first line of the file is exactly
---, and one later---line closes the manifest. idis 12 letters or digits, and no other profile document in the folder carries the same one. Profiles that share an ID are all excluded from ZotLit.- The note source holds at most one managed block, opened with
{% managed %}and closed with{% endmanaged %}. ZotLit re-renders that block alone when you update a note, and leaves the rest of the source as you wrote it. See Literature notes and the managed region for what an update rewrites. - Exactly one
--- zotlit:annotation ---line appears, after the note source. - A document with
id: defaultcarries neither Match conditions nor bindings. - The properties ZotLit writes belong in the manifest, not in a note. See Frontmatter for the entry forms, the merge strategies, and the reserved keys.
What the Problems area reports
A document that breaks one of those rules is never rejected. Fix it where you type: ZotLit keeps the document editable and lists each fault in the 问题 area at the bottom of the Workbench pane, with the recovery it suggests. Work through the entries and save; the area recomputes as you edit, so an entry clears once the document no longer breaks its rule.
| What breaks | The Problems area reports |
|---|---|
| The file does not open with a manifest | 此文件不是配置方案文档。 |
| The manifest is not valid YAML, or a key fails validation | 清单无效。 |
A manifest partial is named annotation | 片段名“annotation”为标注分节保留。 |
| The note source holds more than one managed block | 您的笔记中有多个托管块。 |
| The managed block is not opened and closed correctly | 托管块未能正确打开和关闭。 |
| A section header other than the annotation line appears | 此行不是配置方案的分节标题。 |
| The Annotation Section is absent | 此配置方案没有标注分节。 |
| The Annotation Section appears more than once | 此配置方案有多个标注分节。 |
The Problems area also offers 复制错误报告, so you can paste the whole report into a bug report. See Collect debug logs for the rest of that report.
See also
Profile document
The manifest, the note source, the managed block, and the Annotation Section.
Frontmatter
The properties a profile writes into a note, and how it merges them.
Template Workbench View
The tabs, the preview, and the modes that edit a profile.
Profiles
What a profile is, and how a note keeps the one that made it.
Last updated on