docs: add feature roadmap

CyanVoxel · CyanVoxel · commit 04149f6454de · 2024-10-28T13:01:13.000-07:00
diff --git a/docs/index.md b/docs/index.md
@@ -5,11 +5,10 @@ title: Home
 # Welcome to the TagStudio Documentation!
 
 !!! warning
-	This documentation is still a work in progress, and is intended to aide with deconstructing and understanding of the core mechanics of TagStudio and how it operates.
+This documentation is still a work in progress, and is intended to aide with deconstructing and understanding of the core mechanics of TagStudio and how it operates.
 
 ![TagStudio Alpha](assets/github_header.png)
 
-
 TagStudio is a photo & file organization application with an underlying system that focuses on giving freedom and flexibility to the user. No proprietary programs or formats, no sea of sidecar files, and no complete upheaval of your filesystem structure.
 
 <figure markdown="span">
@@ -19,11 +18,11 @@ TagStudio is a photo & file organization application with an underlying system t
 
 ## Goals
 
-- To achieve a portable, privacy-oriented, open, extensible, and feature-rich system of organizing and rediscovering files.
-- To provide powerful methods for organization, notably the concept of tag composition, or “taggable tags”.
-- To create an implementation of such a system that is resilient against a user’s actions outside the program (modifying, moving, or renaming files) while also not burdening the user with mandatory sidecar files or otherwise requiring them to change their existing file structures and workflows.
-- To support a wide range of users spanning across different platforms, multi-user setups, and those with large (several terabyte) libraries.
-- To make the darn thing look like nice, too. It’s 2024, not 1994.
+-   To achieve a portable, privacy-oriented, open, extensible, and feature-rich system of organizing and rediscovering files.
+-   To provide powerful methods for organization, notably the concept of tag composition, or “taggable tags”.
+-   To create an implementation of such a system that is resilient against a user’s actions outside the program (modifying, moving, or renaming files) while also not burdening the user with mandatory sidecar files or otherwise requiring them to change their existing file structures and workflows.
+-   To support a wide range of users spanning across different platforms, multi-user setups, and those with large (several terabyte) libraries.
+-   To make the darn thing look like nice, too. It’s 2024, not 1994.
 
 ## Priorities
 
@@ -34,14 +33,18 @@ TagStudio is a photo & file organization application with an underlying system t
 
 ## Current Features
 
-- Create libraries/vaults centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
-- Add metadata to your library entries, including:
-	- Name, Author, Artist (Single-Line Text Fields)
-	- Description, Notes (Multiline Text Fields)
-	- Tags, Meta Tags, Content Tags (Tag Boxes)
-- Create rich tags composed of a name, a list of aliases, and a list of “subtags” - being tags in which these tags inherit values from.
-- Search for entries based on tags, ~~metadata~~ (TBA), or filenames/filetypes (using `filename: <query>`)
-- Special search conditions for entries that are: `untagged`/`no tags` and `empty`/`no fields`.
+-   Create libraries/vaults centered around a system directory. Libraries contain a series of entries: the representations of your files combined with metadata fields. Each entry represents a file in your library’s directory, and is linked to its location.
+-   Add metadata to your library entries, including:
+    -   Name, Author, Artist (Single-Line Text Fields)
+    -   Description, Notes (Multiline Text Fields)
+    -   Tags, Meta Tags, Content Tags (Tag Boxes)
+-   Create rich tags composed of a name, a list of aliases, and a list of “subtags” - being tags in which these tags inherit values from.
+-   Search for entries based on tags, ~~metadata~~ (TBA), or filenames/filetypes (using `filename: <query>`)
+-   Special search conditions for entries that are: `untagged`/`no tags` and `empty`/`no fields`.
+
+## Feature Roadmap
+
+The [feature roadmap](updates/roadmap.md) lists all of the planned core features for TagStudio to be considered "feature complete" along with estimated release milestones. The development and testing of these features takes priority over all other requested or submitted features unless they are later added to this roadmap. This helps ensure that TagStudio eventually sees a full release and becomes more usable by more people more quickly.
 
 ## Important Updates
 
