diff --git a/docs/library/field.md b/docs/library/field.md index 0f2a4538e..615bdb942 100644 --- a/docs/library/field.md +++ b/docs/library/field.md @@ -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. diff --git a/docs/library/index.md b/docs/library/index.md index 5464cdf5c..7157aa2ac 100644 --- a/docs/library/index.md +++ b/docs/library/index.md @@ -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_.