Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions ui/v2.5/src/docs/en/Manual/AutoTagging.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Auto Tag
# Auto tag

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.

Expand Down Expand Up @@ -39,7 +39,7 @@ Scenes, images, and galleries that have the Organized flag added to them will no

Studios also support the Organized flag, however it is purely informational. It serves as a front-end indicator for the user to mark that a studio's collection is complete and does not affect Auto tag behavior. The Ignore Auto tag flag should be used to exclude a studio from Auto tag.

### Ignore Auto tag flag
### Ignore auto tag flag

Performers or Tags that have Ignore Auto tag flag added to them will be skipped by the Auto tag task.

Expand Down
35 changes: 27 additions & 8 deletions ui/v2.5/src/docs/en/Manual/Browsing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Browsing

## Querying and Filtering
## Querying and filtering

### Keyword searching

Expand All @@ -17,15 +17,34 @@ The text field allows you to search using keywords. Keyword searching matches on
| Studio | Name, Aliases |
| Tag | Name, Aliases |

### Rules

Keyword matching uses the following rules:

* all words are required in the matching field. For example, `foo bar` matches scenes with both `foo` and `bar` in the title.
* the `or` keyword or symbol (`|`) is used to match either fields. For example, `foo or bar` (or `foo | bar`) matches scenes with `foo` or `bar` in the title. Or sets can be combined. For example, `foo or bar or baz xyz or zyx` matches scenes with one of `foo`, `bar` and `baz`, *and* `xyz` or `zyx`.
* the not symbol (`-`) is used to exclude terms. For example, `foo -bar` matches scenes with `foo` and excludes those with `bar`. The not symbol cannot be combined with an or operand. That is, `-foo or bar` will be interpreted to match `-foo` or `bar`. On the other hand, `foo or bar -baz` will match `foo` or `bar` and exclude `baz`.
* surrounding a phrase in quotes (`"`) matches on that exact phrase. For example, `"foo bar"` matches scenes with `foo bar` in the title. Quotes may also be used to escape the keywords and symbols. For example, `foo "-bar"` will match scenes with `foo` and `-bar`.
* quoted phrases may be used with the or and not operators. For example, `"foo bar" or baz -"xyz zyx"` will match scenes with `foo bar` *or* `baz`, and exclude those with `xyz zyx`.
* `or` keywords or symbols at the start or end of a line will be treated literally. That is, `or foo` will match scenes with `or` and `foo`.
* all keyword matching is case-insensitive
- By default, all terms are required in the same matching field.
- Use the `or` keyword or `|` symbol to match either term.
- You can combine `or` sets in one query.
- Use the `-` symbol to exclude terms.
- The `-` symbol cannot be combined with an `or` operand.
- Use quotes (`"`) to match an exact phrase.
- Quotes can also escape keywords and symbols.
- `or` at the start or end of a query is treated literally.
- Keyword matching is case-insensitive.

#### Examples

| Query | Behavior | Explanation |
|---|---|---|
| `foo bar` | Requires both `foo` and `bar`. | Both terms must match in the same field. |
| `foo or bar` or `foo | bar` | Matches either `foo` or `bar`. | `or` and `|` are equivalent. |
| `foo or bar or baz xyz or zyx` | Matches one of `foo`, `bar`, or `baz`, and either `xyz` or `zyx`. | Multiple `or` sets can be combined. |
| `foo -bar` | Matches `foo`, excludes `bar`. | `-` excludes terms. |
| `-foo or bar` | Interpreted as `-foo` or `bar`. | `-` cannot be combined with an `or` operand. |
| `foo or bar -baz` | Matches `foo` or `bar`, excludes `baz`. | Exclusion is applied alongside the `or` set. |
| `"foo bar"` | Matches the exact phrase `foo bar`. | Quotes perform exact phrase matching. |
| `foo "-bar"` | Matches `foo` and the literal text `-bar`. | Quotes escape keyword/operator parsing. |
| `"foo bar" or baz -"xyz zyx"` | Matches `foo bar` or `baz`, excludes `xyz zyx`. | Quoted phrases can be used with `or` and `-`. |
| `or foo` | Matches literal `or` and `foo`. | `or` is literal at the start or end of a query. |

