Skip to content

Commit

Permalink
docs: update field and library pages
Browse files Browse the repository at this point in the history
  • Loading branch information
CyanVoxel committed Feb 1, 2025
1 parent df04d49 commit f5ff4d7
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 24 deletions.
35 changes: 12 additions & 23 deletions docs/library/field.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,23 @@
# Field
# Fields

Fields are the building blocks of metadata stored in [entries](entry.md). Fields have several base types for representing different kinds of information, including:
Fields are additional types of metadata that you can attach to [file entries](entry.md). Like [tags](tag.md), fields are not stored inside files themselves nor in sidecar files, but rather inside the respective TagStudio [library](index.md) save file.

#### `text_line`
## Field Types

- A string of text, displayed as a single line.
- e.g: Title, Author, Artist, URL, etc.
### Text Line

#### `text_box`
A string of text, displayed as a single line.

- A long string of text displayed as a box of text.
- e.g: Description, Notes, etc.
- e.g: Title, Author, Artist, URL, etc.

#### `tag_box`
### Text Box

- A box of [tags](tag.md) defined and added by the user.
- Multiple tag boxes can be used to separate classifications of tags.
- e.g: Content Tags, Meta Tags, etc.
A long string of text displayed as a box of text.

#### `datetime` [WIP]
- e.g: Description, Notes, etc.

- A date and time value.
- e.g: Date Created, Date Modified, Date Taken, etc.
### Datetime [WIP]

#### `checkbox` [WIP]
A date and time value.

- A simple two-state checkbox.
- Can be associated with a tag for quick organization.
- e.g: Archive, Favorite, etc.

#### `collation` [obsolete]

- Previously used for associating files to be used in a [collation](../utilities/macro.md#create-collage), will be removed in favor of a more flexible feature in future updates.
- e.g: Date Published, Date Taken, etc.
3 changes: 2 additions & 1 deletion docs/library/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Library

The library is how TagStudio represents your chosen directory, with every file inside of it being displayed as an [entry](entry.md). You can have as many or few libraries as you wish, since each libraries' data is stored within a `.TagStudio` folder at its root.
The library is how TagStudio represents your chosen directory, with every file inside being represented by a [file entry](entry.md). You can have as many or few libraries as you wish, since each libraries' data is stored within a `.TagStudio` folder at its root. From there the library save file itself is stored as `ts_library.sqlite`, with TagStudio versions 9.4 and below using a the legacy `ts_library.json` format.

Note that this means [tags](tag.md) you create only exist _per-library_.

0 comments on commit f5ff4d7

Please sign in to comment.