diff --git a/docs/assets/add_fields.png b/docs/assets/add_fields.png new file mode 100644 index 00000000..2ba458a4 Binary files /dev/null and b/docs/assets/add_fields.png differ diff --git a/docs/assets/datetime_field_editor.png b/docs/assets/datetime_field_editor.png new file mode 100644 index 00000000..b786b98e Binary files /dev/null and b/docs/assets/datetime_field_editor.png differ diff --git a/docs/assets/field_template_editor.png b/docs/assets/field_template_editor.png new file mode 100644 index 00000000..5f465345 Binary files /dev/null and b/docs/assets/field_template_editor.png differ diff --git a/docs/assets/field_template_manager.png b/docs/assets/field_template_manager.png new file mode 100644 index 00000000..82d73e1e Binary files /dev/null and b/docs/assets/field_template_manager.png differ diff --git a/docs/assets/fields_example.png b/docs/assets/fields_example.png new file mode 100644 index 00000000..1dcb2d96 Binary files /dev/null and b/docs/assets/fields_example.png differ diff --git a/docs/assets/text_field_editor.png b/docs/assets/text_field_editor.png new file mode 100644 index 00000000..2e27789a Binary files /dev/null and b/docs/assets/text_field_editor.png differ diff --git a/docs/fields.md b/docs/fields.md index 768e61a8..304c71a1 100644 --- a/docs/fields.md +++ b/docs/fields.md @@ -8,24 +8,53 @@ icon: material/text-box # :material-text-box: Fields -Fields are additional types of metadata that you can attach to [file entries](./entries.md). Like [tags](tags.md), fields are not stored inside files themselves nor in sidecar files, but rather inside the respective TagStudio [library](./index.md) save file. +Fields are extra pieces of information you can add to [file entries](./entries.md), similar to how [tags](tags.md) are added to entries. Fields are useful for storing information that doesn't nessisarily need to be a tag, such as titles, comments, notes, specific dates or times, etc. -## Field Types +To add a field to an entry, click the "Add Field" button in the preview panel. From there you can search and/or select a [field template](#field-templates) to choose from, or create a new one from the search bar. Alternatively you can create new field templates from **Edit -> Manage Field Templates**. -### Text Line +
+ ![Fields Example](assets/fields_example.png) +
Example of tags and various fields on a file entry.
+
-A string of text, displayed as a single line. +## :material-text-box-plus-outline: Field Templates -- e.g: Title, Author, Artist, URL, etc. +Field templates are handy templates to use when adding fields to entries that contain preconfigured options but no actual data. When you add a field to an entry from the "Add Field" button, you choose from a template to add and then fill in the information afterwards. TagStudio includes a handful of field templates to start you off with, but you're free to modify or delete them, or simply create your own. -### Text Box +Field templates can be viewed, created, and deleted from the **Edit -> Manage Field Templates** window. You can also edit field templates from the "Add Field" menu, and create new ones on the fly from the search bar. Note that you can not currently delete field templates from the "Add Field" menu, just like tags. -A long string of text displayed as a box of text. +
+ ![Field Template Manager](assets/field_template_manager.png) +
Field Template Manager from Edit -> Manage Field Templates.
+
-- e.g: Description, Notes, etc. +
+ ![Field Template Editor](assets/field_template_editor.png) +
The field template editor, shown creating a new "Citations" field.
+
-### Datetime +## :material-format-list-bulleted-type: Field Types -A date and time value. +Fields come in a variety of types that are better suited for different types of information, and may provide additional options unique to those types. Single lines are good for fields like titles, while multiline blocks are good for things like comments and notes. -- e.g: Date Published, Date Taken, etc. +### :material-text-box: Text + +Text fields contain a piece of text with the option to display it either a single line or a multiline body of text. + +| Option | Value | Description | +| --------- | ---------- | ------------------------------------------------------------------------ | +| Multiline | True/False | Indicates if the text should be displayed on multiple lines or just one. | + +
+ ![Text Field Editor](assets/text_field_editor.png) +
The text field editor, editing a "Comments" field on an entry.
+
+ +### :material-calendar-month: Datetime + +Datetime fields contain a date and time value. Dates are formatted using the format specified in your application settings. + +
+ ![Datetime Field Editor](assets/datetime_field_editor.png) +
The datetime field editor, expanded to show the date picker.
+