Skip to content

Commit 35f4090

Browse files
authored
docs: fix typos and grammar (#879)
1 parent 010a452 commit 35f4090

File tree

11 files changed

+22
-22
lines changed

11 files changed

+22
-22
lines changed

docs/develop.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Developing
22

3-
If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarly with existing Python toolchains.
3+
If you wish to develop for TagStudio, you'll need to create a development environment by installing the required dependencies. You have a number of options depending on your level of experience and familiarity with existing Python toolchains.
44

55
<!-- prettier-ignore -->
66
!!! tip "Contributing"

docs/library/entry.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ File entries are the individual representations of your files inside a TagStudio
44

55
## Storage
66

7-
File entry data is storied within the `ts_library.sqlite` file inside each library's `.TagStudio` folder. No modifications are made to your actual files on disk, and nothing like sidecar files are generated for your files.
7+
File entry data is stored within the `ts_library.sqlite` file inside each library's `.TagStudio` folder. No modifications are made to your actual files on disk, and nothing like sidecar files are generated for your files.
88

99
## Appearance
1010

11-
File entries appear as file previews both inside the thumbnail grid. The preview panel shows a more detailed preview of the file, along with extra file stats and all attached TagStudio tags and fields.
11+
File entries appear as thumbnails inside the grid display. The preview panel shows a more detailed preview of the file, along with extra file stats and all attached TagStudio tags and fields.
1212

1313
## Unlinked File Entries
1414

15-
If the file that an entry is referencing has been moved, renamed, or deleted on disk, then TagStudio will display a red chain-link icon for the thumbnail image. Certain uncached stats such as the file size and image dimensions will also be unavailable to see in the preview panel when a file becomes unlinked.
15+
If the file that an entry is referencing has been moved, renamed, or deleted on disk, then TagStudio will display its unlinked status with a red chain-link icon instead of its thumbnail image. Certain uncached stats such as the file size and image dimensions will also be unavailable to see in the preview panel.
1616

1717
To fix file entries that have become unlinked, select the "Fix Unlinked Entries" option from the Tools menu. From there, refresh the unlinked entry count and choose whether to search and relink you files, and/or delete the file entries from your library. This will NOT delete or modify any files on disk.
1818

@@ -32,11 +32,11 @@ To fix file entries that have become unlinked, select the "Fix Unlinked Entries"
3232
- `date_created` (`DATETIME`/`Datetime`)
3333
- _Not currently used, will be implemented in an upcoming update._
3434
- The creation date of the file (not the entry).
35-
- Generates from `st_birthtime` on Windows and Mac, and `st_ctime` on Linux.
35+
- Generated from `st_birthtime` on Windows and Mac, and `st_ctime` on Linux.
3636
- `date_modified` (`DATETIME`/`Datetime`)
3737
- _Not currently used, will be implemented in an upcoming update._
3838
- The latest modification date of the file (not the entry).
39-
- Generates from `st_mtime`.
39+
- Generated from `st_mtime`.
4040
- `date_added` (`DATETIME`/`Datetime`)
4141
- The date the file entry was added to the TagStudio library.
4242

docs/library/field.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Fields
22

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.
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

55
## Field Types
66

docs/library/library_search.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Searches can be grouped and nested by using parentheses to surround parts of you
3636

3737
<!-- prettier-ignore -->
3838
!!! example
39-
Searching for "(Tag1 `OR` Tag2) `AND` Tag3" will return results any results that contain Tag3, plus one or the other (or both) of Tag1 and Tag2.
39+
Searching for "(Tag1 `OR` Tag2) `AND` Tag3" will return any results that contain Tag3, plus one or the other (or both) of Tag1 and Tag2.
4040

4141
### Escaping Characters
4242

@@ -54,13 +54,13 @@ Sometimes search queries have ambiguous characters and need to be "escaped". Thi
5454

5555
## Tags
5656

57-
[Tag](#tags) search is the default mode of file entry search in TagStudio. No keyword prefix is required, however using `tag:` will also work. The tag search attempts to match tag [names](tag.md#name), [shorthands](tag.md#shorthand), [aliases](tag.md#aliases), as well as allows for tags to [substitute](tag.md#intuition-via-substitution) in for any of their [parent tags](tag.md#parent-tags).
57+
[Tag](#tags) search is the default mode of file entry search in TagStudio. No keyword prefix is required, however using `tag:` will also work. The tag search attempts to match tag [names](./tag.md#name), [shorthands](./tag.md#shorthand), [aliases](./tag.md#aliases), as well as allows for tags to [substitute](./tag.md#intuition-via-substitution) in for any of their [parent tags](./tag.md#parent-tags).
5858

59-
You may also see the `tag_id:` prefix keyword show up with using the right-click "Search for Tag" option on tags. This is meant for internal use, and eventually will not be displayed or accessible to the user.
59+
You may also see the `tag_id:` prefix keyword show up when using the right-click "Search for Tag" option on tags. This is meant for internal use, and eventually will not be displayed or accessible to the user.
6060

6161
## Fields
6262

63-
_[Field](field.md) search is currently not in the program, however is coming in a future version._
63+
_[Field](./field.md) search is currently not in the program, however is coming in a future version._
6464

6565
## File Entry Search
6666

docs/library/tag.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This is a special type of alias that's used for shortening the tag name under sp
2222

2323
Aliases are alternate names that the tag can go by. This may include individual first names for people, alternate spellings, shortened names, and more. If there's a common abbreviation or shortened name for your tag, it's recommended to use the [shorthand](#shorthand) field for this instead.
2424

25-
When searching for a tag, aliases (including the shorthand) can also be used to find the tag. This not only includes searching for tags themselves, but for tagged [file entries](entry.md) as well!
25+
When searching for a tag, aliases (including the shorthand) can also be used to find the tag. This not only includes searching for tags themselves, but for tagged [file entries](./entry.md) as well!
2626

2727
### Automatic Disambiguation
2828

@@ -32,7 +32,7 @@ Given a tag named "Freddy", we may confuse it with other "Freddy" tags in our li
3232

3333
![Tag Disambiguation Example](../assets/tag_disambiguation_example.png)
3434

35-
So if the "Five Night's at Freddy's" tag is added as a parent tag on the "Freddy" tag, and the disambiguation box next to it is checked, then our tag name will automatically be displayed as "Freddy (Five Nights at Freddy's)". Better yet, if the "Five Night's at Freddy's" tag has a shorthand such as "FNAF", then our "Freddy" tag will be displayed as "Freddy (FNAF)". This process preserves our base tag name ("Freddy") and provides an option to get a clean and consistent method to display disambiguating parent categories, rather than having to type this information in manually for each applicable tag.
35+
So if the "Five Nights at Freddy's" tag is added as a parent tag on the "Freddy" tag, and the disambiguation box next to it is checked, then our tag name will automatically be displayed as "Freddy (Five Nights at Freddy's)". Better yet, if the "Five Nights at Freddy's" tag has a shorthand such as "FNAF", then our "Freddy" tag will be displayed as "Freddy (FNAF)". This process preserves our base tag name ("Freddy") and provides an option to get a clean and consistent method to display disambiguating parent categories, rather than having to type this information in manually for each applicable tag.
3636

3737
## Tag Relationships
3838

@@ -62,7 +62,7 @@ Lastly, when searching your files with broader categories such as `Character` or
6262

6363
**_[Coming in version 9.6](../updates/roadmap.md#v96)_**
6464

65-
Component tags will be built from a composition-based, or "HAS" type relationship between tags. This takes care of instances where an attribute may "have" another attribute, but doesn't inherit from it. Shrek may be an `Orge`, he may be a `Character`, but he is NOT a `Leather Vest` - even if he's commonly seen _with_ it. Component tags, along with the upcoming [Tag Override](tag_overrides.md) feature, are built to handle these cases in a way that still simplifies the tagging process without adding too much undue complexity for the user.
65+
Component tags will be built from a composition-based, or "HAS" type relationship between tags. This takes care of instances where an attribute may "have" another attribute, but doesn't inherit from it. Shrek may be an `Ogre`, he may be a `Character`, but he is NOT a `Leather Vest` - even if he's commonly seen _with_ it. Component tags, along with the upcoming [Tag Override](./tag_overrides.md) feature, are built to handle these cases in a way that still simplifies the tagging process without adding too much undue complexity for the user.
6666

6767
## Tag Appearance
6868

docs/library/tag_categories.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ tags:
44

55
# Tag Categories
66

7-
The "Is Category" property of tags determines if a tag should be treated as a category itself when being organized inside the preview panel. Tags marked as categories will show themselves and all tags inheriting from it (including recursively) underneath a field-like section with the tag's name. This means that duplicates of tags can appear on entries if the tag inherits from multiple parent categories, however this is by design and reflects the nature multiple inheritance. Any tags not inheriting from a category tag will simply show under a default "Tag" section.
7+
The "Is Category" property of tags determines if a tag should be treated as a category itself when being organized inside the preview panel. Tags marked as categories will show themselves and all tags inheriting from it (including recursively) underneath a field-like section with the tag's name. This means that duplicates of tags can appear on entries if the tag inherits from multiple parent categories, however this is by design and reflects the nature of multiple inheritance. Any tags not inheriting from a category tag will simply show under a default "Tag" section.
88

99
![Tag Categories Example](../assets/tag_categories_example.png)
1010

docs/library/tag_color.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ TagStudio features a variety of built-in tag colors, alongside the ability for u
44

55
## Tag Color Manager
66

7-
The Tag Color Manager is where you can create and manage your custom tag colors and associated namespaces. To open the Tag Color Manager, go to "File -> Manage Tag Colors" option in the menu bar.
7+
The Tag Color Manager is where you can create and manage your custom tag colors and associated namespaces. You can access the Tag Color Manager from the "File -> Manage Tag Colors" option in the menu bar.
88

99
![Tag Color Manager](../assets/tag_color_manager.png)
1010

docs/updates/roadmap.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ These version milestones are rough estimations for when the previous core featur
113113
- [ ] Stored in `.TagStudio` folder [HIGH]
114114
- [ ] Tagging Panel [HIGH]
115115

116-
Togglebale persistent main window panel or popout. Replaces the current tag manager.
116+
Toggleable persistent main window panel or pop-out. Replaces the current tag manager.
117117

118118
- [ ] Top Tags [HIGH]
119119
- [ ] Recent Tags [HIGH]

docs/updates/schema_changes.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Save Format Changes
22

3-
This page outlines the various changes made the TagStudio save file format over time, sometimes referred to as the "database" or "database file".
3+
This page outlines the various changes made to the TagStudio save file format over time, sometimes referred to as the "database" or "database file".
44

55
---
66

@@ -45,7 +45,7 @@ Migration from the legacy JSON format is provided via a walkthrough when opening
4545
| ------------------------------------------------------------------------------- | ----------------------------------------------------------------------- | ------ | ----------------------------------------------- |
4646
| [v9.5.0-PR4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr4) | [v9.5.1](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.1) | SQLite | `<Library Folder>`/.TagStudio/ts_library.sqlite |
4747

48-
- Adds the `color_border` column to `tag_colors` table. Used for instructing the [secondary color](../library/tag_color.md#secondary-color) to apply to a tag's border as a new optional behavior.
48+
- Adds the `color_border` column to the `tag_colors` table. Used for instructing the [secondary color](../library/tag_color.md#secondary-color) to apply to a tag's border as a new optional behavior.
4949
- Adds three new default colors: "Burgundy (TagStudio Shades)", "Dark Teal (TagStudio Shades)", and "Dark Lavender (TagStudio Shades)".
5050
- Updates Neon colors to use the new `color_border` property.
5151

docs/usage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Create a new tag by accessing the "New Tag" option from the Edit menu or by pres
4141

4242
### Tag Manager
4343

44-
You can manage your library of tags from opening the "Tag Manager" panel from Edit -> "Manage Tags". From here you can create, search for, edit, and permanently delete any tags you've created in your library.
44+
You can manage your library of tags by opening the "Tag Manager" panel from Edit -> "Manage Tags". From here you can create, search for, edit, and permanently delete any tags you've created in your library.
4545

4646
## Editing Tags
4747

docs/utilities/macro.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,11 @@ This tool is a preview of an upcoming feature. When selected, TagStudio will gen
3535

3636
### Auto-fill [WIP]
3737

38-
Tool is in development and will be documented in future update.
38+
Tool is in development and will be documented in a future update.
3939

4040
### Sort fields
4141

42-
Tool is in development, will allow for user-defined sorting of [fields](../library/field.md).
42+
Tool is in development. Will allow for user-defined sorting of [fields](../library/field.md).
4343

4444
### Folders to Tags
4545

0 commit comments

Comments
 (0)