Rewrite of the URI page #1006
Rewrite of the URI page #1006
Conversation
Signed-off-by: Sigrunixia <[email protected]>
dbarenholz
left a comment
dbarenholz
left a comment
There was a problem hiding this comment.
Hi Sig -- have some comments as requested. I think this is really nice to have documented.
| - The three-dot menu in the note header | ||
| - The right-click context menu for files in the file explorer | ||
|
|
||
| The command copies an `obsidian://open` URL to your clipboard that points to the note. |
There was a problem hiding this comment.
I find this vague at initial read. I believe the URI isn't exactly obsidian://open, but is obsidian://open?STUFF_HERE_SO_IT_CAN_GET_TO_THE_NOTE. I suppose that's what's meant with "an prefix URL", but I feel like this could be better somehow.
|
|
||
| ## Common parameters | ||
|
|
||
| The following parameters are used across multiple URI actions. Understanding these common parameters will help you construct URIs for different actions more easily. |
There was a problem hiding this comment.
You use URI in this sentence, but URL earlier. Which one would you want to use? Or do you not care for consistency due to the notice at the top of the page?
My opinion: stick to URL on the entire page, with the notice on top explaining that "uhm actually it is URI".
|
|
||
| Specifies which vault to target. Can be either the vault name or the vault ID[^1]. | ||
|
|
||
| - **Vault name**: The human-readable name of your vault (e.g., `my vault`). |
There was a problem hiding this comment.
Since the help docs are not necessarily aimed at developers, I'd caution against a literal example with spaces that should be escaped (my%20vault). It's probably good to be explicit here, and link back to earlier in the page where percent encoding is discussed.
| Specifies which vault to target. Can be either the vault name or the vault ID[^1]. | ||
|
|
||
| - **Vault name**: The human-readable name of your vault (e.g., `my vault`). | ||
| - **Vault ID**: A unique 16-character identifier for the vault (e.g., `ef6ca3e3b524d22f`). Using the vault ID is more reliable if you have multiple vaults with similar names or if you rename your vault. |
There was a problem hiding this comment.
In the same vein, I'd add to this that it also can't accidentally fail due to the percent encoding!
|
|
||
| ### Parameters | ||
|
|
||
| - `vault` — Can be either the vault name or the vault ID[^1]. |
There was a problem hiding this comment.
vault is a common parameter - link to it?
| ### Parameters | ||
|
|
||
| - `vault` — Can be either the vault name or the vault ID[^1]. | ||
| - `query` (optional) — The search term to perform. This should be URI-encoded and can include [[Search#Search operators|search operators]]. |
There was a problem hiding this comment.
Since I'm not too familiar with obsidian search operators: do any of the operators also need to be encoded?
Also URI vs URL?
|
|
||
| ### Parameters | ||
|
|
||
| - `vault` (optional) — Can be either the vault name or the vault ID[^1]. If not provided, the current or last focused vault will be used. |
|
|
||
| ## Troubleshooting | ||
|
|
||
| ### Register Obsidian URI |
| On Windows and macOS, running the app once should be sufficient to register the Obsidian URI protocol on your computer. | ||
|
|
||
| On Linux, it is a much more involved process: | ||
| On Linux, the process is more involved: |
There was a problem hiding this comment.
"unless using the flatpak, which does the following for you" :)
2 participants
This is a rewrite of the Obsidian URI page based on mod feedback and issues. It attempts to make it easier to navigate, and adds more examples.
However, I am not confident in my restructure and examples URI as I don't use them much. So would appreciate some second looks.
This PR would:
close #892
close #1002