diff --git a/ui/v2.5/src/docs/en/Manual/AutoTagging.md b/ui/v2.5/src/docs/en/Manual/AutoTagging.md index c311bed7a..90d0a0d11 100644 --- a/ui/v2.5/src/docs/en/Manual/AutoTagging.md +++ b/ui/v2.5/src/docs/en/Manual/AutoTagging.md @@ -1,18 +1,46 @@ -# Auto Tagging +# Auto Tag -When media filepaths or filenames contain a Performer, Studio, or Tag name, it is assigned those Performers, Studios, and Tags. It will **only** tag based on Performer, Studio, and Tag names that exist in your database. +Auto Tag automatically assigns Performers, Studios, and Tags to your media based on their names found in file paths or filenames. This task works for scenes, images, and galleries. -When the Performer/Studio/Tag name has multiple words, the search will include paths/filenames where the Performer/Studio/Tag name is separated with `.`, `-`, `_`, and whitespace characters. +## Rules -For example, auto tagging for performer `Jane Doe` will match the following filenames: +> **Important:** Auto Tag only works for names that already exist in your Stash database. It does not create new Performers, Studios, or Tags. -* `Jane.Doe.1.mp4` -* `Jane_Doe.2.mp4` -* `Jane-Doe.3.mp4` -* `Jane Doe.4.mp4` + - Multi-word names are matched when words appear in order and are separated by any of these characters: `.`, `-`, `_`, or whitespace. These separators are treated as word boundaries. + - Matching is case-insensitive but requires complete words within word boundaries. Partial words or misspelled words will not match. + - Auto Tag does not match performer aliases. Aliases will not be considered during matching. -Matching is case insensitive, and should only match exact wording within word boundaries. For example, the tag `Jane Doe` will not match `Maryjane-Doe` or `Jane-Doen`, but will match `Mary-Jane-Doe`, `Jane-Doe_n`, and `[OF]jane doe`. +### Examples (performer "Jane Doe") -Auto tagging for specific Performers, Studios, and Tags can be performed from the individual Performer/Studio/Tag page. +**Matches:** -> **Note:** Performer autotagging does not currently match on performer aliases. \ No newline at end of file +| Example | Explanation | +|---|---| +| `Jane.Doe.1.mp4` | Dot as separator. | +| `Jane_Doe.2.mp4` | Underscore as separator. | +| `Jane-Doe.3.mp4` | Hyphen as separator. | +| `Jane Doe.4.mp4` | Whitespace as separator. | +| `Mary-Jane-Doe` | Extra characters around word boundaries are allowed. | +| `Jane-Doe_n` | Extra characters around word boundaries are allowed. | +| `[OF]jane doe` | Extra characters around word boundaries are allowed. | + +**Does not match:** + +| Example | Explanation | +|---|---| +| `Maryjane-Doe` | Combined words without separator. | +| `Jane-Doen` | Spelling mismatch. | + +### Organized flag + +Scenes, images, and galleries that have the Organized flag added to them will not be modified by Auto Tag. You can also use Organized flag status as a filter. + +### Ignore Auto Tag flag + +Performers or Tags that have Ignore Auto Tag flag added to them will be skipped by the Auto Tag task. + +## Running task + +- **Auto Tag:** You can run the Auto Tag task on your entire library from the Tasks page. +- **Selective Auto Tag:** You can run the Auto Tag task on specific directories from the Tasks page. +- **Individual pages:** You can run Auto Tag tasks for specific Performers, Studios, and Tags from their respective pages. \ No newline at end of file