Skip to content

Commit f5ff4d7

Browse files
committed
docs: update field and library pages
1 parent df04d49 commit f5ff4d7

File tree

2 files changed

+14
-24
lines changed

2 files changed

+14
-24
lines changed

docs/library/field.md

Lines changed: 12 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,23 @@
1-
# Field
1+
# Fields
22

3-
Fields are the building blocks of metadata stored in [entries](entry.md). Fields have several base types for representing different kinds of information, including:
3+
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.
44

5-
#### `text_line`
5+
## Field Types
66

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

10-
#### `text_box`
9+
A string of text, displayed as a single line.
1110

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

15-
#### `tag_box`
13+
### Text Box
1614

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

21-
#### `datetime` [WIP]
17+
- e.g: Description, Notes, etc.
2218

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

26-
#### `checkbox` [WIP]
21+
A date and time value.
2722

28-
- A simple two-state checkbox.
29-
- Can be associated with a tag for quick organization.
30-
- e.g: Archive, Favorite, etc.
31-
32-
#### `collation` [obsolete]
33-
34-
- 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.
23+
- e.g: Date Published, Date Taken, etc.

docs/library/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Library
22

3-
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.
3+
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.
4+
45
Note that this means [tags](tag.md) you create only exist _per-library_.

0 commit comments

Comments
 (0)