From c9e663d28cd39c543c6fbbbe811fab58e45d4993 Mon Sep 17 00:00:00 2001 From: Travis Abendshien <46939827+CyanVoxel@users.noreply.github.com> Date: Thu, 18 Sep 2025 02:39:28 -0700 Subject: [PATCH] docs: futher layout changes --- docs/changelog.md | 135 ++++++------------ docs/colors.md | 12 +- docs/contributing.md | 12 +- docs/developing.md | 2 +- docs/entries.md | 2 +- docs/fields.md | 4 +- docs/help/ffmpeg.md | 2 +- docs/ignore.md | 2 +- docs/index.md | 22 +-- docs/install.md | 4 +- docs/{library.md => libraries.md} | 6 +- ...{library_changes.md => library-changes.md} | 2 +- docs/macros.md | 10 +- ...{preview_support.md => preview-support.md} | 10 +- docs/roadmap.md | 62 ++++---- docs/search.md | 6 +- docs/style.md | 2 + docs/stylesheets/extra.css | 9 ++ docs/tags.md | 32 +++-- mkdocs.yml | 10 +- overrides/partials/toc-item.html | 43 ++++++ 21 files changed, 203 insertions(+), 186 deletions(-) rename docs/{library.md => libraries.md} (55%) rename docs/{library_changes.md => library-changes.md} (98%) rename docs/{preview_support.md => preview-support.md} (95%) create mode 100644 overrides/partials/toc-item.html diff --git a/docs/changelog.md b/docs/changelog.md index 769e6cba..a3c6474a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -170,34 +170,20 @@ A new "Library Information" window has been added and is accessible under the "V ### Translations -- Added Chinese (Simplified Han Script) - - @tkiuvvv233, Luoyu, @ngivanyh -- Updated Dutch - - @Pheubel -- Updated Filipino - - @searinminecraft -- Updated French - - @kitsumed -- Updated German - - @Livesi5e, @Stereo157E -- Updated Hungarian - - @smileyhead -- Updated Japanese - - wany-oh -- Updated Norwegian Bokmål - - @Neemek -- Updated Polish - - @FeatherPrince -- Updated Russian - - @Dott-rus, Utof, @maximmax42 -- Updated Spanish - - @JCC1998, Joan, Sunny, @danpg94 -- Updated Tamil - - @TamilNeram -- Updated Toki Pona - - @Math-Bee -- Updated Viossa - - @Nginearing +- **Chinese** _(Simplified Han Script)_ added and updated by @tkiuvvv233, Luoyu, @ngivanyh +- **Dutch** updated by @Pheubel +- **Filipino** updated by @searinminecraft +- **French** updated by @kitsumed +- **German** updated by @Livesi5e, @Stereo157E +- **Hungarian** updated by @smileyhead +- **Japanese** updated by wany-oh +- **Norwegian Bokmål** updated by @Neemek +- **Polish** updated by @FeatherPrince +- **Russian** updated by @Dott-rus, Utof, @maximmax42 +- **Spanish** updated by @JCC1998, Joan, Sunny, @danpg94 +- **Tamil** updated by @TamilNeram +- **Toki Pona** updated by @Math-Bee +- **Viossa** updated by @Nginearing ### Internal Changes @@ -288,28 +274,17 @@ A new "Library Information" window has been added and is accessible under the "V ### Translations -- Added Japanese (50%) - - [@needledetector](https://github.com/needledetector) -- Updated Turkish (93%) - - [@Nyghl](https://github.com/Nyghl) -- Updated Filipino (57%) - - [@searinminecraft](https://github.com/searinminecraft) -- Updated Tamil (92%) - - [@TamilNeram](https://github.com/TamilNeram) -- Updated Portuguese (Brazil) (83%) - - [@viniciushelder](https://github.com/viniciushelder) -- Updated German (95%) - - [@DontBlameMe99](https://github.com/DontBlameMe99), [@Computerdores](https://github.com/Computerdores) -- Updated Russian (85%) - - werdi, [@Dott-rus](https://github.com/Dott-rus) -- Updated Hungarian (100%) - - Szíjártó Levente Pál -- Updated Spanish (96%) - - Joan, [@Nginearing](https://github.com/Nginearing) -- Updated French (100%) - - [@kitsumed](https://github.com/kitsumed) -- Updated Toki Pona (80%) - - [@Math-Bee](https://github.com/Math-Bee) +- **Filipino** updated by [@searinminecraft](https://github.com/searinminecraft) +- **French** updated by [@kitsumed](https://github.com/kitsumed) +- **German** updated by [@DontBlameMe99](https://github.com/DontBlameMe99), [@Computerdores](https://github.com/Computerdores) +- **Hungarian** updated by Szíjártó Levente Pál +- **Japanese** added by [@needledetector](https://github.com/needledetector) +- **Portuguese** _(Brazil)_ updated by [@viniciushelder](https://github.com/viniciushelder) +- **Russian** updated by werdi, [@Dott-rus](https://github.com/Dott-rus) +- **Spanish** updated by Joan, [@Nginearing](https://github.com/Nginearing) +- **Tamil** updated by [@TamilNeram](https://github.com/TamilNeram) +- **Toki Pona** updated by [@Math-Bee](https://github.com/Math-Bee) +- **Turkish** updated by [@Nyghl](https://github.com/Nyghl) --- @@ -326,16 +301,11 @@ A new "Library Information" window has been added and is accessible under the "V ### Translations -- Updated French (99%) - - [@alessdangelo](https://github.com/alessdangelo), [@Bamowen](https://github.com/Bamowen), [@kitsumed](https://github.com/kitsumed) -- Updated German (98%) - - [@Thesacraft](https://github.com/Thesacraft) -- Updated Portuguese (Brazil) (88%) - - [@viniciushelder](https://github.com/viniciushelder) -- Updated Russian (73%) - - werdei -- Updated Spanish (95%) - - [@JCC1998](https://github.com/JCC1998) +- **French** updated by [@alessdangelo](https://github.com/alessdangelo), [@Bamowen](https://github.com/Bamowen), [@kitsumed](https://github.com/kitsumed) +- **German** updated by [@Thesacraft](https://github.com/Thesacraft) +- **Portuguese** _(Brazil)_ updated by [@viniciushelder](https://github.com/viniciushelder) +- **Russian** updated by werdei +- **Spanish** updated by [@JCC1998](https://github.com/JCC1998) ### Documentation @@ -440,36 +410,21 @@ Translation hosting generously provided by [Weblate](https://weblate.org/en/). C Initial Languages: -- Chinese (Traditional) (68%) - - [@brisu](https://github.com/brisu) -- Dutch (35%) - - [@Pheubel](https://github.com/Pheubel) -- Filipino (43%) - - [@searinminecraft](https://github.com/searinminecraft) -- French (100%) - - [@Bamowen](https://github.com/Bamowen), [@alessdangelo](https://github.com/alessdangelo), [@kitsumed](https://github.com/kitsumed), Obscaeris -- German (98%) - - [@Ryussei](https://github.com/Ryussei), [@Computerdores](https://github.com/Computerdores), Aaron M, [@JoeJoeTV](https://github.com/JoeJoeTV), [@Kurty00](https://github.com/Kurty00) -- Hungarian (100%) - - [@smileyhead](https://github.com/smileyhead) -- Norwegian Bokmål (16%) - - [@comradekingu](https://github.com/comradekingu) -- Polish (97%) - - Anonymous -- Portuguese (Brazil) (64%) - - [@LoboMetalurgico](https://github.com/LoboMetalurgico), [@SpaceFox1](https://github.com/SpaceFox1), [@DaviMarquezeli](https://github.com/DaviMarquezeli), [@viniciushelder](https://github.com/viniciushelder), Alexander Lennart Formiga Johnsson -- Russian (22%) - - [@The-Stolas](https://github.com/The-Stolas) -- Spanish (57%) - - [@gallegonovato](https://github.com/gallegonovato), [@Nginearing](https://github.com/Nginearing), [@noceno](https://github.com/noceno) -- Swedish (24%) - - [@adampawelec](https://github.com/adampawelec), [@mashed5894](https://github.com/mashed5894) -- Tamil (22%) - - [@VasigaranAndAngel](https://github.com/VasigaranAndAngel) -- Toki Pona (32%) - - [@goldstargloww](https://github.com/goldstargloww) -- Turkish (22%) - - [@Nyghl](https://github.com/Nyghl) +- **Chinese** _(Traditional Han Script)_ by [@brisu](https://github.com/brisu) +- **Dutch** by [@Pheubel](https://github.com/Pheubel) +- **Filipino** by [@searinminecraft](https://github.com/searinminecraft) +- **French** by [@Bamowen](https://github.com/Bamowen), [@alessdangelo](https://github.com/alessdangelo), [@kitsumed](https://github.com/kitsumed), Obscaeris +- **German** by [@Ryussei](https://github.com/Ryussei), [@Computerdores](https://github.com/Computerdores), Aaron M, [@JoeJoeTV](https://github.com/JoeJoeTV), [@Kurty00](https://github.com/Kurty00) +- **Hungarian** by [@smileyhead](https://github.com/smileyhead) +- **Norwegian Bokmål** by [@comradekingu](https://github.com/comradekingu) +- **Polish** by Anonymous +- **Portuguese** _(Brazil)_ by [@LoboMetalurgico](https://github.com/LoboMetalurgico), [@SpaceFox1](https://github.com/SpaceFox1), [@DaviMarquezeli](https://github.com/DaviMarquezeli), [@viniciushelder](https://github.com/viniciushelder), Alexander Lennart Formiga Johnsson +- **Russian** by [@The-Stolas](https://github.com/The-Stolas) +- **Spanish** by [@gallegonovato](https://github.com/gallegonovato), [@Nginearing](https://github.com/Nginearing), [@noceno](https://github.com/noceno) +- **Swedish** by [@adampawelec](https://github.com/adampawelec), [@mashed5894](https://github.com/mashed5894) +- **Tamil** by [@VasigaranAndAngel](https://github.com/VasigaranAndAngel) +- **Toki Pona** by [@goldstargloww](https://github.com/goldstargloww) +- **Turkish** by [@Nyghl](https://github.com/Nyghl) #### Miscellaneous diff --git a/docs/colors.md b/docs/colors.md index 75a7c54d..8563388f 100644 --- a/docs/colors.md +++ b/docs/colors.md @@ -10,7 +10,7 @@ TagStudio features a variety of built-in tag colors, alongside the ability for u 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. -![Tag Color Manager](../assets/tag_color_manager.png) +![Tag Color Manager](assets/tag_color_manager.png) ## Creating a Namespace @@ -20,7 +20,7 @@ _\* Color pack sharing coming in a future update_ To create your first namespace, either click the "New Namespace" button or the large button prompt underneath the built-in colors. -![Create Namespace](../assets/create_namespace.png) +![Create Namespace](assets/create_namespace.png) ### Name @@ -40,7 +40,7 @@ Namespaces beginning with "tagstudio" are reserved by TagStudio and will automat Once you've created your first namespace, click the "+" button inside the namespace section to create a color. To edit a color that you've previously created, either click on the color name or right click and select "Edit Color" from the context menu. -![Create Color (Primary Color)](../assets/custom_color_primary_only.png) +![Create Color (Primary Color)](assets/custom_color_primary_only.png) ### Name @@ -62,14 +62,14 @@ The primary color is used as the main tag color and by default is used as the ba By default, the secondary color is only used as an optional override for the tag text color. This color can be cleared by clicking the adjacent "Reset" button. -![Create Color (Secondary Color)](../assets/custom_color_no_border.png) +![Create Color (Secondary Color)](assets/custom_color_no_border.png) The secondary color can also be used as the tag border color by checking the "Use Secondary Color for Border" box. -![Create Color (Use Secondary for Border)](../assets/custom_color_border.png) +![Create Color (Use Secondary for Border)](assets/custom_color_border.png) ## Using Colors When editing a tag, click the tag color button to bring up the tag color selection panel. From here you can choose any built-in TagStudio color as well as any of your custom colors. -![Tag Color Selection](../assets/tag_color_selection.png) +![Tag Color Selection](assets/tag_color_selection.png) diff --git a/docs/contributing.md b/docs/contributing.md index bc59c19d..133ffac8 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -8,7 +8,7 @@ Thank you so much for showing interest in contributing to TagStudio! Here are a ## Getting Started -- Check the [Feature Roadmap](/docs/updates/roadmap.md) page to see what priority features there are, the [FAQ](/README.md/#faq), as well as the project's [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls). +- Check the [Feature Roadmap](roadmap.md) page to see what priority features there are, the [FAQ](https://github.com/TagStudioDev/TagStudio/blob/main/README.md#faq), as well as the project's [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls). - If you'd like to add a feature that isn't on the feature roadmap or doesn't have an open issue, **PLEASE create a feature request** issue for it discussing your intentions so any feedback or important information can be given by the team first. - We don't want you wasting time developing a feature or making a change that can't/won't be added for any reason ranging from pre-existing refactors to design philosophy differences. - **Please don't** create pull requests that consist of large refactors, _especially_ without discussing them with us first. These end up doing more harm than good for the project by continuously delaying progress and disrupting everyone else's work. @@ -16,12 +16,12 @@ Thank you so much for showing interest in contributing to TagStudio! Here are a ### Contribution Checklist -- I've read the [Feature Roadmap](/docs/updates/roadmap.md) page -- I've read the [FAQ](/README.md/#faq), including the "[Features I Likely Won't Add/Pull](/README.md/#features-i-likely-wont-addpull)" section +- I've read the [Feature Roadmap](roadmap.md) page +- I've read the [FAQ](https://github.com/TagStudioDev/TagStudio/blob/main/README.md#faq) - I've checked the project's [Issues](https://github.com/TagStudioDev/TagStudio/issues) and [Pull Requests](https://github.com/TagStudioDev/TagStudio/pulls) - **I've created a new issue for my feature/fix _before_ starting work on it**, or have at least notified others in the relevant existing issue(s) of my intention to work on it - I've set up my development environment including Ruff, Mypy, and PyTest -- I've read the [Code Guidelines](#code-guidelines) and/or [Documentation Guidelines](#documentation-guidelines) +- I've read the CONTRIBUTING.md/Contributing page on the documentation site as well as the and/or [Style Guide](style.md) - **_I mean it, I've found or created an issue for my feature/fix!_** @@ -98,7 +98,7 @@ Mypy is also available as a VS Code [extension](https://marketplace.visualstudio ## Code Style -See the [Style Guide](/STYLE.md) +See the [Style Guide](style.md) ### Modules & Implementations @@ -142,7 +142,7 @@ See the [Style Guide](/STYLE.md) Documentation contributions include anything inside of the `docs/` folder, as well as the `README.md` and `CONTRIBUTING.md` files. Documentation inside the `docs/` folder is built and hosted on our static documentation site, [docs.tagstud.io](https://docs.tagstud.io/). -- Use "[snake_case](https://developer.mozilla.org/en-US/docs/Glossary/Snake_case)" for file and folder names +- Use "[dash-case / kebab-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case)" for file and folder names - Follow the folder structure pattern - Don't add images or other media with excessively large file sizes - Provide alt text for all embedded media diff --git a/docs/developing.md b/docs/developing.md index b0b24903..dc49ee23 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -121,7 +121,7 @@ A reference `.envrc` is provided for use with [direnv](#direnv), see [`contrib/. ### Editor Integration -The entry point for TagStudio is `src/tagstudio/main.py`. You can target this file from your IDE to run or connect a debug session. The example(s) below show off example launch scripts for different IDEs. Here you can also take advantage of [launch arguments](./usage.md/#launch-arguments) to pass your own test [libraries](./library/index.md) to use while developing. You can find more editor configurations in [`contrib`](https://github.com/TagStudioDev/TagStudio/tree/main/contrib). +The entry point for TagStudio is `src/tagstudio/main.py`. You can target this file from your IDE to run or connect a debug session. The example(s) below show off example launch scripts for different IDEs. Here you can also take advantage of [launch arguments](./usage.md/#launch-arguments) to pass your own test [libraries](libraries.md) to use while developing. You can find more editor configurations in [`contrib`](https://github.com/TagStudioDev/TagStudio/tree/main/contrib). === "VS Code" diff --git a/docs/entries.md b/docs/entries.md index 305958a4..6a1a9fbc 100644 --- a/docs/entries.md +++ b/docs/entries.md @@ -4,7 +4,7 @@ icon: material/file # :material-file: Entries -Entries are the individual representations of your files inside a TagStudio [library](./index.md). Each one corresponds one-to-one to a file on disk, and tracks all of the additional [tags](tag.md) and metadata that you attach to it inside TagStudio. +Entries are the individual representations of your files inside a TagStudio [library](./index.md). Each one corresponds one-to-one to a file on disk, and tracks all of the additional [tags](tags.md) and metadata that you attach to it inside TagStudio. ## Storage diff --git a/docs/fields.md b/docs/fields.md index 052db31d..afcf057e 100644 --- a/docs/fields.md +++ b/docs/fields.md @@ -4,7 +4,7 @@ icon: material/text-box # :material-text-box: Fields -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. +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. ## Field Types @@ -20,7 +20,7 @@ A long string of text displayed as a box of text. - e.g: Description, Notes, etc. -### Datetime [WIP] +### Datetime A date and time value. diff --git a/docs/help/ffmpeg.md b/docs/help/ffmpeg.md index 4e8d306b..80746c6f 100644 --- a/docs/help/ffmpeg.md +++ b/docs/help/ffmpeg.md @@ -2,7 +2,7 @@ icon: material/movie-open-cog --- -# :material-movie-open-cog: FFmpeg +# :material-movie-open-cog: Installing FFmpeg FFmpeg is required for thumbnail previews and playback features on audio and video files. FFmpeg is a free Open Source project dedicated to the handling of multimedia (video, audio, etc) files. For more information, see their official website at [ffmpeg.org](https://www.ffmpeg.org/). diff --git a/docs/ignore.md b/docs/ignore.md index 6b4cd979..0e7687d0 100644 --- a/docs/ignore.md +++ b/docs/ignore.md @@ -11,7 +11,7 @@ icon: material/file-document-remove If you're still running an older version of TagStudio in the meantime, you can access the legacy system by going to "Edit -> Manage File Extensions" in the menubar. -TagStudio offers the ability to ignore specific files and directories via a `.ts_ignore` file located inside your [library's](../library/index.md) `.TagStudio` folder. This file is designed to use very similar [glob]()-style pattern matching as the [`.gitignore`](https://git-scm.com/docs/gitignore) file used by Git™[^1]. It can be edited within TagStudio or opened to edit with an external program by going to the "Edit -> Ignore Files" option in the menubar. +TagStudio offers the ability to ignore specific files and directories via a `.ts_ignore` file located inside your [library's](libraries.md) `.TagStudio` folder. This file is designed to use very similar [glob]()-style pattern matching as the [`.gitignore`](https://git-scm.com/docs/gitignore) file used by Git™[^1]. It can be edited within TagStudio or opened to edit with an external program by going to the "Edit -> Ignore Files" option in the menubar. This file is only referenced when scanning directories for new files to add to your library, and does not apply to files that have already been added to your library. diff --git a/docs/index.md b/docs/index.md index 507e48ff..66cc5dfd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -36,15 +36,15 @@ hide:
-- :material-file-multiple:{ .lg .middle } **[All Files](./library/entry.md) Welcome** +- :material-file-multiple:{ .lg .middle } **[All Files](entries.md) Welcome** *** TagStudio works with photos, videos, music, documents, and more! **All file types** are recognized by TagStudio, with most common ones having built-in preview support. - [:material-arrow-right: See Full Preview Support](./library/index.md#preview-support) + [:material-arrow-right: See Full Preview Support](preview-support.md) -- :material-tag-text:{ .lg .middle } **Create [Tags](./library/tag.md) Your Way** +- :material-tag-text:{ .lg .middle } **Create [Tags](tags.md) Your Way** *** @@ -54,17 +54,17 @@ hide: - :material-tag-multiple: Tags can be tagged with other tags! - :material-star-four-points: And more! -- :material-magnify:{ .lg .middle } **Powerful [Search](./library/library_search.md)** +- :material-magnify:{ .lg .middle } **Powerful [Search](search.md)** *** - - Full [Boolean operator](./library/library_search.md) support + - Full [Boolean operator](search.md) support - Filenames, paths, and extensions with [glob]() syntax - General media types (e.g. "Photo", "Video", "Document") - Special searches (e.g. "Untagged") - - "[Smartcase](./library/library_search.md#case-sensitivity)" case sensitivity + - "[Smartcase](search.md#case-sensitivity)" case sensitivity -- :material-text-box:{ .lg .middle } **Text and Date [Fields](./library/field.md)** +- :material-text-box:{ .lg .middle } **Text and Date [Fields](fields.md)** *** @@ -86,15 +86,15 @@ hide: [:material-arrow-right: View License](https://github.com/TagStudioDev/TagStudio/blob/main/LICENSE) - [:material-arrow-right: Roadmap to MIT Core Library License](./updates/roadmap.md#core-library-api) + [:material-arrow-right: Roadmap to MIT Core Library License](roadmap.md#core-library-api) - :material-database:{ .lg .middle } **Central Save File** *** - Apposed to filling your drives with [sidecar files](https://en.wikipedia.org/wiki/Sidecar_file), TagStudio uses a project-like [library](./library/index.md) system that stores your tags and metadata inside a single save file per-library. + Apposed to filling your drives with [sidecar files](https://en.wikipedia.org/wiki/Sidecar_file), TagStudio uses a project-like [library](libraries.md) system that stores your tags and metadata inside a single save file per-library. - [:material-arrow-right: Learn About the Format](./library/index.md) + [:material-arrow-right: Learn About the Format](libraries.md)
@@ -106,6 +106,6 @@ TagStudio aims to create an **open** and **robust** format for file tagging that
-- :material-map-check:{ .lg .middle } See the [**Roadmap**](./updates/roadmap.md) for future features and updates +- :material-map-check:{ .lg .middle } See the [**Roadmap**](roadmap.md) for future features and updates
diff --git a/docs/install.md b/docs/install.md index 81eebdfc..bec72c2b 100644 --- a/docs/install.md +++ b/docs/install.md @@ -52,7 +52,7 @@ pip install . ```sh pip install -e ".[dev]" ``` - _See more under "[Developing](./develop.md)"_ + _See more under "[Developing](developing.md)"_ TagStudio can now be launched via the `tagstudio` command in your terminal. @@ -239,4 +239,4 @@ To generate thumbnails for RAR-based files (like `.cbr`) you'll need an extracto ### ripgrep -A recommended tool to improve the performance of directory scanning is [`ripgrep`](https://github.com/BurntSushi/ripgrep), a Rust-based directory walker that natively integrates with our [`.ts_ignore`](./utilities/ignore.md) (`.gitignore`-style) pattern matching system for excluding files and directories. Ripgrep is already pre-installed on some Linux distributions and also available from several package managers. +A recommended tool to improve the performance of directory scanning is [`ripgrep`](https://github.com/BurntSushi/ripgrep), a Rust-based directory walker that natively integrates with our [`.ts_ignore`](ignore.md) (`.gitignore`-style) pattern matching system for excluding files and directories. Ripgrep is already pre-installed on some Linux distributions and also available from several package managers. diff --git a/docs/library.md b/docs/libraries.md similarity index 55% rename from docs/library.md rename to docs/libraries.md index ba227b39..0afeb6ef 100644 --- a/docs/library.md +++ b/docs/libraries.md @@ -2,12 +2,12 @@ icon: material/database --- -# :material-database: Library +# :material-database: Libraries !!! info This page is a work in progress and needs to be updated with additional information. -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. +The library is how TagStudio represents your chosen directory, with every file inside being represented by a [file entry](entries.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_. Global tags along with other library structure updates are planned for future releases on the [roadmap](../updates/roadmap.md#library). +Note that this means [tags](tags.md) you create only exist _per-library_. Global tags along with other library structure updates are planned for future releases on the [roadmap](roadmap.md#library). diff --git a/docs/library_changes.md b/docs/library-changes.md similarity index 98% rename from docs/library_changes.md rename to docs/library-changes.md index 44d1ce86..d37bbedb 100644 --- a/docs/library_changes.md +++ b/docs/library-changes.md @@ -75,7 +75,7 @@ Migration from the legacy JSON format is provided via a walkthrough when opening | ------------------------------------------------------------------------------- | ------ | ----------------------------------------------- | | [v9.5.0-pr4](https://github.com/TagStudioDev/TagStudio/releases/tag/v9.5.0-pr4) | SQLite | ``/.TagStudio/ts_library.sqlite | -- 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. +- Adds the `color_border` column to the `tag_colors` table. Used for instructing the [secondary color](colors.md#secondary-color) to apply to a tag's border as a new optional behavior. - Adds three new default colors: "Burgundy (TagStudio Shades)", "Dark Teal (TagStudio Shades)", and "Dark Lavender (TagStudio Shades)". - Updates Neon colors to use the new `color_border` property. diff --git a/docs/macros.md b/docs/macros.md index e760df10..9268d267 100644 --- a/docs/macros.md +++ b/docs/macros.md @@ -4,13 +4,13 @@ icon: material/script-text # :material-script-text: Tools & Macros -Tools and macros are features that serve to create a more fluid [library](../library/index.md)-managing process, or provide some extra functionality. Please note that some are still in active development and will be fleshed out in future updates. +Tools and macros are features that serve to create a more fluid [library](libraries.md)-managing process, or provide some extra functionality. Please note that some are still in active development and will be fleshed out in future updates. ## Tools ### Fix Unlinked Entries -This tool displays the number of unlinked [entries](../library/entry.md), and some options for their resolution. +This tool displays the number of unlinked [entries](entries.md), and some options for their resolution. Refresh : Scans through the library and updates the unlinked entry count. @@ -29,7 +29,7 @@ Load DupeGuru File : load the "results" file created from a DupeGuru scan Mirror Entries -: Duplicate entries will have their contents mirrored across all instances. This allows for duplicate files to then be deleted with DupeGuru as desired, without losing the [field](../library/field.md) data that has been assigned to either. (Once deleted, the "Fix Unlinked Entries" tool can be used to clean up the duplicates) +: Duplicate entries will have their contents mirrored across all instances. This allows for duplicate files to then be deleted with DupeGuru as desired, without losing the [field](fields.md) data that has been assigned to either. (Once deleted, the "Fix Unlinked Entries" tool can be used to clean up the duplicates) ### Create Collage @@ -43,8 +43,8 @@ Tool is in development and will be documented in a future update. ### Sort fields -Tool is in development. Will allow for user-defined sorting of [fields](../library/field.md). +Tool is in development. Will allow for user-defined sorting of [fields](fields.md). ### Folders to Tags -Creates tags from the existing folder structure in the library, which are previewed in a hierarchy view for the user to confirm. A tag will be created for each folder and applied to all entries, with each subfolder being linked to the parent folder as a [parent tag](../library/tag.md#parent-tags). Tags will initially be named after the folders, but can be fully edited and customized afterwards. +Creates tags from the existing folder structure in the library, which are previewed in a hierarchy view for the user to confirm. A tag will be created for each folder and applied to all entries, with each subfolder being linked to the parent folder as a [parent tag](tags.md#parent-tags). Tags will initially be named after the folders, but can be fully edited and customized afterwards. diff --git a/docs/preview_support.md b/docs/preview-support.md similarity index 95% rename from docs/preview_support.md rename to docs/preview-support.md index 9cd5874c..8721fbc7 100644 --- a/docs/preview_support.md +++ b/docs/preview-support.md @@ -2,7 +2,7 @@ icon: material/image-check --- -# :material-image-check: Preview Support +# :material-image-check: Supported Previews TagStudio offers built-in preview and thumbnail support for a wide variety of file types. Files that don't have explicit support can still be added to your library like normal, they will just show a default icon for thumbnails and previews. TagStudio also references the file's [MIME](https://en.wikipedia.org/wiki/Media_type) type in an attempt to render previews for file types that haven't gained explicit support yet. @@ -43,7 +43,7 @@ Images will generate thumbnails the first time they are viewed or since the last ### :material-movie-open: Videos -Video thumbnails will default to the closest viable frame from the middle of the video. Both thumbnail generation and video playback in the Preview Panel requires [FFmpeg](../install.md#third-party-dependencies) installed on your system. +Video thumbnails will default to the closest viable frame from the middle of the video. Both thumbnail generation and video playback in the Preview Panel requires [FFmpeg](install.md#third-party-dependencies) installed on your system. | Filetype | Extensions | Dependencies | | --------------------- | ----------------------- | :----------: | @@ -61,7 +61,7 @@ Video thumbnails will default to the closest viable frame from the middle of the ### :material-sine-wave: Audio -Audio thumbnails will default to embedded cover art (if any) andfallback to generated waveform thumbnails. Audio file playback is supported in the Preview Panel if you have [FFmpeg](../install.md#third-party-dependencies) installed on your system. Audio waveforms are currently not cached. +Audio thumbnails will default to embedded cover art (if any) andfallback to generated waveform thumbnails. Audio file playback is supported in the Preview Panel if you have [FFmpeg](install.md#third-party-dependencies) installed on your system. Audio waveforms are currently not cached. | Filetype | Extensions | Dependencies | | ------------------- | ------------------------ | :----------: | @@ -104,7 +104,7 @@ Preview support for office documents or well-known project file formats varies b !!! failure "3D Model Support" - TagStudio does not currently support previews for 3D model files *(outside of Blender project embedded thumbnails)*. This is on our [roadmap](../updates/roadmap.md#uiux) for a future release. + TagStudio does not currently support previews for 3D model files *(outside of Blender project embedded thumbnails)*. This is on our [roadmap](roadmap.md#uiux) for a future release. ### :material-format-font: Fonts @@ -122,7 +122,7 @@ Font thumbnails will use a "Aa" example preview of the font, with a full alphanu !!! info "Plain Text Support" TagStudio supports the *vast* majority of files considered to be "[plain text](https://en.wikipedia.org/wiki/Plain_text)". If an extension or format is not listed here, odds are it's still supported anyway. -Text files render the first 256 bytes of text information to an image preview for thumbnails and the Preview Panel. Improved thumbnails, full scrollable text, and syntax highlighting are on our [roadmap](../updates/roadmap.md#uiux) for future features. +Text files render the first 256 bytes of text information to an image preview for thumbnails and the Preview Panel. Improved thumbnails, full scrollable text, and syntax highlighting are on our [roadmap](roadmap.md#uiux) for future features. | Filetype | Extensions | Syntax Highlighting | | ---------- | --------------------------------------------- | :--------------------------------: | diff --git a/docs/roadmap.md b/docs/roadmap.md index 03d9d23f..f1417393 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -39,7 +39,7 @@ Must be finalized or deemed "feature complete" before other core features are de !!! note See the "[Library](#library)" section for features related to the library database rather than the underlying schema. -- [x] A SQLite-based library save file format **[[v9.5.0](./changelog.md#950-2025-03-03)]** +- [x] A SQLite-based library save file format **[[v9.5.0](changelog.md#950-march-3rd-2025)]** - [ ] Cached File Properties Table :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]** - [x] Date Entry Added to Library :material-chevron-triple-up:{ .priority-high title="High Priority" } - [ ] Date File Created :material-chevron-triple-up:{ .priority-high title="High Priority" } @@ -77,14 +77,14 @@ A detailed written specification for the TagStudio tag and/or library format. In - [ ] Lightbox View :material-chevron-triple-up:{ .priority-high title="High Priority" } - Similar to List View in concept, but displays one large preview that can cycle back/forth between entries. - [ ] Smaller thumbnails of immediate adjacent entries below :material-chevron-double-up:{ .priority-med title="Medium Priority" } -- [x] Library Statistics Screen :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.4]** -- [x] Unified Library Health/Cleanup Screen :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.4]** +- [x] Library Statistics Screen **[[v9.5.4](changelog.md#954-september-1st-2025)]** +- [x] Unified Library Health/Cleanup Screen **[[v9.5.4](changelog.md#954-september-1st-2025)]** - [x] Fix Unlinked Entries - [x] Fix Duplicate Files - [x] ~~Fix Duplicate Entries~~ - - [x] Remove Ignored Entries :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.4]** - - [x] Delete Old Backups :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.4]** - - [x] Delete Legacy JSON File :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.4]** + - [x] Remove Ignored Entries **[[v9.5.4](changelog.md#954-september-1st-2025)]** + - [x] Delete Old Backups **[[v9.5.4](changelog.md#954-september-1st-2025)]** + - [x] Delete Legacy JSON File **[[v9.5.4](changelog.md#954-september-1st-2025)]** - [x] Translations - [ ] Search Bar Rework :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.x]** - [ ] Improved Tag Autocomplete :material-chevron-triple-up:{ .priority-high title="High Priority" } @@ -125,7 +125,7 @@ A detailed written specification for the TagStudio tag and/or library format. In - [x] Language - [x] Date and Time Format - [x] Theme - - [x] Thumbnail Generation :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.5.4]** + - [x] Thumbnail Generation **[[v9.5.4](changelog.md#954-september-1st-2025)]** - [x] Configurable Page Size - [ ] Library Settings :material-chevron-triple-up:{ .priority-high title="High Priority" } - [ ] Stored in `.TagStudio` folder :material-chevron-triple-up:{ .priority-high title="High Priority" } @@ -140,7 +140,7 @@ Some form of official plugin support for TagStudio, likely with its own API that --- -## [Library](../library/index.md) +## [Library](libraries.md) ### :material-wrench: Library Mechanics @@ -154,10 +154,10 @@ Some form of official plugin support for TagStudio, likely with its own API that - [ ] Detect Deletions :material-chevron-triple-up:{ .priority-high title="High Priority" } - [ ] Performant :material-chevron-triple-up:{ .priority-high title="High Priority" } - [ ] Background File Scanning :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.x]** -- [x] Thumbnail Caching **[[v9.5.0](./changelog.md#950-2025-03-03)]** +- [x] Thumbnail Caching **[[v9.5.0](changelog.md#950-march-3rd-2025)]** - [ ] Audio Waveform Caching :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.7.x]** -### :material-grid: [Entries](../library/entry.md) +### :material-grid: [Entries](entries.md) Library representations of files or file-like objects. @@ -167,7 +167,7 @@ Library representations of files or file-like objects. - [x] Fields - [x] Text Lines - [x] Text Boxes - - [x] Datetimes **[v9.5.4]** + - [x] Datetimes **[[v9.5.4](changelog.md#954-september-1st-2025)]** - [ ] User-Titled Fields :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]** - [ ] Removal of Deprecated Fields :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.x]** - [ ] Entry Groups :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.x]** @@ -178,9 +178,9 @@ Library representations of files or file-like objects. - [ ] Group is treated as entry with tags and metadata :material-chevron-double-up:{ .priority-med title="Medium Priority" } - [ ] Nested groups :material-chevron-double-up:{ .priority-med title="Medium Priority" } -### :material-tag-text: [Tags](../library/tag.md) +### :material-tag-text: [Tags](tags.md) -Discrete library objects representing [attributes](). Can be applied to library [entries](../library/entry.md), or applied to other tags to build traversable relationships. +Discrete library objects representing [attributes](). Can be applied to library [entries](entries.md), or applied to other tags to build traversable relationships. - [x] Tag Name **[v8.0.0]** - [x] Tag Shorthand Name **[v8.0.0]** @@ -189,52 +189,52 @@ Discrete library objects representing [attributes](