diff --git a/docs/index.md b/docs/index.md index b3df78051..84a75d0c2 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,15 +10,15 @@ TagStudio is a photo & file organization application with an underlying tag-base
- ![TagStudio screenshot](./assets/screenshot.png) +![TagStudio screenshot](./assets/screenshot.png)
TagStudio Alpha v9.5.0 running on macOS Sequoia.
-## Feature Roadmap +## 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. +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. ## Current Features diff --git a/docs/library/tag.md b/docs/library/tag.md index 67ba08df7..6f03102b6 100644 --- a/docs/library/tag.md +++ b/docs/library/tag.md @@ -60,7 +60,7 @@ Lastly, when searching your files with broader categories such as `Character` or ### Component Tags -**_[Coming in version 9.6](../updates/roadmap.md#v96)_** +**_Coming in version 9.6_** 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. @@ -80,7 +80,7 @@ Custom palettes and colors can be created via the [Tag Color Manager](./tag_colo ### Icon -**_[Coming in version 9.6](../updates/roadmap.md#v96)_** +**_Coming in version 9.6_** ## Tag Properties @@ -94,7 +94,7 @@ When the "Is Category" property is checked, this tag now acts as a category sepa #### Is Hidden -**_[Coming in version 9.6](../updates/roadmap.md#v96)_** +**_Coming in version 9.6_** When the "Is Hidden" property is checked, any file entries tagged with this tag will not show up in searches by default. This property comes by default with the built-in "Archived" tag. diff --git a/docs/updates/roadmap.md b/docs/updates/roadmap.md index 02a2fd495..c8ea4e483 100644 --- a/docs/updates/roadmap.md +++ b/docs/updates/roadmap.md @@ -1,217 +1,258 @@ -# Feature Roadmap +# :material-map-check: 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. +This page outlines the current and planned features required for TagStudio to be considered "feature complete" (v10.0.0). Features and changes are broken up by group in order to better assess the overall state of those features. [Priority levels](#priority-levels) and [version estimates](#version-estimates) are provided in order to give a rough idea of what's planned and when it may release. -## Priorities +This roadmap will update as new features are planned or completed. If there's a feature you'd like to see but is not listed on this page, please check the GitHub [Issues](https://github.com/TagStudioDev/TagStudio/issues) page and submit a feature request if one does not already exist! -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): +## Priority Levels -- [HIGH] - Core feature -- [MEDIUM] - Important but not necessary -- [LOW] - Just nice to have +Planned features and changes are assigned **priority levels** to signify how important they are to the feature-complete version of TagStudio and to serve as a general guide for what should be worked on first, along with [version estimates](#version-estimates). When features are completed, their priority level icons are removed. -## Version Milestones + +!!! info "Priority Level Icons" + - :material-chevron-triple-up:{ .priority-high title="High Priority" } **High Priority** - Core features + - :material-chevron-double-up:{ .priority-med title="Medium Priority" } **Medium Priority** - Important, but not necessary + - :material-chevron-up:{ .priority-low title="Low Priority" } **Low Priority** - Just nice to have -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). +## Version Estimates - -!!! note - This list was created after the release of version 9.4 - -### v9.5 - -#### Core - -- [x] SQL backend [HIGH] - -#### Tags - -- [x] Deleting Tags [HIGH] -- [ ] User-defined tag colors [HIGH] - - [x] ID based, not string or hex [HIGH] - - [x] Color name [HIGH] - - [x] Color value (hex) [HIGH] - - [x] Existing colors are now a set of base colors [HIGH] -- [x] [Tag Categories](../library/tag_categories.md) [HIGH] - - [x] 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] - -#### Search +Features are given rough estimations for which version they will be completed in, and are listed next to their names (e.g. Feature **[v9.0.0]**). They are eventually replaced with links to the version changelog in which they were completed in, if applicable. -- [x] Boolean operators [HIGH] -- [x] Filename search [HIGH] -- [x] File type search [HIGH] - - [x] Search by extension (e.g. ".jpg", ".png") [HIGH] - - [x] Optional consolidation of extension synonyms (i.e. ".jpg" can equal ".jpeg") [LOW] - - [x] Search by media type (e.g. "image", "video", "document") [MEDIUM] -- [x] Sort by date added [HIGH] - -#### UI - -- [x] Translations _(Any applicable)_ [MEDIUM] -- [x] Unified Media Player [HIGH] - - [x] Auto-hiding player controls - - [x] Play/Pause [HIGH] - - [x] Loop [HIGH] - - [x] Toggle Autoplay [MEDIUM] - - [x] Volume Control [HIGH] - - [x] Toggle Mute [HIGH] - - [x] Timeline scrubber [HIGH] - - [ ] Fullscreen [MEDIUM] -- [x] Configurable page size [HIGH] - -#### Performance - -- [x] Thumbnail caching [HIGH] - -### v9.6 - -#### Core - -- [ ] Cached file property table (media duration, word count, dimensions, etc.) [MEDIUM] - -#### Library - -- [ ] Multiple Root Directories per Library [HIGH] -- [ ] `.ts_ignore` (`.gitignore`-style glob ignoring) [HIGH] -- [ ] Sharable Color Packs [MEDIUM] - - [ ] Human-readable (TOML) files containing tag data [HIGH] - - [ ] Importable [HIGH] - - [ ] Exportable [HIGH] - -#### Tags - -- [ ] Merging Tags [HIGH] -- [ ] [Component/HAS](../library/tag.md#component-tags) 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] - - [ ] 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 - -- [ ] Datetime fields [HIGH] -- [ ] Custom field names [HIGH] - -#### Search - -- [ ] Field content search [HIGH] -- [ ] Sort by date created [HIGH] -- [ ] Sort by date modified [HIGH] -- [x] Sort by filename [HIGH] -- [ ] HAS operator for composition tags [HIGH] -- [ ] Search bar rework - - [ ] Improved tag autocomplete [HIGH] - - [ ] Tags appear as widgets in search bar [HIGH] - -#### UI - -- [ ] File duration on video thumbnails [HIGH] -- [ ] 3D Model Previews [MEDIUM] - - [ ] STL Previews [HIGH] -- [ ] Word count/line count on text thumbnails [LOW] -- [x] Settings Menu [HIGH] -- [x] Application Settings [HIGH] - - [x] Stored in system user folder/designated folder [HIGH] -- [ ] Library Settings [HIGH] - - [ ] Stored in `.TagStudio` folder [HIGH] -- [ ] Tagging Panel [HIGH] - - Toggleable persistent main window panel or pop-out. Replaces the current tag manager. - - - [ ] Top Tags [HIGH] - - [ ] Recent Tags [HIGH] - - [ ] Tag Search [HIGH] - - [ ] Pinned Tags [HIGH] - -- [ ] New tabbed tag building UI to support the new tag features [HIGH] - -### v9.7 - -#### Library - -- [ ] [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] - -#### Search - -- [ ] Sort by relevance [HIGH] -- [ ] Sort by date taken (photos) [MEDIUM] -- [ ] Sort by file size [HIGH] -- [ ] Sort by file dimension (images/video) [LOW] - -#### [Macros](../utilities/macro.md) - -- [ ] Sharable Macros [MEDIUM] - - [ ] Standard notation format (TOML) contacting macro instructions [HIGH] - - [ ] Exportable [HIGH] - - [ ] Importable [HIGH] -- [ ] Triggers [HIGH] - - [ ] On new file [HIGH] - - [ ] On library refresh [HIGH] + +!!! tip + For a more definitive and up-to-date list of features planned for near-future updates, please reference the current GitHub [Milestones](https://github.com/TagStudioDev/TagStudio/milestones)! + +--- + +## Core + +### :material-database: SQL Library Database + +An improved SQLite-based library save file format in which legacy JSON libraries are be migrated to. +Must be finalized or deemed "feature complete" before other core features are developed or finalized. + +- [x] A SQLite-based library save file format **[[v9.5.0](./changelog.md#950-2025-03-03)]** +- [ ] Cached File Properties Table :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] 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" } + - [ ] Date File Modified :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Date Photo Taken :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Media Duration :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Media Dimensions :material-chevron-double-up:{ .priority-med title="Medium Priority" } + - [ ] Word Count :material-chevron-up:{ .priority-low title="Low Priority" } + +### :material-database-cog: Core Library + API + +A separated, UI agnostic core library that is used to interface with the TagStudio library format. Would host an API for communication from outside the program. + +- [ ] Core Library :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]** +- [ ] Core Library API :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]** + +### :material-clipboard-text: Format Specification + +A detailed written specification for the TagStudio tag and/or library format. Intended for used by third-parties to build alternative cores or protocols that can remain interoperable. + +- [ ] Format Specification Established :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]** + +--- + +## Application + +### :material-button-cursor: UI/UX + +- [x] Library Grid View + - [ ] Explore Filesystem in Grid View :material-chevron-triple-up:{ .priority-high title="High Priority" } +- [ ] Library List View :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Explore Filesystem in List View :material-chevron-triple-up:{ .priority-high title="High Priority" } +- [ ] 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] Translations +- [ ] Search Bar Rework :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.0]** + - [ ] Improved Tag Autocomplete :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Tags appear as widgets in search bar :material-chevron-triple-up:{ .priority-high title="High Priority" } +- [x] Unified Media Player + - [x] Auto-Hiding Player Controls + - [x] Play/Pause + - [x] Loop + - [x] Toggle Autoplay + - [x] Volume Control + - [x] Toggle Mute + - [x] Timeline scrubber + - [ ] Fullscreen :material-chevron-double-up:{ .priority-med title="Medium Priority" } + - [ ] Fine-Tuned UI/UX :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.4]** +- [ ] 3D Model Thumbnails/Previews :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] STL File Support + - [ ] OBJ File Support +- [ ] Toggleable Persistent Tagging Panel :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Top Tags + - [ ] Recent Tags + - [ ] Tag Search + - [ ] Pinned Tags +- [ ] New Tabbed Tag Building UI to Support New Tag Features :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] Custom Thumbnail Overrides :material-chevron-double-up:{ .priority-med title="Medium Priority" } +- [ ] Media Duration Labels :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] Word/Line Count Labels :material-chevron-up:{ .priority-low title="Low Priority" } +- [ ] Custom Tag Badges :material-chevron-up:{ .priority-low title="Low Priority" } + - Would serve as an addition/alternative to the Favorite and Archived badges. + +### :material-cog: Settings + +- [x] Application Settings + - [x] Stored in System User Folder/Designated Folder + - [x] Language + - [x] Date and Time Format + - [x] Theme +- [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" } +- [ ] Toggle File Extension Label :material-chevron-double-up:{ .priority-med title="Medium Priority" } +- [ ] Toggle Duration Label :material-chevron-double-up:{ .priority-med title="Medium Priority" } + +### :material-puzzle: Plugin Support + +Some form of official plugin support for TagStudio, likely with its own API that may connect to or encapsulate part of the the [core library API](#core-library-api). + +- [ ] Plugin Support :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]** + +--- + +## [Library](../library/index.md) + +### :material-wrench: Library Mechanics + +- [x] Per-Library Tags +- [ ] Global Tags :material-chevron-triple-up:{ .priority-high title="High Priority" } +- [ ] Multiple Root Directories :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] Automatic Entry Relinking :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.0]** + - [ ] Detect Renames :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Detect Moves :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] 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.0]** +- [x] Thumbnail Caching **[[v9.5.0](./changelog.md#950-2025-03-03)]** + - [ ] Audio Waveform Caching :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.7.0]** + +### :material-grid: [Entries](../library/entry.md) + +Library representations of files or file-like objects. + +- [x] File Entries **[v1.0.0]** +- [ ] Folder Entries :material-chevron-triple-up:{ .priority-high title="High Priority" } +- [ ] URL Entries / Bookmarks :material-chevron-up:{ .priority-low title="Low Priority" } +- [x] Fields + - [x] Text Lines + - [x] Text Boxes + - [x] Datetimes **[v9.5.4]** + - [ ] User-Titled Fields :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Removal of Deprecated Fields :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] [Entry Groups](../library/entry_groups.md) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.7.0]** + - [ ] Non-exclusive; Entries can be in multiple groups :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Ability to number entries within group :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Ability to set sorting method for group :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Ability to set custom thumbnail for group :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] 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) + +Discrete library objects representing [attributes](). Can be applied to library [entries](../library/entry.md), or applied to other tags to build traversable relationships. + +- [x] Tag Name **[v8.0.0]** +- [x] Tag Shorthand Name **[v8.0.0]** +- [x] Tag Aliases List **[v8.0.0]** +- [x] Tag Color **[v8.0.0]** +- [ ] Tag Description :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.6.0]** +- [x] Tag Colors + - [x] Built-in Color Palette **[v8.0.0]** + - [x] User-Defined Colors **[[v9.5.0](./changelog.md#950-2025-03-03)]** + - [x] Primary and Secondary Colors **[[v9.5.0](./changelog.md#950-2025-03-03)]** +- [ ] Tag Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Small Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Large Icons for Profiles :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.6.0]** + - [ ] Built-in Icon Packs (i.e. Boxicons) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] User-Defined Icons :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [x] [Category Property](../library/tag_categories.md) **[[v9.5.0](./changelog.md#950-2025-03-03)]** + - [x] Property available for tags that allow the tag and any inheriting from it to be displayed separately in the preview panel under a title + - [ ] Fine-tuned exclusion from categories :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] Hidden Property :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Built-in "Archived" tag has this property by default :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Checkbox near search bar to show hidden tags in search :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] Tag Relationships + - [x] [Parent Tags](../library/tag.md#parent-tags) ([Inheritance]() Relationship) **[v9.0.0]** + - [ ] [Component Tags](../library/tag.md#component-tags) ([Composition](https://en.wikipedia.org/wiki/Object_composition) Relationship) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] Multiple Language Support :material-chevron-up:{ .priority-low title="Low Priority" } **[v9.9.0]** +- [ ] [Tag Overrides](../library/tag_overrides.md) :material-chevron-double-up:{ .priority-med title="Medium Priority" } +- [ ] Tag Merging :material-chevron-double-up:{ .priority-med title="Medium Priority" } + +### :material-magnify: [Search](../library/library_search.md) + +- [x] Tag Search **[v8.0.0]** +- [x] Filename Search **[[v9.5.0](./changelog.md#950-2025-03-03)]** + - [x] Glob Search **[[v9.5.0](./changelog.md#950-2025-03-03)]** +- [x] Filetype Search **[[v9.5.0](./changelog.md#950-2025-03-03)]** + - [x] Search by Extension (e.g. ".jpg", ".png") **[[v9.5.0](./changelog.md#950-2025-03-03)]** + - [x] Optional consolidation of extension synonyms (i.e. ".jpg" can equal ".jpeg") **[[v9.5.0](./changelog.md#950-2025-03-03)]** + - [x] Search by media type (e.g. "image", "video", "document") **[[v9.5.0](./changelog.md#950-2025-03-03)]** +- [ ] Field Content Search :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [x] [Boolean Operators](../library/library_search.md) **[[v9.5.0](./changelog.md#950-2025-03-03)]** + - [x] `AND` Operator + - [x] `OR` Operator + - [x] `NOT` Operator + - [x] Parenthesis Grouping + - [x] Character Escaping +- [ ] `HAS` Operator (for [Component Tags](../library/tag.md#component-tags)) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] Conditional Search :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.7.0]** + - [ ] Compare Dates :material-chevron-double-up:{ .priority-med title="Medium Priority" } + - [ ] Compare Durations :material-chevron-double-up:{ .priority-med title="Medium Priority" } + - [ ] Compare File Sizes :material-chevron-double-up:{ .priority-med title="Medium Priority" } + - [ ] Compare Dimensions :material-chevron-double-up:{ .priority-med title="Medium Priority" } +- [x] Smartcase Search [[v9.5.0](./changelog.md#950-2025-03-03)] +- [ ] Search Result Sorting + - [x] Sort by Filename **[[v9.5.2](./changelog.md#952-2025-03-31)]** + - [x] Sort by Date Entry Added to Library **[[v9.5.2](./changelog.md#952-2025-03-31)]** + - [ ] Sort by File Creation Date :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Sort by File Modification Date :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Sort by File Modification Date :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Sort by Date Taken (Photos) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** +- [ ] OCR Search :material-chevron-up:{ .priority-low title="Low Priority" } +- [ ] Fuzzy Search :material-chevron-up:{ .priority-low title="Low Priority" } + +### :material-file-cog: [Macros](../utilities/macro.md) + +- [ ] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.4]** +- [ ] Versioning System :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.5.4]** +- [ ] Triggers **[v9.5.4]** + - [ ] On File Added :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] On Library Refresh :material-chevron-triple-up:{ .priority-high title="High Priority" } - [ ] [...] -- [ ] Actions [HIGH] - - [ ] Add tag(s) [HIGH] - - [ ] Add field(s) [HIGH] - - [ ] Set field content [HIGH] +- [ ] Actions **[v9.5.4]** + - [ ] Add Tag(s) :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Add Field(s) :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Set Field Content :material-chevron-triple-up:{ .priority-high title="High Priority" } - [ ] [...] -#### UI - -- [ ] Custom thumbnail overrides [MEDIUM] -- [ ] Toggle File Extension Label [MEDIUM] -- [ ] Toggle Duration Label [MEDIUM] -- [ ] Custom Tag Badges [LOW] -- [ ] Library list view [HIGH] - -### v9.8 - -#### Library - -- [ ] Automatic Entry Relinking [HIGH] - - [ ] Detect Renames [HIGH] - - [ ] Detect Moves [HIGH] - - [ ] Detect Deletions [HIGH] - -#### Search - -- [ ] OCR search [LOW] -- [ ] Fuzzy Search [LOW] - -### v9.9 - -#### Library - -- [ ] Exportable Library Data [HIGH] - - [ ] Standard notation format (i.e. JSON) contacting all library data [HIGH] - -#### Tags - -- [ ] Tag Packs [MEDIUM] - - [ ] Human-readable (TOML) files containing tag data [HIGH] - - [ ] Multiple Languages for Tag Strings [MEDIUM] - - [ ] Importable [HIGH] - - [ ] Exportable [HIGH] - - [ ] Conflict resolution [HIGH] - -### v10.0 - -- [ ] All remaining [HIGH] and optional [MEDIUM] features - -### Post v10.0 - -#### Core - -- [ ] Core Library/API -- [ ] Plugin Support +### :material-table-arrow-right: Sharable Data + +Sharable TagStudio library data in the form of data packs (tags, colors, etc.) or other formats. +Packs are intended as an easy way to import and export specific data between libraries and users, while export-only formats are intended to be imported by other programs. + +- [ ] Color Packs :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Importable + - [ ] Exportable + - [x] UUIDs + Namespaces :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [x] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Versioning System :material-chevron-double-up:{ .priority-med title="Medium Priority" } +- [ ] Tag Packs :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.9.0]** + - [ ] Importable :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Exportable :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] UUIDs + Namespaces :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Standard, Human Readable Format (TOML) :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Versioning System :material-chevron-double-up:{ .priority-med title="Medium Priority" } +- [ ] Macro Sharing :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v9.6.0]** + - [ ] Importable :material-chevron-triple-up:{ .priority-high title="High Priority" } + - [ ] Exportable :material-chevron-triple-up:{ .priority-high title="High Priority" } +- [ ] Sharable Entry Data :material-chevron-double-up:{ .priority-med title="Medium Priority" } **[v9.9.0]** + - _Specifics of this are yet to be determined_ +- [ ] Export Library to Human Readable Format :material-chevron-triple-up:{ .priority-high title="High Priority" } **[v10.0.0]** + - Intended to give users more flexible options with their data if they wish to migrate away from TagStudio diff --git a/mkdocs.yml b/mkdocs.yml index e5a5f4cff..2f12508d6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -91,6 +91,7 @@ theme: - content.code.annotate - content.code.copy - content.action.edit + - content.tooltips icon: repo: fontawesome/brands/github tag: @@ -105,6 +106,7 @@ markdown_extensions: - def_list - footnotes - md_in_html + - tables - toc: permalink: true @@ -115,11 +117,15 @@ markdown_extensions: smart_enable: all - pymdownx.caret - pymdownx.details + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg - pymdownx.highlight - pymdownx.inlinehilite - pymdownx.keys - pymdownx.mark - pymdownx.smartsymbols + - pymdownx.snippets - pymdownx.superfences: custom_fences: - name: mermaid