diff --git a/docs/updates/roadmap.md b/docs/updates/roadmap.md
@@ -0,0 +1,265 @@
+# TagStudio Roadmap
+
+This checklist details the current and remaining features required at a minimum for TagStudio to be considered “Feature Complete”. This list is _not_ a definitive list for additional feature requests and PRs as they come in, but rather an outline of my personal core feature set intended for TagStudio.
+
+## Priorities
+
+Features are broken up into the following priority levels, with nested priorities referencing their relative priority for the overall feature (i.e. A [LOW] priority feature can have a [HIGH] priority element but it otherwise still a [LOW] priority item overall):
+
+-   HIGH - Core feature
+-   MEDIUM - Important but not necessary
+-   LOW - Just nice to have
+
+## Core Feature List
+
+-   [ ] Tags [HIGH]
+    -   [x] ID-based, not string based [HIGH]
+    -   [x] Tag name [HIGH]
+    -   [x] Tag alias list, aka alternate names [HIGH]
+    -   [x] Tag shorthand (specific short alias for displaying) [HIGH]
+    -   [x] Parent/Inheritance subtags [HIGH]
+    -   [ ] Composition/HAS subtags [HIGH]
+    -   [ ] Deleting Tags [HIGH]
+    -   [ ] Merging Tags [HIGH]
+    -   [ ] Tag Icons [HIGH]
+        -   [ ] Small Icons [HIGH]
+        -   [ ] Large Icons for Profiles [MEDIUM]
+        -   [ ] Built-in Icon Packs (i.e. Boxicons) [HIGH]
+        -   [ ] User Defined Icons [HIGH]
+    -   [ ] Multiple Languages for Tag Strings [MEDIUM]
+    -   [ ] User-defined tag colors [HIGH]
+        -   [ ] ID based, not string or hex [HIGH]
+        -   [ ] Color name [HIGH]
+        -   [ ] Color value (hex) [HIGH]
+        -   [ ] Existing colors are now a set of base colors [HIGH]
+            -   [ ] Editable [MEDIUM]
+            -   [ ] Non-removable [HIGH]
+    -   [ ] [Tag Categories](../library/tag_categories.md) [HIGH]
+        -   [ ] Property available for tags that allow the tag and any inheriting from it to be displayed separately in the preview panel under a title [HIGH]
+        -   [ ] Title is tag name [HIGH]
+        -   [ ] Title has tag color [MEDIUM]
+        -   [ ] Tag marked as category does not display as a tag itself [HIGH]
+    -   [ ] [Tag Overrides](../library/tag_overrides.md) [MEDIUM]
+        -   [ ] Per-file overrides of subtags [HIGH]
+-   [ ] Tag Packs [MEDIUM]
+    -   [ ] Human-readable (i.e. JSON) files containing tag data [HIGH]
+    -   [ ] Importable [HIGH]
+    -   [ ] Exportable [HIGH]
+    -   [ ] Conflict resolution [HIGH]
+    -   [ ] Color Packs [MEDIUM]
+        -   [ ] Human-readable (i.e. JSON) files containing tag data [HIGH]
+        -   [ ] Importable [HIGH]
+        -   [ ] Exportable [HIGH]
+-   [ ] Exportable Library Data [HIGH]
+    -   [ ] Standard notation format (i.e. JSON) contacting all library data [HIGH]
+-   [ ] [Macros](../utilities/macro.md) [HIGH]
+    -   [ ] Sharable Macros [MEDIUM]
+        -   [ ] Standard notation format (i.e. JSON) contacting macro instructions [HIGH]
+        -   [ ] Exportable [HIGH]
+        -   [ ] Importable [HIGH]
+    -   [ ] Triggers [HIGH]
+        -   [ ] On new file [HIGH]
+        -   [ ] On library refresh [HIGH]
+        -   [...]
+    -   [ ] Actions [HIGH]
+        -   [ ] Add tag(s) [HIGH]
+        -   [ ] Add field(s) [HIGH]
+        -   [ ] Set field content [HIGH]
+        -   [ ] [...]
+-   [ ] Settings Menu [HIGH]
+    -   [ ] Application Settings [HIGH]
+        -   [ ] Stored in system user folder/designated folder [HIGH]
+    -   [ ] Library Settings [HIGH]
+        -   [ ] Stored in `.TagStudio` folder [HIGH]
+-   [ ] Multiple Root Directories per Library [HIGH]
+-   [ ] [Entry groups](../library/entry_groups.md) [HIGH]
+    -   [ ] Groups for files/entries where the same entry can be in multiple groups [HIGH]
+    -   [ ] Ability to number entries within group [HIGH]
+    -   [ ] Ability to set sorting method for group [HIGH]
+    -   [ ] Ability to set custom thumbnail for group [HIGH]
+    -   [ ] Group is treated as entry with tags and metadata [HIGH]
+    -   [ ] Nested groups [MEDIUM]
+-   [ ] Fields [HIGH]
+    -   [x] Text Boxes [HIGH]
+    -   [x] Text Lines [HIGH]
+    -   [ ] Dates [HIGH]
+    -   [ ] GPS Location [LOW]
+    -   [ ] Custom field names [HIGH]
+-   [ ] Search engine [HIGH]
+    -   [ ] Boolean operators [HIGH]
+    -   [ ] Tag objects + autocomplete [HIGH]
+    -   [ ] Filename search [HIGH]
+    -   [ ] Filetype search [HIGH]
+    -   [ ] Field content search [HIGH]
+    -   [ ] HAS operator for composition tags [HIGH]
+    -   [ ] OCR search [LOW]
+    -   [ ] Sortable results [HIGH]
+        -   [ ] Sort by relevance [HIGH]
+        -   [ ] Sort by date created [HIGH]
+        -   [ ] Sort by date modified [HIGH]
+        -   [ ] Sort by date taken (photos) [MEDIUM]
+        -   [ ] Sort by file size [HIGH]
+        -   [ ] Sort by file dimension (images/video) [LOW]
+-   [ ] Automatic Entry Relinking [HIGH]
+    -   [ ] Detect Renames [HIGH]
+    -   [ ] Detect Moves [HIGH]
+    -   [ ] Detect Deletions [HIGH]
+-   [ ] Image Collages [LOW]
+    -   [ ] UI [HIGH]
+-   [ ] Tagging Panel [HIGH]
+    -   [ ] Top Tags [HIGH]
+    -   [ ] Recent Tags [HIGH]
+    -   [ ] Tag Search [HIGH]
+    -   [ ] Pinned Tags [HIGH]
+-   [ ] Configurable Thumbnails [MEDIUM]
+    -   [ ] Toggle File Extension Label [MEDIUM]
+    -   [ ] Toggle Duration Label [MEDIUM]
+    -   [ ] Custom Tag Badges [LOW]
+-   [ ] Thumbnails [HIGH]
+    -   [ ] File Duration Label [HIGH]
+    -   [ ] 3D Model Previews [LOW]
+-   [ ] File Preview Panel [HIGH]
+    -   [ ] Video Playback [HIGH]
+        -   [x] Play/Pause [HIGH]
+        -   [x] Loop [HIGH]
+        -   [x] Toggle Autoplay [MEDIUM]
+        -   [ ] Volume Control [HIGH]
+        -   [x] Toggle Mute [HIGH]
+        -   [ ] Timeline scrubber [HIGH]
+        -   [ ] Fullscreen [MEDIUM]
+    -   [ ] Audio Playback [HIGH]
+        -   [ ] Play/Pause [HIGH]
+        -   [ ] Loop [HIGH]
+        -   [ ] Toggle Autoplay [MEDIUM]
+        -   [ ] Volume Control [HIGH]
+        -   [ ] Toggle Mute [HIGH]
+        -   [x] Timeline scrubber [HIGH]
+        -   [ ] Fullscreen [MEDIUM]
+-   [ ] Optimizations [HIGH]
+    -   [ ] Thumbnail caching [HIGH]
+    -   [ ] File property indexes [HIGH]
+
+## Version Milestones
+
+These version milestones are rough estimations for when the previous core features will be added. For a more definitive idea for when features are coming, please reference the current GitHub [milestones](https://github.com/TagStudioDev/TagStudio/milestones).
+
+### 9.5
+
+-   [ ] SQL backend [HIGH]
+-   [ ] Multiple Root Directories per Library [HIGH]
+-   [ ] Tags [HIGH]
+    -   [ ] Deleting Tags [HIGH]
+    -   [ ] Merging Tags [HIGH]
+    -   [ ] User-defined tag colors [HIGH]
+        -   [ ] ID based, not string or hex [HIGH]
+        -   [ ] Color name [HIGH]
+        -   [ ] Color value (hex) [HIGH]
+        -   [ ] Existing colors are now a set of base colors [HIGH]
+            -   [ ] Editable [MEDIUM]
+            -   [ ] Non-removable [HIGH]
+-   [ ] Search engine [HIGH]
+    -   [ ] Boolean operators [HIGH]
+    -   [ ] Tag objects + autocomplete [HIGH]
+    -   [ ] Filename search [HIGH]
+    -   [ ] Filetype search [HIGH]
+    -   [ ] Field content search [HIGH]
+    -   [ ] Sortable results [HIGH]
+        -   [ ] Sort by relevance [HIGH]
+        -   [ ] Sort by date created [HIGH]
+        -   [ ] Sort by date modified [HIGH]
+        -   [ ] Sort by date taken (photos) [MEDIUM]
+        -   [ ] Sort by file size [HIGH]
+        -   [ ] Sort by file dimension (images/video) [LOW]
+-   [ ] Settings Menu [HIGH]
+    -   [ ] Application Settings [HIGH]
+        -   [ ] Stored in system user folder/designated folder [HIGH]
+    -   [ ] Library Settings [HIGH]
+        -   [ ] Stored in `.TagStudio` folder [HIGH]
+-   [ ] Optimizations [HIGH]
+    -   [ ] Thumbnail caching [HIGH]
+
+### 9.6
+
+-   [ ] Tags [HIGH]
+    -   [ ] Composition/HAS subtags [HIGH]
+    -   [ ] Tag Icons [HIGH]
+        -   [ ] Small Icons [HIGH]
+        -   [ ] Large Icons for Profiles [MEDIUM]
+        -   [ ] Built-in Icon Packs (i.e. Boxicons) [HIGH]
+        -   [ ] User Defined Icons [HIGH]
+    -   [ ] Multiple Languages for Tag Strings [MEDIUM]
+    -   [ ] [Tag Categories](../library/tag_categories.md) [HIGH]
+        -   [ ] Property available for tags that allow the tag and any inheriting from it to be displayed separately in the preview panel under a title [HIGH]
+        -   [ ] Title is tag name [HIGH]
+        -   [ ] Title has tag color [MEDIUM]
+        -   [ ] Tag marked as category does not display as a tag itself [HIGH]
+    -   [ ] [Tag Overrides](../library/tag_overrides.md) [MEDIUM]
+        -   [ ] Per-file overrides of subtags [HIGH]
+-   [ ] Fields [HIGH]
+    -   [ ] Dates [HIGH]
+    -   [ ] Custom field names [HIGH]
+
+### 9.7
+
+-   [ ] Configurable Thumbnails [MEDIUM]
+    -   [ ] Toggle File Extension Label [MEDIUM]
+    -   [ ] Toggle Duration Label [MEDIUM]
+    -   [ ] Custom Tag Badges [LOW]
+-   [ ] Thumbnails [HIGH]
+    -   [ ] File Duration Label [HIGH]
+-   [ ] [Entry groups](../library/entry_groups.md) [HIGH]
+    -   [ ] Groups for files/entries where the same entry can be in multiple groups [HIGH]
+    -   [ ] Ability to number entries within group [HIGH]
+    -   [ ] Ability to set sorting method for group [HIGH]
+    -   [ ] Ability to set custom thumbnail for group [HIGH]
+    -   [ ] Group is treated as entry with tags and metadata [HIGH]
+    -   [ ] Nested groups [MEDIUM]
+-   [ ] Tagging Panel [HIGH]
+    -   [ ] Top Tags [HIGH]
+    -   [ ] Recent Tags [HIGH]
+    -   [ ] Tag Search [HIGH]
+    -   [ ] Pinned Tags [HIGH]
+
+### 9.8 (Possible Beta)
+
+-   [ ] Automatic Entry Relinking [HIGH]
+    -   [ ] Detect Renames [HIGH]
+    -   [ ] Detect Moves [HIGH]
+    -   [ ] Detect Deletions [HIGH]
+-   [ ] [Macros](../utilities/macro.md) [HIGH]
+    -   [ ] Sharable Macros [MEDIUM]
+        -   [ ] Standard notation format (i.e. JSON) contacting macro instructions [HIGH]
+        -   [ ] Exportable [HIGH]
+        -   [ ] Importable [HIGH]
+    -   [ ] Triggers [HIGH]
+        -   [ ] On new file [HIGH]
+        -   [ ] On library refresh [HIGH]
+        -   [...]
+    -   [ ] Actions [HIGH]
+        -   [ ] Add tag(s) [HIGH]
+        -   [ ] Add field(s) [HIGH]
+        -   [ ] Set field content [HIGH]
+        -   [ ] [...]
+
+### 9.9
+
+-   [ ] Tag Packs [MEDIUM]
+    -   [ ] Human-readable (i.e. JSON) files containing tag data [HIGH]
+    -   [ ] Importable [HIGH]
+    -   [ ] Exportable [HIGH]
+    -   [ ] Conflict resolution [HIGH]
+    -   [ ] Color Packs [MEDIUM]
+        -   [ ] Human-readable (i.e. JSON) files containing tag data [HIGH]
+        -   [ ] Importable [HIGH]
+        -   [ ] Exportable [HIGH]
+-   [ ] Exportable Library Data [HIGH]
+    -   [ ] Standard notation format (i.e. JSON) contacting all library data [HIGH]
+
+### 10.0
+
+-   [ ] All remaining [HIGH] and optional [MEDIUM] features
+
+### Post 10.0
+
+-   [ ] Core Library/API
+-   [ ] Plugin Support
