out-of-cheese-error / gooseberry

A command line utility to generate a knowledge base from Hypothesis annotations
Apache License 2.0
152 stars 9 forks source link

Unsure about the acceptable characters for tags #79

Closed ngirard closed 3 years ago

ngirard commented 3 years ago

Okay, this is more of a question than an issue per se, but since I'm tring to get back to Hypothes.is and can't remember which characters can be part of a tag, I thought it could be worth adding that info to the docs.

(What I'm trying to come up with is a controlled vocabulary with facets, so something like parent:child1 / parent:child2 or parent/child1 / parent/child2 -- whatever form Hypothes.is would be nice enough to accept).

Ninjani commented 3 years ago

As far as I know hypothesis allows pretty much anything in a tag. I use the parent/child1 method because I export to Obsidian which uses "/" to specify tag hierarchy. Gooseberry doesn't allow the semicolon ; character because it's used as the separator in the sled database (though this may change later with SQLite)

ngirard commented 3 years ago

Thanks ! I'm very fine with / as a delimiter, being an Obsidian user myself ;-)

Ninjani commented 3 years ago

Great! One point: you'll have to include the # that Obsidian needs either in the tag itself or in the annotation export template (I use it in the template since I feel it adds some visual clutter when looking at the annotation in the browser)

ngirard commented 3 years ago

Makes sense, thanks for the tip!