Skip to content

Documentation - Clarify Wikilinks use of Autopicker #739

Description

@OmnivorousKumquat

Suggestions

  1. Update the terms in https://zennotes.org/docs#palette-navigation to say "... the wikilink [[ reference picker...'
  2. Update the terms in https://zennotes.org/docs#editing-inline-authoring-aids under '[[' from "Type [[target]] or [[target|label]]. Filters notes, images, PDFs, SVGs, and CSV databases. Pick a database to drop a [[Database]] link that opens its grid." to "type [[target]] or [[target|label]]. Filters notes, images, PDFs, SVGs, and CSV databases. Pick a database to drop a [[Database]] link that opens its grid. Opens a reference picker to select from existing references."

Rationale

This morning I was struggling to stay on the keyboard while linking an existing note in a piece of text I was writing, because I couldn't figure out how to scroll through the list of suggestions. While I could have just kept typing the name of the note I wanted, I wanted to browse through them.

I looked through the documentation page for the terms "autosuggestion" or "suggest" or "select" or "selector" or similar terms. I didn't find what I was looking for and gave up, went back to Zen Notes Desktop, and tried a few more key combos and chords until I happened to guess that I should use Ctrl+j/k/n/p/up-arrow/down-arrow. Going back to the docs and searching for ctrl+j, I found the "Move within any open palette or picker" section. I then searched for 'picker' to see if I missed it or there was a better description of it, and didn't find anything super clear, aside from "These apply once a palette, search overlay, or picker already has focus — the command palette, note search, vault text search, outline, buffer switcher, the [[ reference picker, the / slash menu, and the date and template pickers." To me, the use of the term "... the [[ reference picker..." isn't very clear.

I don't know if Obsidian uses the 'picker' terminology, nor did I find that meaningful section. I do know the term 'wikilink' though, which didn't help me find it easier, and therefore brings me to my main suggestions.

Further Work

This may also warrant an addition to the guiding text at the bottom of the picker dialog (i.e. "Type | to change Display Text..." etc.) to indicate how to scroll, but that's beyond the scope of the documentation.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationeditorEditing surface: live preview, links, images, assets

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions