matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity
imag/doc/user/src/good-to-know.md
Matthias Beyer db3bb95227 Add user documentation 
This patch adds user documentation in for of a mdbook, using a travis
job for running the build of the book in CI to be sure it builds
properly.

Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
2019-09-01 13:37:05 +02:00

962 B
Raw Blame History

Good to know

There are some things in the imag space that a user might want to know before using imag.

Tags

Tags are text values that can be added to any entry in the imag store. The tag has to satisfy some invariants to be valid:

  1. it has to be all-lowercase
  2. it has no spaces
  3. all characters are alphanumeric

Any entry can have any number of tags. Spelling is not checked.

Finding all entries for a tag "foo" is O(n) where n is the number of entries in the store.

Categories

Categories are more restrictive, but also more powerful. First of all, a category has to exist before an entry can be linked to a category. A category therefor is represented by an entry and if an entry has a category, it is linked to said entry.

So, if you create only category with the name "foo", you cannot set the category "bar" for some entry.

Because categories are linked, finding all entries for a category is trivial and a O(1) operation.