### Filters

Expand Down
2 changes: 1 addition & 1 deletion ui/v2.5/src/docs/en/Manual/Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Financial

Financial contributions are welcomed and are accepted using [Open Collective](https://opencollective.com/stashapp).
Financial contributions are welcomed and are accepted using [Open Collective](https://opencollective.com/stashapp) or [GitHub Sponsors](https://github.com/sponsors/stashapp).

## Development-related

Expand Down
2 changes: 1 addition & 1 deletion ui/v2.5/src/docs/en/Manual/Deduplication.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Dupe Checker
# Dupe checker

[The dupe checker](/sceneDuplicateChecker) searches your collection for scenes that are perceptually similar. This means that the files don't need to be identical, and will be identified even with different bitrates, resolutions, and intros/outros.

Expand Down
20 changes: 12 additions & 8 deletions ui/v2.5/src/docs/en/Manual/EmbeddedPlugins.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
# Embedded Plugin Tasks
# Embedded plugin tasks

Embedded plugin tasks are executed within the stash process using a scripting system.

## Supported script languages

Stash currently supports Javascript embedded plugin tasks using [goja](https://github.com/dop251/goja).
Stash currently supports JavaScript embedded plugin tasks using [goja](https://github.com/dop251/goja).

## Javascript plugins
## JavaScript plugins

### Plugin input

The input is provided to Javascript plugin tasks using the `input` global variable, and is an object based on the structure provided in the `Plugin input` section of the [Plugins](/help/Plugins.md) page.
The input is provided to JavaScript plugin tasks using the `input` global variable, and is an object based on the structure provided in the `Plugin input` section of the [Plugins](/help/Plugins.md) page.

> **⚠️ Note:** `server_connection` field should not be necessary in most embedded plugins.

### Plugin output

The output of a Javascript plugin task is derived from the evaluated value of the script. The output should conform to the structure provided in the `Plugin output` section of the [Plugins](/help/Plugins.md) page.
The output of a JavaScript plugin task is derived from the evaluated value of the script. The output should conform to the structure provided in the `Plugin output` section of the [Plugins](/help/Plugins.md) page.

There are a number of ways to return the plugin output:

#### Example #1

```
(function() {
return {
Expand All @@ -30,6 +31,7 @@ There are a number of ways to return the plugin output:
```

#### Example #2

```
function main() {
return {
Expand All @@ -41,6 +43,7 @@ main();
```

#### Example #3

```
var output = {
Output: "ok"
Expand All @@ -62,13 +65,14 @@ For embedded plugins, the `exec` field is a list with the first element being th
### interface

For embedded plugins, the `interface` field must be set to one of the following values:
* `js`

## Javascript API
- `js`

## JavaScript API

### Logging

Stash provides the following API for logging in Javascript plugins:
Stash provides the following API for logging in JavaScript plugins:

| Method | Description |
|--------|-------------|
Expand Down
2 changes: 1 addition & 1 deletion ui/v2.5/src/docs/en/Manual/ExternalPlugins.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# External Plugin Tasks
# External plugin tasks
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it not be better to keep title casing for these?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you mean the section headers specifically, I used the same sentence case as I don't like mixed capitalization rules.

Technically we could use title case for level 1 headings and sentence case for the rest, but to me it looks unorganized.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, whatever way you wanna do it. Ultimately it's not a big deal to me.


External plugin tasks are executed by running an external binary.

Expand Down
3 changes: 1 addition & 2 deletions ui/v2.5/src/docs/en/Manual/Images.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Images and Galleries
# Images and galleries

Images are the parts which make up galleries, but you can also have them be scanned independently. To declare an image part of a gallery, there are four ways:

Expand Down Expand Up @@ -28,4 +28,3 @@ A clip/gif will be a stillframe in the wall and grid view by default. To view th

If you want the loop to be used as a preview on the wall and grid view, you will have to generate them.
You can do this as you scan for the new clip file by activating **Generate previews for image clips** on the scan settings, or do it after by going to the **Generated Content** section in the task section of your settings, activating **Image clip previews** and clicking generate. This takes a while, as the files are transcoded.

8 changes: 4 additions & 4 deletions ui/v2.5/src/docs/en/Manual/Interface.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Interface Options
# Interface options

## Language

Expand All @@ -13,7 +13,7 @@ When SFW content mode is enabled, the following changes are made to the UI:
- certain adult-specific metadata fields are hidden (e.g. performer genital fields)
- `O`-Counter is replaced with `Like`-counter

## Scene/Marker Wall Preview type
## Scene/marker wall preview type

The Scene Wall and Marker pages display scene preview videos (mp4) by default. This can be changed to animated image (webp) or static image.

Expand All @@ -23,7 +23,7 @@ The Scene Wall and Marker pages display scene preview videos (mp4) by default. T

By default, in the grid card view the studio will be shown as an image overlay of the studio logo. Checking this option changes this to display studios as a text name instead.

## Scene Player options
## Scene player options

By default, scene videos do not automatically start when navigating to the scenes page. Checking the "Auto-start video" option changes this to auto play scene videos.

Expand All @@ -47,7 +47,7 @@ There is also a [collection of community-created themes](https://discourse.stash

Stash supports the injection of custom JavaScript to assist with theming or adding additional functionality. Be aware that bad JavaScript could break the UI or worse.

## Custom Locales
## Custom locales

The localisation strings can be customised. The master list of default (en-GB) locale strings can be found [here](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/locales/en-GB.json). The custom locale format is the same as this json file.

Expand Down
13 changes: 11 additions & 2 deletions ui/v2.5/src/docs/en/Manual/JSONSpec.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Import/Export JSON Specification
# Import/export JSON specification

The metadata given to Stash can be exported into the JSON format. This structure can be modified, or replicated by other means. The resulting data can then be imported again, giving the possibility for automatic scraping of all kinds. The format of this metadata bulk is a folder structure, containing the following folders:

Expand Down Expand Up @@ -26,7 +26,7 @@ When exported, files are named with different formats depending on the object ty

> **⚠️ Note:** The file naming is not significant when importing. All json files will be read from the subdirectories.

## Content of the json files
## Content of the JSON files

In the following, the values of the according jsons will be shown. If the value should be a number, it is written with after comma values (like `29.98` or `50.0`), but still as a string. The meaning from most of them should be obvious due to the previous explanation or from the possible values stash offers when editing, otherwise a short comment will be added.

Expand All @@ -43,6 +43,7 @@ Example:
```

### Performer

```
name
url
Expand All @@ -69,6 +70,7 @@ details
```

### Studio

```
name
url
Expand All @@ -80,6 +82,7 @@ details
```

### Scene

```
title
studio
Expand Down Expand Up @@ -111,6 +114,7 @@ updated_at


### Image

```
title
studio
Expand All @@ -127,6 +131,7 @@ updated_at
```

### Gallery

```
title
studio
Expand All @@ -145,6 +150,7 @@ updated_at
## Files

### Folder

```
zip_file (path to containing zip file)
mod_time
Expand All @@ -155,6 +161,7 @@ updated_at
```

### Video file

```
zip_file (path to containing zip file)
mod_time
Expand All @@ -179,6 +186,7 @@ updated_at
```

### Image file

```
zip_file (path to containing zip file)
mod_time
Expand All @@ -196,6 +204,7 @@ updated_at
```

### Other files

```
zip_file (path to containing zip file)
mod_time
Expand Down
Loading
Loading