Skip to content

docs: clarify properties prefix rule and add CLI/Bases prerequisites#84

Open
hst368 wants to merge 1 commit into
kepano:mainfrom
hst368:fix-properties-prefix-and-prereqs
Open

docs: clarify properties prefix rule and add CLI/Bases prerequisites#84
hst368 wants to merge 1 commit into
kepano:mainfrom
hst368:fix-properties-prefix-and-prereqs

Conversation

@hst368

@hst368 hst368 commented Apr 25, 2026

Copy link
Copy Markdown

Summary

Two documentation fixes informed by hands-on use that hit real gotchas.

obsidian-bases: the properties: prefix asymmetry is silent

In order, filters, groupBy, and sort, frontmatter properties can be referenced bare (status) or prefixed (note.status) — both work.

But in the top-level properties: configuration block, the bare form is silently ignored: displayName does not apply, and the column header shows the raw frontmatter field name. The asymmetry isn't documented anywhere and is hard to debug because there's no error or warning.

This PR:

  • Adds an explicit "asymmetric prefix rule" note in the Properties section
  • Updates the Schema example and the Task Tracker / Reading List examples to use note.<field> in their properties: blocks
  • Adds a Troubleshooting entry showing the wrong-vs-right pattern

obsidian-bases: Bases plugin may not be enabled

Bases is a core plugin since v1.9, but in vaults that predate v1.9 the plugin can be disabled by defaultcore-plugins.json may show "bases": false. The symptom is that .base files don't appear in the file tree at all and macOS Finder asks "what app should open this?" when double-clicked. Added a one-paragraph Prerequisite note.

obsidian-cli: the "latest version" trap on macOS

Obsidian on macOS has two independent version numbers:

  • The asar bundle (shown in Settings → About) auto-updates
  • The installer at /Applications/Obsidian.app does not

The in-app "check for updates" only covers the asar. So you can be on "latest 1.12.7" by Settings, but still have a stale installer that lacks the CLI binary, and which obsidian returns nothing.

Added a Prerequisites section that documents:

  • The two-version-number gotcha + how to check the installer version
  • The "Enable command line interface" Settings toggle requirement
  • A health-check command
  • A fallback path (direct file edits + URI scheme) for environments where the CLI cannot be installed

Scope

Documentation only. No behavior changes, no formula/syntax changes. Two files modified.

Test plan

  • Reproduced the displayName silent-ignore symptom on Obsidian 1.12.7 with bare frontmatter keys; confirmed note.<field> fixes it
  • Reproduced the macOS installer/asar version mismatch on a system that auto-updated to 1.12.7 asar but had a 1.8.4 installer with no CLI binary
  • Reproduced the disabled-Bases-plugin case in a v1.8 vault that auto-updated; core-plugins.json showed "bases": false

🤖 Generated with Claude Code

obsidian-bases:
- Document the asymmetric prefix rule: in `properties:` config block,
  frontmatter keys must use `note.` prefix or `displayName` is silently
  ignored (column header shows raw field name). In `order`, `filters`,
  `groupBy`, `sort`, the bare form still works.
- Update Schema and Task Tracker / Reading List examples to show the
  `note.` prefix in `properties:` blocks.
- Add a Prerequisite note: Bases is a core plugin and may need to be
  enabled in `core-plugins.json` for vaults that predate v1.9.
- Add a Troubleshooting entry for the displayName-ignored symptom.

obsidian-cli:
- Add Prerequisites section: Obsidian on macOS has two version numbers
  (asar bundle auto-updates, installer does not). The in-app updater
  can report "latest" while installer is too old to ship the CLI
  binary. Document how to check the installer version and reinstall.
- Add health check command and a fallback path for environments where
  the CLI isn't available.

These are documentation-only changes informed by hands-on use that
hit both gotchas (displayName silently ignored, CLI missing despite
"latest version" prompt).
sigrunixia added a commit to sigrunixia/obsidian-skills that referenced this pull request May 23, 2026
sigrunixia added a commit to sigrunixia/obsidian-skills that referenced this pull request May 23, 2026
…sections

Resolves conflict with PR kepano#84. Takes PR kepano#36's comprehensive footnote
examples (named + inline), merges Property Types table and Lists of
Wikilinks subsection into the Properties section, and adds Horizontal
Rules and HTML Content sections. Removes duplicate sections introduced
by the conflict.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
sigrunixia added a commit to sigrunixia/obsidian-skills that referenced this pull request May 23, 2026
sigrunixia added a commit to sigrunixia/obsidian-skills that referenced this pull request May 23, 2026
…sections

Resolves conflict with PR kepano#84. Takes PR kepano#36's comprehensive footnote
examples (named + inline), merges Property Types table and Lists of
Wikilinks subsection into the Properties section, and adds Horizontal
Rules and HTML Content sections. Removes duplicate sections introduced
by the conflict.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant