stashapp/StashDB-Docs
1
0
Fork 0
mirror of https://github.com/stashapp/StashDB-Docs.git synced 2025-12-10 17:32:17 -06:00
Code Issues Packages Projects Releases Wiki Activity

Pushes Jekyll site from StashDB-Guidelines-Beta repo, with updated _config.yml

Browse Source
This commit is contained in:
AdultSun 2022-09-06 23:41:02 -07:00
parent e5045618e5
commit b3f08a313f
32 changed files with 1658 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
.github/workflows/pages.yml vendored Normal file
View File

@ -0,0 +1,50 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Build with Jekyll
uses: actions/jekyll-build-pages@v1
with:
source: ./
destination: ./_site
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1

3
.gitignore vendored Normal file
View File

@ -0,0 +1,3 @@
# ignore directories for local testing
.jekyll-cache/
_site/

8
Gemfile Normal file
View File

@ -0,0 +1,8 @@
source "https://rubygems.org"
gem "webrick", "~> 1.7"
gem "just-the-docs"
group :jekyll_plugins do
gem "jekyll-remote-theme", "~> 0.4.2"
end

83
Gemfile.lock Normal file
View File

@ -0,0 +1,83 @@
GEM
remote: https://rubygems.org/
specs:
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
colorator (1.1.0)
concurrent-ruby (1.1.10)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
eventmachine (1.2.7)
ffi (1.15.5-x64-mingw-ucrt)
forwardable-extended (2.6.0)
http_parser.rb (0.8.0)
i18n (1.12.0)
concurrent-ruby (~> 1.0)
jekyll (4.2.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 1.0)
jekyll-sass-converter (~> 2.0)
jekyll-watch (~> 2.0)
kramdown (~> 2.3)
kramdown-parser-gfm (~> 1.0)
liquid (~> 4.0)
mercenary (~> 0.4.0)
pathutil (~> 0.9)
rouge (~> 3.0)
safe_yaml (~> 1.0)
terminal-table (~> 2.0)
jekyll-remote-theme (0.4.3)
addressable (~> 2.0)
jekyll (>= 3.5, < 5.0)
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
rubyzip (>= 1.3.0, < 3.0)
jekyll-sass-converter (2.2.0)
sassc (> 2.0.1, < 3.0)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
just-the-docs (0.3.3)
jekyll (>= 3.8.5)
jekyll-seo-tag (~> 2.0)
rake (>= 12.3.1, < 13.1.0)
kramdown (2.4.0)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.4.0)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (5.0.0)
rake (13.0.6)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.30.0)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sassc (2.4.0)
ffi (~> 1.9)
terminal-table (2.0.0)
unicode-display_width (~> 1.1, >= 1.1.1)
unicode-display_width (1.8.0)
webrick (1.7.0)
PLATFORMS
x64-mingw-ucrt
DEPENDENCIES
jekyll-remote-theme (~> 0.4.2)
just-the-docs
webrick (~> 1.7)
BUNDLED WITH
2.3.21

49
_config.yml Normal file
View File

@ -0,0 +1,49 @@
remote_theme: just-the-docs/just-the-docs
plugins:
- jekyll-remote-theme
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
source: ./
title: StashDB Guidelines
description: A list of guidelines and suggestions for StashDB.org contributors, approved by the community.
baseurl: "/StashBox-Docs"
url: "https://stashapp.github.io/"
permalink: pretty
# Set a path/url to a logo that will be displayed instead of the title
#logo: "/assets/images/just-the-docs.png"
#logo: https://stashapp.cc/images/stash.svg
# Aux links for the upper right navigation
aux_links:
"StashDB.org":
- "https://stashdb.org"
# External navigation links
nav_external_links:
- title: StashDB.org
url: https://stashdb.org
- title: Stash on Discord
url: https://discord.com/channels/559159668438728723
- title: Stash on GitHub
url: https://github.com/stashapp/stash
- title: Stash-Box on GitHub
url: https://github.com/stashapp/stash-box
# Footer content
# appears at the bottom of every page's main content
# Back to top link
back_to_top: true
back_to_top_text: "Back to top"
footer_content: "Approved by the community driving <a href=\"https://stashdb.org\">StashDB.org</a>"
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
color_scheme: stashdb-dark
kramdown:
syntax_highlighter_opts:
block:
line_numbers: false

13
_sass/color_schemes/stashdb-dark.scss Normal file
View File

@ -0,0 +1,13 @@
$link-color: #48aff0;
$btn-primary-color: #48aff0;
$base-button-color: $grey-dk-250;
$sidebar-color: #394B59;
$body-background-color: #202B33;
$body-text-color: #FFFFFF;
$body-heading-color: #F5F8FA;
$nav-child-link-color: #E9ECEF;
$border-color: #808080;
$table-background-color: $grey-dk-250;
$feedback-color: darken($sidebar-color, 3%);
$search-result-preview-color: $grey-dk-000;
$search-background-color: $grey-dk-250;

4
_sass/color_schemes/stashdb-light.scss Normal file
View File

@ -0,0 +1,4 @@
$link-color: #137CBD;
$btn-primary-color: #137CBD;
$sidebar-color: #E9ECEF;
$body-text-color: #000000;

131
docs/getting-started-stashdb.md Normal file
View File

@ -0,0 +1,131 @@
---
layout: default
title: "Getting Started: StashDB"
nav_order: 2
---
# **Getting Started: StashDB**
{: .no_toc }
The following sections are general advice and explanations for potentially confusing aspects in our database. Because they don't represent explicit decisions concerning database management or curation, they do not require formal approval. Additional **Getting Started** sections specific to [Performers]({{ site.baseurl }}/docs/performers/getting-started-performers/), [Scenes]({{ site.baseurl }}/docs/scenes/getting-started-scenes/), [Studios]({{ site.baseurl }}/docs/studios/getting-started-studios/), and [Tags]({{ site.baseurl }}/docs/tags/getting-started-tags/) can also be found under their respective categories in the navigation tree to the left. The sections below cover broader subjects that are not exclusive to one of those four categories.
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### What is StashDB?
- **Our shared database of scene, performer, and studio metadata. Does not host video files or unofficial download links.**
StashDB is our shared public instance of the Stash-Box software. It hosts information about a wide variety of scenes, studios, and performers that can be easily pulled into your own installation of Stash. It does not host any video files or link to any unofficial downloads. Very few users will have reason to host or install a Stash-Box instance themselves, so if you're confused by the terminology just focus on [linking StashDB to your local installation of Stash](#accessing-stashdb). Detailed instructions for connecting to StashDB can be found in the pinned messages of our **#stashdb-invites** channel on [Discord](#joining-our-discord).
### What Makes StashDB Better?
- **Full integration with Stash and improved scene matching using various fingerprints (PHashes).**
StashDB is not the only source of much of its metadata. When filling out information in Stash, you will likely use multiple sources to cover various parts of your collection. Stash has a helpful [repository of scrapers](https://github.com/stashapp/CommunityScrapers) to assist with that. Each source will have its own strengths and weaknesses, just like StashDB. However, the main advantages of using StashDB over similar databases are:
1. **Full continuing integration with Stash.** Stash, Stash-Box, and StashDB are all part of the same shared project. They all enjoy the benefits of parallel development, always keeping each other in mind when creating or updating new features. Updating info in Stash from StashDB should be easier and more versatile than using other sources, just as updating StashDB from within Stash should become more convenient as well.
2. **The ability to match your files with scene entries on StashDB using hashes/fingerprints alone.** With the inclusion of [perceptual hashes](#whats-a-phash), even files of differing resolutions, encodes, or download sources will often be similar enough to still match with StashDB. In other words, your files and their hashes don't have to be exact matches with the fingerprints on StashDB. Stash will be able to find matches as long as your video _looks just similar enough_ to somebody else's fingerprint submission. This level of fuzzy matching makes our system much more reliable, flexible, and versatile than alternative approaches.
### Joining Our Discord
- **Necessary for accessing StashDB, click link for details.**
The Stash Discord server is your best bet for finding help and resources relating to Stash, Stash-Box, and StashDB. You will need to have a Discord account and join our server in order to [access StashDB](#accessing-stashdb). You could create a temporary throwaway account on Discord for this purpose if you'd like. However, if you would like to [contribute more than just hashes to StashDB](#contributing-to-stashdb), you will also be expected to be reachable on Discord. If you've already joined, the link is in the sidebar to the left.
[Click here to join our Discord server.](https://discord.gg/2TsNFKt)
### Accessing StashDB
- **Must create an account, details found on Discord.**
You will need to create a StashDB account to access it from within Stash. Instructions for creating an account and connecting it to Stash can only be found in [our Discord server](#joining-our-discord) at this time. Look for the pinned messages in the **#stashdb-invites** channel for detailed instructions.
### Using StashDB
- **Tagger Views are recommended for pulling info from StashDB, Identify task is faster but less accurate.**
The recommended method for pulling information from StashDB into your local Stash is through the Tagger view. The Tagger can be found on both the Scenes page and the Performers page by clicking on the double-label icon on the far right end of the toolbar near the top of the webpage. With the [Scene Tagger](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Tagger.md), you can match your scenes with StashDB entries by keyword or fingerprint, save that information to your scene including a link to StashDB called the StashID, and submit your fingerprints back to StashDB to help other users match their own scenes. Be sure to check out the "Scrape All" button (limited to one page at a time), the green checkmarks to customize which fields to overwrite, and the gear icon for additional settings. If you've already found your scene's entry on StashDB, you can paste the [StashID](#whats-a-stashid) directly into the "Query" field to ensure an accurate match. See this [same link embedded above](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Tagger.md) for more details from Stash's in-app manual.
The Performer Tagger works similarly. Don't miss the "Batch Add Performers" and "Batch Update Performers" buttons on the top right, with a "Show Configuration" link on the opposite side. You can still paste the [StashID](#whats-a-stashid) directly into the search field if you've found the correct performer entry on StashDB already. Individual fields can be turned on and off for each scrape as well.
The [Identify](https://github.com/stashapp/stash/blob/develop/ui/v2.5/src/docs/en/Identify.md) task can also pull scene info from StashDB. You can customize your settings beforehand, but this is a hands-off automated function unlike the Tagger views. There's no way to verify a match is correct before its info is saved locally. Because of this lack of manual verification, it does not submit your fingerprints to StashDB during this process. The Scene Tagger is still the only way to do this.
Finally, if you have [edit access](#contributing-to-stashdb), you can add scenes and performers to StashDB by submitting drafts directly from within Stash. From within a scene's details page, click on the three vertical dots in the top right of the details pane and select the "Submit to Stash-Box" option. Clicking the "Submit" button in the resulting dialog box will save a draft to create that scene/performer on StashDB using the information you have saved locally. From the [Drafts](https://stashdb.org/drafts) page, you can make any necessary changes, leave an [edit comment](#edit-comments), and finally submit your draft to be [approved](#voting-on-stashdb) just like any other edit.
### What's a PHash?
- **Perceptual hashes are generated from what a video looks like, allowing for more reliable scene matching with StashDB.**
[Perceptual hashes](https://hackerfactor.com/blog/index.php%3F/archives/432-Looks-Like-It.html) (PHashes) are one of the main reasons why we [recommend using StashDB](#what-makes-stashdb-better) with Stash. PHashes are used to match your video files with scene entries on StashDB. Even files of differing resolutions, encodes, or download sources will often be similar enough to still match with StashDB. In other words, your files and their hashes don't have to be exact matches with the fingerprints on StashDB. Stash will be able to find matches as long as your video _looks just similar enough_ to somebody else's fingerprint submission. This level of fuzzy matching makes our system much more reliable, flexible, and versatile than alternative approaches. PHashes can also be used in Stash to detect duplicate files in your library, using the "Scene Duplicate Checker" in the "Tools" tab of the Settings page.
PHashes are not generated in Stash by default, so you will need to create them yourself. They may be generated during a Scan by activating the switch next to "Generate perceptual hashes" or through the Generate task (in the "Tasks" tab of the Settings page or the "Generate..." option with individual scenes selected) next to "Perceptual hashes (for deduplication)". These may be submitted to existing scenes on StashDB along with other fingerprints using the [Scene Tagger](#using-stashdb) and will be included automatically when [submitting new scenes via draft](#using-stashdb).
### What's a StashID?
- **Unique ID for entries in StashDB, found at the end of URLs and saved to Stash after a match.**
A StashID is the unique identifier for an entry on StashDB. It can be found in the URL of a scene/performer/studio entry as the string of seemingly random numbers and letters at the end. StashIDs can be saved to your own scenes, performers, and studios in Stash when using the [Tagger view or Identify function](#using-stashdb) as well as a Stash-Box scraper. This links your local entries in Stash to their match on StashDB for future reference and scrapes.
As there is no Studio Tagger or studio scraper support, the Scene Tagger view is currently the only way to attach a StashID to a locally saved studio. The Tagger will give you several options to choose from when it doesn't find a studio's StashID saved anywhere locally. From left to right, you can create a new studio with the suggested name and StashID (no other details are saved at this time), skip the studio field entirely, or attach the StashID to a studio you've already created. This last option will be selected automatically if a studio's primary name or an alias exactly match the name of the suggested studio on StashDB. Be sure to click the floppy disk icon to save your selected action, creating the new studio or attaching the StashID.
### Contributing to StashDB
- **Submitting fingerprints is possible with every account, but any other edit/submission requires permissions granted through Discord.**
Every StashDB account is able to submit fingerprints/hashes from within the Scene Tagger view of Stash. This does not require any additional permissions. However, if you would like to add or edit performers, scenes, studios, or tags, you will need to be granted additional privileges. Requesting edit access is not difficult. Detailed instructions can be found pinned to the **#stashdb-invites** channel on [Discord](#joining-our-discord). Please note that you will be expected to be reachable on Discord if you become an active contributor on StashDB. This is because there is no messaging or notification system from within StashDB at this time. If we cannot reach you over Discord, your edit rights may be revoked by an admin after repeated violations of our guidelines.
### Bulk Edits
- **Big projects that require a large number of edits should be pitched on Discord first for approval.**
Any projects that would affect a large amount of data on StashDB and/or require a high volume of individual edits will need to be approved on Discord first by dropping a question in the **#stashdb-general** channel. If it's in line with the guidelines already established on this Wiki, than a simple "heads up" before starting may be all that is needed from you. More drastic changes may require formal approval as a [guideline proposal](#guideline-proposals) in the **#stashdb-guidelines** channel on Discord. Projects that would add more than a few dozen edits into the queue at a time may need to be broken up into smaller chunks. All of these points apply to both manual submissions and automated submissions.
### Voting on StashDB
- **Different voting thresholds apply to destructive vs. non-destructive edits. Voting rights granted automatically after 10 approved submissions.**
All edit submissions to StashDB will be subject to approval by the votes of other contributors. Voting rights will be granted automatically once you have 10 submissions approved.
Edits considered non-destructive may be approved immediately if they receive three unanimous YES votes. They may also be rejected immediately with three unanimous NO votes. Destructive edits (Merge and Destroy requests, mostly) and non-unanimous vote totals will require a waiting period to pass before it is rejected or approved. This may be 3 days or 7 days, depending on the current vote total. Net totals of 0 votes will still be approved at the end of the waiting period for non-destructive edits but will be rejected for destructive edits. For more details on a particular edit, hovering your cursor over "Voting closes in X days" in the top right corner will show you if it will be rejected or approved with the current vote total as well as the exact day and time the voting period will end.
The ABSTAIN option is only used if you would like to remove your YES or NO vote rather than changing it. The "Save" button will not appear when ABSTAIN is selected unless you have previously saved a YES or NO vote on that edit.
### Asking for Votes
- **Asking on Discord is discouraged unless the edit needs to be approved before additional edits can be submitted.**
Typically, asking on Discord for votes to approve your own edit is seen as impolite. Many see it as similar to jumping to the front of the line instead of waiting your turn. There are exceptions to this though. Often edits act as "blockers" to other edits. Maybe someone has a scene they want to add to StashDB, but they need a performer or studio to be approved first before they can be attached to the scene submission. The performer/studio submission is considered a "blocker" to the scene submission, so it would be appropriate to ask in the **#stashdb-general** channel on [Discord](#joining-our-discord) to expedite its approval. In cases like these, longer approval times actually do inconvenience the contributor where waiting on typical edits would not.
### Unconfirmed Guidelines
- **Still expected to be followed but subject to change pending formal approval.**
Early on, many of this Wiki's sections will have this message at the bottom:
_Unconfirmed guideline, subject to change pending formal approval._
All this means is that the language has not been formally approved by the community in our **#stashdb-guidelines** channel on [Discord](#joining-our-discord) yet. Contributors are still expected to follow these unconfirmed guidelines, but should know that they are subject to change in the near future.
### Guideline Proposals
- **Changes to guidelines require formal approval, so ask about it on Discord first.**
If you would like to make a change or addition to the guidelines in this Wiki, please ask about your idea in our **#ministry-of-truth** channel on [Discord](#joining-our-discord) first. If your suggestion gains traction there, a formal proposal will need to be approved by the community in the **#stashdb-guidelines** channel. Only users with elevated Discord roles will be able to post proposals there.
### Edit Comments
- **Say what you're doing, why you're doing it, and what your sources are.**
Regardless of what kind of edit you're submitting, always include in the comment field what you are doing and why. Bigger or more drastic changes will likely require longer comments, but simple changes likely won't need much. Also please remember to note what you are using as the source of your edit when appropriate. These notes will be helpful when considering further edits in addition to justifying your actions now to those who will be voting on it.
### Low Effort Submissions
- **Submissions may be rejected as "low effort" if it will take more time/effort to fix than it would've taken the OP to do correctly in the first place.**
Submissions of any kind may be rejected if voters deem them to be "low effort" even if it doesn't technically violate any other guidelines and all of its information is correct. "Low effort" submissions appear rushed and often leave out information that is obvious or easily found. The reasoning behind rejection is that "low effort" submissions will take the same amount of time and effort for others to fix (if not more) as it would have taken the original contributor to make a complete submission in the first place. It will also often be faster and easier for the original contributor to update or cancel/redo their own submission than for somebody else to do it for them.
"Low effort" submissions should not be confused with small edits, which are of course welcome on StashDB. If you fear that your edit may appear incomplete to others and could be at risk of downvotes as a "low effort" submission, make sure you explain why your edit may look that way (performer not listed anywhere, couldn't find any details/photos for a performer, waiting for another edit to be approved before you can add something, etc.) Voters won't be inclined to downvote if you acknowledge and explain a sparse edit. Also, please see our related policy on [missing scene performers]({{ site.baseurl }}/docs/scenes/scene-performers/#missing-scene-performers).
### Backlog Spreadsheet
- **Anything that can't be fixed from within StashDB yet should be logged here, including incorrect fingerprints.**
Not everything can be fixed directly from StashDB's UI. For these exceptions, we have a spreadsheet hosted on Google Sheets to log corrections until they can be handled at a later date. There are several pages in the backlog, so make sure you find the correct one. Its most common use right now is to log incorrect fingerprints.
[Our backlog spreadsheet can be found here.](https://docs.google.com/spreadsheets/u/0/d/1eiOC-wbqbaK8Zp32hjF8YmaKql_aH-yeGLmvHP1oBKQ/edit)
### AdBlockers
- **Turn them off on StashDB, otherwise some images will appear "broken".**
Be sure to disable you browser's ad-blocker for StashDB's domain, or add the domain to the allow/white list. StashDB does not host ads of any kind, but some image URLs will get false-flagged as advertisements and will fail to load. These images will appear to be broken on the webpage.

99
docs/index.md Normal file
View File

@ -0,0 +1,99 @@
---
layout: default
title: Home
nav_order: 1
permalink: /
---
# StashDB Contribution Guidelines
{: .no_toc }
**Welcome to the new StashDB Guidelines Wiki!**
The Google Doc has been deprecated and will see no further updates. This Wiki should be considered your primary resource moving forward. It is very much a work in progress at this time so watch for significant updates in the coming days. Feel free to contact **@AdultSun** on Discord with any suggestions to improve this Wiki.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
## **Category Overviews**
Most of the guidelines will be organized under [Performers]({{ site.baseurl }}/docs/performers/), [Scenes]({{ site.baseurl }}/docs/scenes/), [Studios]({{ site.baseurl }}/docs/studios/), and [Tags]({{ site.baseurl }}/docs/tags/). These parent pages serve as overviews that summarize the entire category. More detailed sections can be found in additional pages underneath the category. All of these can also be found on the left side of this webpage.
- [Performers]({{ site.baseurl }}/docs/performers/)
- [Scenes]({{ site.baseurl }}/docs/scenes/)
- [Studios]({{ site.baseurl }}/docs/studios/)
- [Tags]({{ site.baseurl }}/docs/tags/)
***
## **Getting Started Pages**
The following **Getting Started** sections are general advice and explanations for potentially confusing aspects in our database. Because they don't represent explicit decisions concerning database management or curation, they do not require formal approval. **Getting Started** pages specific to [Performers]({{ site.baseurl }}/docs/performers/getting-started-performers/), [Scenes]({{ site.baseurl }}/docs/scenes/getting-started-scenes/), [Studios]({{ site.baseurl }}/docs/studios/getting-started-studios/), and [Tags]({{ site.baseurl }}/docs/tags/getting-started-tags/) can also be found under their respective categories in the navigation tree to the left.
- [Getting Started: Performers]({{ site.baseurl }}/docs/performers/getting-started-performers/)
- [Getting Started: Scenes]({{ site.baseurl }}/docs/scenes/getting-started-scenes/)
- [Getting Started: Studios]({{ site.baseurl }}/docs/studios/getting-started-studios/)
- [Getting Started: Tags]({{ site.baseurl }}/docs/tags/getting-started-tags/)
***
## **[Getting Started: StashDB]({{ site.baseurl }}/docs/getting-started-stashdb/)**
The sections below cover broader subjects that are not exclusive to one of those four categories. Clicking any of the headings here will also take you to a dedicated page with more details.
### [What is StashDB?]({{ site.baseurl }}/docs/getting-started-stashdb/#what-is-stashdb)
- **Our shared database of scene, performer, and studio metadata. Does not host video files or unofficial download links.**
### [What Makes StashDB Better?]({{ site.baseurl }}/docs/getting-started-stashdb/#what-makes-stashdb-better)
- **Full integration with Stash and improved scene matching using various fingerprints (PHashes).**
### [Joining Our Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord)
- **Necessary for accessing StashDB, click link for details.**
### [Accessing StashDB]({{ site.baseurl }}/docs/getting-started-stashdb/#accessing-stashdb)
- **Must create an account, details found on Discord.**
### [Using StashDB]({{ site.baseurl }}/docs/getting-started-stashdb/#using-stashdb)
- **Tagger Views are recommended for pulling info from StashDB, Identify task is faster but less accurate.**
### [What's a PHash?]({{ site.baseurl }}/docs/getting-started-stashdb/#whats-a-phash)
- **Perceptual hashes are generated from what a video looks like, allowing for more reliable scene matching with StashDB.**
### [What's a StashID?]({{ site.baseurl }}/docs/getting-started-stashdb/#whats-a-stashid)
- **Unique ID for entries in StashDB, found at the end of URLs and saved to Stash after a match.**
### [Contributing to StashDB]({{ site.baseurl }}/docs/getting-started-stashdb/#contributing-to-stashdb)
- **Submitting fingerprints is possible with every account, but any other edit/submission requires permissions granted through Discord.**
### [Bulk Edits]({{ site.baseurl }}/docs/getting-started-stashdb/#bulk-edits)
- **Big projects that require a large number of edits should be pitched on Discord first for approval.**
### [Voting on StashDB]({{ site.baseurl }}/docs/getting-started-stashdb/#voting-on-stashdb)
- **Different voting thresholds apply to destructive vs. non-destructive edits. Voting rights granted automatically after 10 approved submissions.**
### [Asking for Votes]({{ site.baseurl }}/docs/getting-started-stashdb/#asking-for-votes)
- **Asking on Discord is discouraged unless the edit needs to be approved before additional edits can be submitted.**
### [Unconfirmed Guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines)
- **Still expected to be followed but subject to change pending formal approval.**
### [Guideline Proposals]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals)
- **Changes to guidelines require formal approval, so ask about it on Discord first.**
### [Edit Comments]({{ site.baseurl }}/docs/getting-started-stashdb/#edit-comments)
- **Say what you're doing, why you're doing it, and what your sources are.**
### [Low Effort Submissions]({{ site.baseurl }}/docs/getting-started-stashdb/#low-effort-submissions)
- **Submissions may be rejected as "low effort" if it will take more time/effort to fix than it would've taken the OP to do correctly in the first place.**
### [Backlog Spreadsheet]({{ site.baseurl }}/docs/getting-started-stashdb/#backlog-spreadsheet)
- **Anything that can't be fixed from within StashDB yet should be logged here, including incorrect fingerprints.**
### [AdBlockers]({{ site.baseurl }}/docs/getting-started-stashdb/#adblockers)
- **Turn them off on StashDB, otherwise some images will appear "broken".**

111
docs/performers.md Normal file
View File

@ -0,0 +1,111 @@
---
layout: default
title: Performers
nav_order: 3
has_children: true
has_toc: false
---
<details markdown="block">
<summary>
Quick Links
</summary>
{: .text-delta }
1. [Getting Started: Performers](getting-started-performers)
2. [Creating Performers](creating-performers)
3. [Performer Images](performer-images)
4. [Performer Names and Aliases](performer-names-and-aliases)
</details>
# **Performers: Overview**
{: .no_toc }
This page is an [overview]({{ site.baseurl }}/#category-overviews) for performer profiles on StashDB **containing short summaries only**. More detailed information can be found with the "Quick Links" list above or the navigation tree on the left. Clicking the heading above each summary will also take you to the full version of the relevant section.
The [Getting Started: Performers](getting-started-performers) section covers all subjects relating to performers, but is limited to advice and explanations. Firm guidelines that you are expected to follow are found in the categories further below. These cover more specific situations within each subject than the [Getting Started sections]({{ site.baseurl }}/#getting-started-pages). Breaking them may risk rejected submissions. If you still have any questions, feel free to ask in **#stashdb-general** or **#ministry-of-truth** on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord).
***
<details open markdown="block">
<summary>
Summaries
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
## **[Getting Started: Performers](getting-started-performers)**
The following sections are general advice and explanations for potentially confusing aspects in our database for performers. Because they don't represent explicit decisions concerning database management or curation, they do not require [formal approval]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals).
### [Handling Ambiguous Performers](getting-started-performers#handling-ambiguous-performers)
- **Currently, only way is to reassign scenes to disambiguated performers individually.**
### [Performer Merge Targets](getting-started-performers#performer-merge-targets)
- **Typically, click "Merge" on the entry with the performer name you'd like to keep.**
### [Set Performance Aliases on Merge](getting-started-performers#set-performance-aliases-on-merge)
- **Usually leave box checked unless the merged name is identical to the merge target's name.**
### [Performer Image Sort Order](getting-started-performers#performer-image-sort-order)
- **Ranked by size (biggest to smallest), with any horizontal (landscape) images at the end.**
### [Performer Image Selection](getting-started-performers#performer-image-selection)
- **Variety is encouraged, allowing for different user preferences and easier identification from throughout a performer's career.**
### [Performer Edit Comments](getting-started-performers#performer-edit-comments)
- **Say what you're doing, why you're doing it, and what your sources are.**
### [Check Suspicious Names and Aliases](getting-started-performers#check-suspicious-names-and-aliases)
- **Exercise caution with odd looking aliases, particularly those listed on FreeOnes.**
***
## **[Creating Performers](creating-performers)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Performer Eligibility](creating-performers#performer-eligibility)
- **Must work with professional studios or have a verified account on at least one adult platform.**
***
## **[Performer Images](performer-images)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Performer Aspect Ratio](performer-images#performer-aspect-ratio)
- **2:3 ratio is preferred for vertical (portrait) images.**
### [Performer Image Size](performer-images#performer-image-size)
- **Images greater than 1280px will be automatically downscaled, "low quality" images may be rejected or removed.**
### [Performer Placeholder Images](performer-images#performer-placeholder-images)
- **Anonymous placeholder images should be rejected or removed.**
### [Performer Watermarks / Logos](performer-images#performer-watermarks--logos)
- **It is recommended to edit watermarks or logos out of performer images if possible, but not required.**
### [Multi-Performer Images](performer-images#multi-performer-images)
- **Images with multiple performers should be cropped if possible, rejected or removed if better images are available.**
### [Hardcore Performer Images](performer-images#hardcore-performer-images)
- **Images with explicit sex acts should be cropped if possible, rejected or removed if better images are available.**
### [BDSM Performer Images](performer-images#bdsm-performer-images)
- **Images showing extreme BDSM practices should be cropped if possible, rejected or removed if better images are available.**
***
## **[Performer Names and Aliases](performer-names-and-aliases)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Preferred Performer Names](performer-names-and-aliases#preferred-performer-names)
- **Prefer unique names over commonly used aliases, but otherwise no hard rules only suggestions.**
### [Eligible Performer Aliases](performer-names-and-aliases#eligible-performer-aliases)
- **Must have be used as an official adult credit, no legal names allowed except when a stage name is also their given name.**
### [Disambiguation Formatting](performer-names-and-aliases#disambiguation-formatting)
- **TBD.**

32
docs/performers/creating-performers.md Normal file
View File

@ -0,0 +1,32 @@
---
layout: default
title: Creating Performers
nav_order: 2
parent: Performers
---
# **Creating Performers**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Performer Eligibility
- **Must work with professional studios or have a verified account on at least one adult platform.**
Our main concern with performers is with legality. StashDB is not set up in any way to properly vet and verify performer ages by ourselves. We also can't verify whether performers are consenting to images/videos of themselves being shared. So, we have to rely on others to do this for us. This can be determined two different ways, detailed below. Any performers that do not meet one of these should be rejected or removed. But first, know that **any images or scenes that are known to feature underage performers will never be allowed on StashDB**. No exceptions.
First, a performer is eligible if they have ever performed for a professional studio that hasn't been [banned from StashDB for repeated violations of age or consent]({{ site.baseurl }}/docs/studios/adding-studios/#banned-studios). This means any performer from Brazzers, Adult Time, Vixen, Team Skeet, ExCoGi, NVG, etc. is allowed. This also includes classic performers, even if you're not aware of any scenes of theirs [currently eligible for inclusion on StashDB]({{ site.baseurl }}/docs/scenes/movies-dvds/#full-dvd-entries).
Amateur and semi-professional performers will need to include at least one verified profile from an adult platform. This includes Pornhub, ManyVids, and OnlyFans. Any other platforms that do not verify the ages and identities of their creators (TikTok, Reddit, Twitter, etc.) are not enough to make a performer eligible for StashDB. Please remember that even if a performer is allowed on StashDB, only scenes from [certain amateur platforms will be allowed]({{ site.baseurl }}/docs/studios/adding-studios/#amateur-studios). For example, performers who have only released content through OnlyFans will not have any scenes eligible for inclusion on StashDB.

60
docs/performers/getting-started-performers.md Normal file
View File

@ -0,0 +1,60 @@
---
layout: default
title: "Getting Started: Performers"
nav_order: 1
parent: Performers
---
# **Getting Started: Performers**
{: .no_toc }
The following sections are general advice and explanations for potentially confusing aspects in our database for performers. Because they don't represent explicit decisions concerning database management or curation, they do not require [formal approval]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals).
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Handling Ambiguous Performers
- **Currently, only way is to reassign scenes to disambiguated performers individually.**
Many performer entries are considered "ambiguous", with multiple performers sharing the same entry on StashDB. This happens most often with single names with no last name or initial, for example "Anna" or "Tony". Currently, the only way to handle these is to reassign the performer on every scene individually which can be tedious and time-consuming. This also often requires the creation of multiple performer entries that do not exist separately yet, which slows down the process even more. There are plans to split these problem entries into multiple performers by studio/network to speed up the process with simple merges. This method is not possible yet.
### Performer Merge Targets
- **Typically, click "Merge" on the entry with the performer name you'd like to keep.**
When merging, click the blue "Merge" button on the performer entry you would like to keep. This will be the "merge target." Best practice is to use the entry with the preferred primary name as your merge target when possible. In other words, please refrain from merging and renaming if one of the merged performer entries already has the preferred name. This may require merging an entry with more information into an entry with less, so be sure to include any potentially lost information in your merge submission.
### Set Performance Aliases on Merge
- **Usually leave box checked unless the merged name is identical to the merge target's name.**
When merging performers, there is a checkbox that says, "Set performance aliases to old name." The performance alias is used to show what name the studio used for that performer on that particular scene at the time of release. When this box is checked, all scenes without a performance alias will fill this field with the pre-merge performer name. Typically, the box should only be unchecked (it's enabled by default) when a merged name is exactly the same as the merge target's name. We don't want StashDB to say "Jane Doe (credited as Jane Doe)" for example. This will sometimes require separating merges into two submissions: one with the box checked and one with it unchecked.
### Performer Image Sort Order
- **Ranked by size (biggest to smallest), with any horizontal (landscape) images at the end.**
Images are currently ranked by size. This means the vertical image (portrait orientation) with the largest resolution is shown first, with the rest in descending order. Any horizontal images (landscape orientation) come last, also descending in size. Knowing this, it should be easier to find and recognize images that do not meet our minimum requirements.
### Performer Image Selection
- **Variety is encouraged, allowing for different user preferences and easier identification from throughout a performer's career.**
A variety of performer images is welcomed and encouraged. This includes different "looks" from throughout a performer's career as well as various crops and poses. Different hair styles and colors, different body types or ages, with clothes or without clothes, close-up headshots or full body portraits, facing towards the camera or facing away, etc. Images that include distinctive features like tattoos may help with easier identification as well. More options on StashDB means a greater likelihood that users can find an appropriate image for importing into Stash or for identifying performers. Just be sure that any images you add don't violate any of the [separate requirements listed here]({{ site.baseurl }}/docs/performers/performer-images/).
### Performer Edit Comments
- **Say what you're doing, why you're doing it, and what your sources are.**
Regardless of what kind of edit you're submitting, always include in the comment field what you are doing and why. Bigger or more drastic changes will likely require longer comments, but simple changes likely won't need much. Also please remember to note what you are using as the source of your edit when appropriate. These notes will be helpful when considering further edits in addition to justifying your actions now to those who will be voting on it.
### Check Suspicious Names and Aliases
- **Exercise caution with odd looking aliases, particularly those listed on FreeOnes.**
Not all names and aliases listed on external sources are appropriate on StashDB. Aliases must have been used as an official adult credit somewhere to be eligible as a name or alias on StashDB. This disallows legal names in almost all instances. Please see [the relevant section of these guidelines]({{ site.baseurl }}/docs/performers/performer-names-and-aliases/#eligible-performer-aliases) for more details on alias requirements.
FreeOnes often uses false primary names for obscure performers as well as suspected legal names as aliases. Because FreeOnes disallows single name performers, some contributors bypass the limitation by fabricating longer names for single name performers. These usually consist of two single name aliases merged into one. FreeOnes will often list suspected legal names of performers. They are not always accurate and they are not always used publicly by the performer. These names are usually very different from the performer's other listed aliases and from typical adult performer names in general, especially when they include middle names. Be skeptical of any FreeOnes name that isn't listed anywhere else, especially if it's a combination of other aliases or if it doesn't seem like a typical adult stage name.

66
docs/performers/performer-images.md Normal file
View File

@ -0,0 +1,66 @@
---
layout: default
title: Performer Images
nav_order: 3
parent: Performers
---
# **Performer Images**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Performer Aspect Ratio
- **2:3 ratio is preferred for vertical (portrait) images.**
Our preferred aspect ratio for vertical images (portrait orientation) is 2:3. For example, a resolution of 800x1200 has a 2:3 ratio. Some images may need to be cropped with a user's choice of image editing software to achieve this ratio. There is no hard requirement for enforcing this ratio at this time.
_Unconfirmed guideline, subject to change pending formal approval._
### Performer Image Size
- **Images greater than 1280px will be automatically downscaled, "low quality" images may be rejected or removed.**
The maximum size for images in the Stash-Box software is 1280 pixels. Anything larger than that in either dimension will be downscaled automatically to that size. Images may be removed as "low quality" if they are considered too small or blurry if better alternative images are available for the performer. However, no specific minimum resolution has been agreed upon at this time.
_Unconfirmed guideline, subject to change pending formal approval._
### Performer Placeholder Images
- **Anonymous placeholder images should be rejected or removed.**
Studios will often use anonymous placeholder images when they don't have anything else for a performer. These placeholder images should not be added to StashDB and any existing placeholders should be removed, even if they are the only images available for a performer. When imported into Stash, they can trick filters into thinking a performer has an image attached even though that image is functionally useless.
### Performer Watermarks / Logos
- **It is recommended to edit watermarks or logos out of performer images if possible, but not required.**
There is no hard rule regarding watermarks and logos in performer images, but it is still recommended to avoid them if possible. Sometimes, these images can be cropped to remove unwanted watermarks or logos with your choice of image editing software. Some programs will allow you to "heal" the logo to remove it without cropping. If the logo is unobtrusive, "healing" it would create an odd smear, or removing it entirely would result in an awkward crop, then it may be better to leave it as-is.
### Multi-Performer Images
- **Images with multiple performers should be cropped if possible, rejected or removed if better images are available.**
Images that contain multiple people should be removed as "low quality" if better alternative images are available for the performer. Sometimes, these images can be cropped to remove unwanted subjects with your choice of image editing software.
_Unconfirmed guideline, subject to change pending formal approval._
### Hardcore Performer Images
- **Images with explicit sex acts should be cropped if possible, rejected or removed if better images are available.**
Images that contain explicit sex acts should be removed as "low quality" if better alternative images are available for the performer. Sometimes, these images can be cropped to remove hardcore content with your choice of image editing software.
_Unconfirmed guideline, subject to change pending formal approval._
### BDSM Performer Images
- **Images showing extreme BDSM practices should be cropped if possible, rejected or removed if better images are available.**
Images that contain explicit or extreme BDSM practices should be removed as "low quality" if better alternative images are available for the performer. Images could qualify for removal if they show severe contortions or possible injury to the body. Sometimes, these images can be cropped to remove explicit content with your choice of image editing software.

48
docs/performers/performer-names-and-aliases.md Normal file
View File

@ -0,0 +1,48 @@
---
layout: default
title: Performer Names and Aliases
nav_order: 4
parent: Performers
---
# **Performer Names and Aliases**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Preferred Performer Names
- **Prefer unique names over commonly used aliases, but otherwise no hard rules only suggestions.**
There are no hard guidelines for choosing primary performer names at this time. However, more unique aliases are almost always preferred over common single word names like "Lola" or "Tony". The following should also be taken into consideration: most frequently used alias, most famous/popular alias, most commonly used name on other databases like IAFD, and alias currently/recently preferred by the performer (often determined by social media profiles).
Also be aware that names are only eligible to be primary names if they've been used as an official adult credit, following the same requirements as [eligible performer aliases](#eligible-performer-aliases).
_Unconfirmed guideline, subject to change pending formal approval._
### Eligible Performer Aliases
- **Must have be used as an official adult credit, no legal names allowed except when a stage name is also their given name.**
Performer aliases must be names that have been used as official credits in an adult video performance. They do not have to be names used as performance aliases in a scene already listed on StashDB. This means that names that have been used professionally in non-adult mainstream performances, listed in credits or bylines as a writer or author, used on public social media accounts, or listed in news articles are not eligible to be listed on StashDB unless they've also been used as an official adult credit.
This also means that outside of the rare occasion of someone regularly using their given name instead of a stage name, **legal names are not allowed anywhere on StashDB**.
_Unconfirmed guideline, subject to change pending formal approval._
### Disambiguation Formatting
- **TBD.**
Placeholder description, ask on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord).
_Unconfirmed guideline, subject to change pending formal approval._

122
docs/scenes.md Normal file
View File

@ -0,0 +1,122 @@
---
layout: default
title: Scenes
nav_order: 4
has_children: true
has_toc: false
---
<details markdown="block">
<summary>
Quick Links
</summary>
{: .text-delta }
1. [Getting Started: Scenes](getting-started-scenes)
2. [Adding Scenes](adding-scenes)
3. [Scene Performers](scene-performers)
4. [Scene Dates](scene-dates)
5. [Scene Titles](scene-dates)
6. [Scene Descriptions](scene-dates)
7. [Movies / DVDs](movies-dvds)
</details>
# **Scenes: Overview**
{: .no_toc }
This page is an [overview]({{ site.baseurl }}/#category-overviews) for scene entries on StashDB **containing short summaries only**. More detailed information can be found with the "Quick Links" list above or the navigation tree on the left. Clicking the heading above each summary will also take you to the full version of the relevant section.
The [Getting Started: Scenes](getting-started-scenes) section covers all subjects relating to scenes, but is limited to advice and explanations. Firm guidelines that you are expected to follow are found in the categories further below. These cover more specific situations within each subject than the [Getting Started sections]({{ site.baseurl }}/#getting-started-pages). Breaking them may risk rejected submissions. If you still have any questions, feel free to ask in **#stashdb-general** or **#ministry-of-truth** on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord).
***
<details open markdown="block">
<summary>
Summaries
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
## **[Getting Started: Scenes](getting-started-scenes)**
The following sections are general advice and explanations for potentially confusing aspects in our database for performers. Because they don't represent explicit decisions concerning database management or curation, they do not require [formal approval]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals).
### [Check Duplicate Scenes](getting-started-scenes#check-duplicate-scenes)
- **Search using keywords, filters, and PHashes.**
### [Check Scene Performers](getting-started-scenes#check-scene-performers)
- **Find missing performers and avoid ambiguous entries.**
### [Scene Edit Comments](getting-started-scenes#scene-edit-comments)
- **Say what you're doing, why you're doing it, and what your sources are.**
***
## **[Adding Scenes](adding-scenes)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Duplicate Scenes](adding-scenes#duplicate-scenes)
- **No exact duplicates, prefer to keep entries with more fingerprints.**
### [Remasters, Redistributions, and Re-Releases](adding-scenes#remasters-redistributions-and-re-releases)
- **Distinct remasters/redistributions/re-releases are allowed for studio releases, but cross-posted amateur releases only need one entry.**
### [PornHub Scenes](adding-scenes#pornhub-scenes)
- **Must be original scenes made and uploaded by verified creators.**
***
## **[Scene Performers](scene-performers)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Missing Scene Performers](scene-performers#missing-scene-performers)
- **Must include performers listed anywhere on linked webpages, including descriptions.**
### [Ambiguous Scene Performers](scene-performers#ambiguous-scene-performers)
- **Must avoid ambiguous performer entries, creating new disambiguated entries when necessary.**
### [Preferred Scene Aliases](scene-performers#preferred-scene-aliases)
- **Should be the name officially credited to the performer at the time of release.**
***
## **[Scene Dates](scene-dates)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Preferred Scene Dates](scene-dates#preferred-scene-dates)
- **Earliest known release date, or closest approximate date.**
***
## **[Scene Titles](scene-titles)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Preferred Scene Titles](scene-titles#preferred-scene-titles)
- **Original official scene titles are preferred.**
### [Preferred Title Language](scene-titles#preferred-title-language)
- **English titles are preferred when provided by official website.**
***
## **[Scene Descriptions](scene-descriptions)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Preferred Scene Descriptions](scene-descriptions#preferred-scene-descriptions)
- **Original official descriptions are preferred.**
### [Correcting Scene Descriptions](scene-descriptions#correcting-scene-descriptions)
- **Descriptions should be unaltered from the original studio source in spelling, grammar, and punctuation.**
### [Preferred Description Language](scene-descriptions#preferred-description-language)
- **English description are preferred when provided by official website.**
***
## **[Movies / DVDs](movies-dvds)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Full DVD Entries](#full-dvd-entries)
- **Full movies only allowed for JAV releases or western releases available directly from official studio websites.**

44
docs/scenes/adding-scenes.md Normal file
View File

@ -0,0 +1,44 @@
---
layout: default
title: "Adding Scenes"
nav_order: 2
parent: Scenes
---
# **Adding Scenes**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Duplicate Scenes
- **No exact duplicates, prefer to keep entries with more fingerprints.**
Exact duplicates should always be rejected or removed. Exceptions may be made for [remasters, rereleases, and redistributions](#remasters-redistributions-and-re-releases) in some cases. When deleting duplicate scenes, our preference is to keep the entry with the higher number of unique fingerprints and/or fingerprint submissions.
_Unconfirmed guideline, subject to change pending formal approval._
### Remasters, Redistributions, and Re-Releases
- **Distinct remasters/redistributions/re-releases are allowed with unique studio links, but cross-posted amateur releases only need one entry.**
Remasters (higher quality release of an old scene by the same network/studio), redistributions (cross-network releases), and re-releases (same network releases again) are allowed when they have a unique scene entry and URL on a studio website. The [preferred scene date]({{ site.baseurl }}/docs/scenes/scene-dates/#preferred-scene-dates) is the release date of that particular release, not the original's release date. Production dates should not be used for this field either. If a studio changes the release date displayed on their website to make an old scene appear newer, this is not considered a re-release requiring a separate scene entry. All relevant fields including title, description, thumbnail, and scene alias should be sourced from that particular release and not from other releases. Also, please attach a [Remastered](https://stashdb.org/tags/faf494d6-9092-4dd5-86d7-0978c596b547) or [Redistributions](https://stashdb.org/tags/1a3906db-b644-41e3-9fe3-d0a26abb0930) tag when appropriate.
Note that the above only applies to a "studio website." Self-produced content is often released on multiple [amateur platforms]({{ site.baseurl }}/docs/studios/adding-studios/#amateur-studios) but each release does not require a separate entry on StashDB. Amateur scenes are organized by creator not by platform and scenes are the same way. Use the oldest known release date and whatever the "best" source appears to be for other fields like title, description, thumbnail, etc. There is no specific guidance on what is considered the "best" at this time, so just rely on your own judgment.
### PornHub Scenes
- **Must be original scenes made and uploaded by verified creators.**
Scenes from PornHub must be original content uploaded by verified creators. Scenes uploaded by a third party are not allowed. Trailers and abridged scenes from major studios are not allowed. Fan-created content like compilations or PMVs are not allowed. Adding scenes with simply "PornHub" as the studio is not allowed. Scenes must use a [sub-studio for the content creator]({{ site.baseurl }}/docs/studios/adding-studios/#amateur-studios) instead.
_Unconfirmed guideline, subject to change pending formal approval._

38
docs/scenes/getting-started-scenes.md Normal file
View File

@ -0,0 +1,38 @@
---
layout: default
title: "Getting Started: Scenes"
nav_order: 1
parent: Scenes
---
# **Getting Started: Scenes**
{: .no_toc }
The following sections are general advice and explanations for potentially confusing aspects in our database for scenes. Because they don't represent explicit decisions concerning database management or curation, they do not require [formal approval]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals).
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Check Duplicate Scenes
- **Search using keywords, filters, and PHashes.**
Before submitting a scene to StashDB, always check for duplicates first. Duplicates will [likely be rejected or removed]({{ site.baseurl }}/docs/scenes/adding-scenes/#duplicate-scenes). If you couldn't find a match through Stash's [Scene Tagger]({{ site.baseurl }}/docs/getting-started-stashdb/#using-stashdb), the easiest way to check is to rely on [PHash]({{ site.baseurl }}/docs/getting-started-stashdb/#whats-a-phash) detection when [submitting a draft]({{ site.baseurl }}/docs/getting-started-stashdb/#using-stashdb) to StashDB. Your draft edit will have a warning sign (⚠) at the top if your PHash matches existing scenes in the database. These are not always duplicate scenes and may be due to someone [submitting incorrect fingerprints]({{ site.baseurl }}/docs/getting-started-stashdb/#backlog-spreadsheet). Duplicates may also be found by searching for the title on StashDB or by filtering by studio on a performer's page. Also be aware that even if your scene isn't on StashDB yet, someone could have a pending edit to create the same scene. Best way to check for this is to click the favorite star (⭐) on the relevant studio or performer in your submission and [filter for favorites in pending scene creations](https://stashdb.org/edits?favorite=true&operation=create&status=pending&type=scene) on the Edits page.
### Check Scene Performers
- **Find missing performers and avoid ambiguous entries.**
When submitting a new scene, make sure that you are not [missing any performers]({{ site.baseurl }}/docs/scenes/scene-performers/#missing-scene-performers). If they are listed on the studio page, in the title, or in the description, you will be expected to include them in your submission. Also make sure that none of your included performers link to [ambiguous performer entries]({{ site.baseurl }}/docs/performers/getting-started-performers/#handling-ambiguous-performers). These are most often single-name performers with nothing in their disambiguation field. Both of these may put your scene creation at risk of being rejected.
### Scene Edit Comments
- **Say what you're doing, why you're doing it, and what your sources are.**
Regardless of what kind of edit you're submitting, always include in the comment field what you are doing and why. Bigger or more drastic changes will likely require longer comments, but simple changes likely won't need much. Also please remember to note what you are using as the source of your edit when appropriate. These notes will be helpful when considering further edits in addition to justifying your actions now to those who will be voting on it.

30
docs/scenes/movies-dvds.md Normal file
View File

@ -0,0 +1,30 @@
---
layout: default
title: "Movies / DVDs"
nav_order: 7
parent: Scenes
---
# **Movies / DVDs**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Full DVD Entries
- **Full movies only allowed for JAV releases or western releases available directly from official studio websites.**
Scene entries that represent full movies are only accepted in limited circumstances. Full movies that only have retailers (Adult DVD Empire, Hot Movies, etc.) or databases (IAFD, Data18, etc.) as their source will not be accepted. JAV movies have been granted an exception for now since they come almost exclusively as full movie downloads instead of split scenes. Exceptions may be granted for full movies that have an official studio website as its source that provides downloads of the full movie as a single file, but this is not guaranteed. We still ask that you hold off until further software developments can be made to better support movies in StashDB.
_Unconfirmed guideline, subject to change pending formal approval._

30
docs/scenes/scene-dates.md Normal file
View File

@ -0,0 +1,30 @@
---
layout: default
title: "Scene Dates"
nav_order: 4
parent: Scenes
---
# **Scene Dates**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Preferred Scene Dates
- **Earliest known release date, or closest approximate date.**
The earliest known release date for a scene is always the preferred scene date. Production dates should not be used for this field. For [remasters/redistributions/re-releases]({{ site.baseurl }}/docs/scenes/adding-scenes/#remasters-redistributions-and-re-releases), the earliest release date refers to that particular release and not the original scene. Approximate dates may be accepted if no exact release date can be sourced or verified. Stash-Box will allow you to omit the day or month in these situations.
_Unconfirmed guideline, subject to change pending formal approval._

42
docs/scenes/scene-descriptions.md Normal file
View File

@ -0,0 +1,42 @@
---
layout: default
title: "Scene Descriptions"
nav_order: 6
parent: Scenes
---
# **Scene Descriptions**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Preferred Scene Descriptions
- **Original official descriptions are preferred.**
Original descriptions provided by the official studio website are always the preferred scene description. Descriptions that have been modified by the studio after its original release should not be used in the details field on StashDB. If the studio does not have a unique description for the scene, the details field should be left blank. Auto-generated placeholder descriptions provided by the studio (sometimes referred to as "boilerplate" descriptions) are not considered unique and should not be included. Descriptions provided by a source other than the official studio should also not be included.
_Unconfirmed guideline, subject to change pending formal approval._
### Correcting Scene Descriptions
- **Descriptions should be unaltered from the original studio source in spelling, capitalization, grammar, and punctuation.**
Even when the studio description has obvious grammatical or typographical errors, it should be preserved as it originally appeared. This includes misspellings, incorrect punctuation, odd capitalization, etc. However, exceptions can be made for obvious technical errors introduced by a bad scrape or website update. This includes encoding errors on special characters, obvious glitches with whitespace, visible HTML tags instead of line breaks, etc.
_Unconfirmed guideline, subject to change pending formal approval._
### Preferred Description Language
- **English description are preferred when provided by official website.**
Some studios offer multiple language options on their official website. In these situations, the English versions of scene titles and descriptions are preferred for StashDB. If there is no official English translation available, the next best option is the original language.

42
docs/scenes/scene-performers.md Normal file
View File

@ -0,0 +1,42 @@
---
layout: default
title: "Scene Performers"
nav_order: 3
parent: Scenes
---
# **Scene Performers**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Missing Scene Performers
- **Must include performers listed anywhere on linked webpages, including descriptions.**
All active performers listed in the details, title, URL, or a linked webpage should be included when adding or editing a scene. This includes male performers in straight scenes. Please note in your edit comment why any performers are not included in your submission. Finding names for missing performers on recommended databases (IAFD, Data18, etc.) is greatly encouraged, but often not required.
_Unconfirmed guideline, subject to change pending formal approval._
### Ambiguous Scene Performers
- **Must avoid ambiguous performer entries, creating new disambiguated entries when necessary.**
[Ambiguous performers]({{ site.baseurl }}/docs/performers/getting-started-performers/#handling-ambiguous-performers) should not be added to a scene entry. You should always try to find a properly disambiguated performer entry for your scene. If no entry exists yet for your performer, you will need to create one.
_Unconfirmed guideline, subject to change pending formal approval._
### Preferred Scene Aliases
- **Should be the name officially credited to the performer at the time of release.**
The scene alias can be entered into the field immediately to the right of the performer in the scene edit form. This should be used for whatever name was used as the performer's official credit at the time of release from the original source. It should not be used for character names unless it also serves as the performer's official credit. To be clear, contributors aren't expected to consult the Wayback Machine to verify every single scene alias in their submissions. Whatever the studio link currently lists is usually a reliable default, but editors should try to use the correct name for this field when there's a discrepancy in the description, on the scene cover, in IAFD credits, etc.

35
docs/scenes/scene-titles.md Normal file
View File

@ -0,0 +1,35 @@
---
layout: default
title: "Scene Titles"
nav_order: 5
parent: Scenes
---
# **Scene Titles**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Preferred Scene Titles
- **Original official scene titles are preferred.**
Original scene titles provided by the official studio website are always the preferred scene title. Scene titles that have been modified by the studio after its original release should not be used as the scene title on StashDB.
_Unconfirmed guideline, subject to change pending formal approval._
### Preferred Title Language
- **English titles are preferred when provided by official website.**
Some studios offer multiple language options on their official website. In these situations, the English versions of scene titles and descriptions are preferred for StashDB. If there is no official English translation available, the next best option is the original language.

74
docs/studios.md Normal file
View File

@ -0,0 +1,74 @@
---
layout: default
title: Studios
nav_order: 5
has_children: true
has_toc: false
---
<details markdown="block">
<summary>
Quick Links
</summary>
{: .text-delta }
1. [Getting Started: Studios](getting-started-studios)
2. [Adding Studios](adding-studios)
3. [Studio Images](studio-images)
</details>
# **Studios: Overview**
{: .no_toc }
This page is an [overview]({{ site.baseurl }}/#category-overviews) for studio entries on StashDB **containing short summaries only**. More detailed information can be found with the "Quick Links" list above or the navigation tree on the left. Clicking the heading above each summary will also take you to the full version of the relevant section.
The [Getting Started: Studios](getting-started-studios) section covers all subjects relating to scenes, but is limited to advice and explanations. Firm guidelines that you are expected to follow are found in the categories further below. These cover more specific situations within each subject than the [Getting Started sections]({{ site.baseurl }}/#getting-started-pages). Breaking them may risk rejected submissions. If you still have any questions, feel free to ask in **#stashdb-general** or **#ministry-of-truth** on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord).
***
<details open markdown="block">
<summary>
Summaries
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
## **[Getting Started: Studios](getting-started-studios)**
The following sections are general advice and explanations for potentially confusing aspects in our database for studios. Because they don't represent explicit decisions concerning database management or curation, they do not require [formal approval]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals).
### [Check Duplicate Studios](getting-started-studios#check-duplicate-studios)
- **Search using keywords on "Studios" page.**
### [Studio Edit Comments](getting-started-studios#studio-edit-comments)
- **Say what you're doing, why you're doing it, and what your sources are.**
### [Check Image Size](getting-started-studios#check-image-size)
- **Large images (greater than 1280px in either dimension) are automatically downscaled, which may remove transparency from PNGs.**
***
## **[Adding Studios](adding-studios)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Banned Studios](adding-studios#banned-studios)
- **No studios that repeatedly violate the consent of performers, including "Girls Do Porn" and its spin-off "Girls Do Toys".**
### [Amateur Studios](adding-studios#amateur-studios)
- **Only a limited selection of platforms allowed, with creators used as studios.**
### [Animated Studios](adding-studios#animated-studios)
- **Only allowed from "professional" studios, not independent content creators.**
### [Classic Studios](adding-studios#classic-studios)
- **Currently, only scenes available digitally from an official studio website or network are allowed, not including digital marketplaces.**
***
## **[Studio Images](studio-images)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Seasonal Logos](studio-images#seasonal-logos)
- **Temporary seasonal logos should not be used when a more permanent variation is available.**

55
docs/studios/adding-studios.md Normal file
View File

@ -0,0 +1,55 @@
---
layout: default
title: "Adding Studios"
nav_order: 2
parent: Studios
---
# **Adding Studios**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Banned Studios
- **No studios that repeatedly violate the consent of performers, including "Girls Do Porn" and its spin-off "Girls Do Toys".**
Currently, the only studios explicitly banned from StashDB for content alone are Girls Do Porn and their spin-off Girls Do Toys. This is due to the [repeated violations of their performers' consent and the resulting legal ramifications](https://www.xbiz.com/news/247515/heres-what-you-need-to-know-about-the-girlsdoporn-case).
While not listed individually here, other scenes and studios that are known to violate the consent of their performers are not allowed anywhere on StashDB and will be rejected or removed. Any scenes or images that are known to include underage performers will also be rejected or removed.
### Amateur Studios
- **Only a limited selection of platforms allowed, with creators used as studios.**
Amateur content is currently allowed on StashDB only in limited circumstances. Content is only allowed from a few platforms (ManyVids, Clips4Sale, PornHub, MFC Share, etc.) and creators who are considered "pro-am" are preferred. Paywalled subscription services like OnlyFans, Just for Fans, and Patreon are not allowed at this time. Content from other platforms may be allowed in the future, but likely also in limited circumstances.
Each creator should be their own studio on StashDB. For example, "Jane Doe" or "Example Productions" would be appropriate names for a studio. This studio will hold scenes produced by the creator across multiple platforms and each scene may contain links to the same video from multiple distributors. Scenes should not be added with just the platform as the studio, for example "PornHub" or "ManyVids" without a creator sub-studio. If the studio does not exist on StashDB yet, it will need to be created. Also note: Studios named after a performer are only used for scenes *released by* that performer. For example: if Jane Doe films a scene for Brazzers Exxtra, that scene will still use "Brazzers Exxtra" as the studio and not "Jane Doe".
For creators that are exclusively on a single platform, the platform may be used as a parent/network studio. For example, if Jane Doe only produces scenes for PornHub then the studio "Jane Doe" can be a sub-studio of "PornHub". If "Jane Doe" scenes are no longer exclusively on PornHub, then PornHub can easily be removed as the parent/network and the studio can be expanded to include other forms of distribution.
Creators must be verified by PornHub for their channel on that platform to be allowed on StashDB. Please see this section dedicated to [adding PornHub scenes]({{ site.baseurl }}/docs/scenes/adding-scenes/#pornhub-scenes).
### Animated Studios
- **Only allowed from "professional" studios, not independent content creators.**
Animated content is currently allowed on StashDB only in limited circumstances. Animated scenes are only allowed from what can be considered "professional" studios and not independent content creators. This means they will need a stand-alone website or belong to a larger network. Creators selling animated content through an online marketplace or a subscription service like Patreon are not allowed at this time. The reasoning for this is due to a desire to move slowly with this content, so it may change in the future. A small number of scenes and studios were added prior to this policy's implementation and do not need to be removed at this time, but new scenes and studios will likely be rejected.
_Unconfirmed guideline, subject to change pending formal approval._
### Classic Studios
- **Currently, only scenes available digitally from an official studio website or network are allowed, not including digital marketplaces.**
Older studios are currently allowed on StashDB only in limited circumstances. Studios and scenes that pre-date digital distribution where content is only available as rips of home video releases or third party resellers are not allowed on StashDB at this time. This includes content that can only be sourced from marketplaces that sell digital scenes and movies like Adult DVD Empire or Hot Movies. At this time, all professional scenes and studios must be available digitally from an official studio website or network. The reasoning for this is due to a desire to move slowly with this content, so it may change in the future. Please also see our policy on [full movie scene entries]({{ site.baseurl }}/docs/scenes/movies-dvds/#full-dvd-entries).
_Unconfirmed guideline, subject to change pending formal approval._

38
docs/studios/getting-started-studios.md Normal file
View File

@ -0,0 +1,38 @@
---
layout: default
title: "Getting Started: Studios"
nav_order: 1
parent: Studios
---
# **Getting Started: Studios**
{: .no_toc }
The following sections are general advice and explanations for potentially confusing aspects in our database for studios. Because they don't represent explicit decisions concerning database management or curation, they do not require [formal approval]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals).
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Check Duplicate Studios
- **Search using keywords on "Studios" page.**
Before adding a new studio, make sure it doesn't already exist by searching [StashDB's list of studios](https://stashdb.org/studios). Additional search terms will expand the list of results on that page right now, so try to limit yourself to the most unique search term in your studio's name. Also, be aware of our other policies for [adding studios]({{ site.baseurl }}/docs/studios/adding-studios/) that may be relevant.
### Studio Edit Comments
- **Say what you're doing, why you're doing it, and what your sources are.**
Regardless of what kind of edit you're submitting, always include in the comment field what you are doing and why. Bigger or more drastic changes will likely require longer comments, but simple changes likely won't need much. Also please remember to note what you are using as the source of your edit when appropriate. These notes will be helpful when considering further edits in addition to justifying your actions now to those who will be voting on it.
### Check Image Size
- **Large images (greater than 1280px in either dimension) are automatically downscaled, which may remove transparency from PNGs.**
Images uploaded to StashDB will be downscaled to no greater than 1280 pixels in either dimension. Due to an old bug, PNGs may be converted to JPGs when downscaling. This means that studio images might lose any transparency they may have if it's over 1280 pixels tall or wide. Until this is fixed, you may need to manually downscale transparent images to fit these size requirements before uploading them to StashDB.

28
docs/studios/studio-images.md Normal file
View File

@ -0,0 +1,28 @@
---
layout: default
title: "Studio Images"
nav_order: 3
parent: Studios
---
# **Studio Images**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Seasonal Logos
- **Temporary seasonal logos should not be used when a more permanent variation is available.**
Occasionally, studio websites will temporarily change their logo for a particular event or cause. Examples include Halloween, Pride Month, some kind of awareness/fundraising campaign, etc. These temporary logos should not be used as the primary logo on StashDB when a more recent and permanent variation is available. If a non-seasonal image cannot be found on the current studio website, the Wayback Machine and any other external sources should be checked first before using the seasonal variation as a placeholder.

113
docs/tags.md Normal file
View File

@ -0,0 +1,113 @@
---
layout: default
title: Tags
nav_order: 6
has_children: true
has_toc: false
---
<details markdown="block">
<summary>
Quick Links
</summary>
{: .text-delta }
1. [Getting Started: Tags](getting-started-tags)
2. [Assigning Tags](assigning-tags)
3. [Creating Tags](creating-tags)
4. [Editing Tags](editing-tags)
5. [Merging Tags](merging-tags)
</details>
# **Tags: Overview**
{: .no_toc }
This page is an [overview]({{ site.baseurl }}/#category-overviews) for tags on StashDB **containing short summaries only**. More detailed information can be found with the "Quick Links" list above or the navigation tree on the left. Clicking the heading above each summary will also take you to the full version of the relevant section.
The [Getting Started: Tags](getting-started-tags) section covers all subjects relating to scenes, but is limited to advice and explanations. Firm guidelines that you are expected to follow are found in the categories further below. These cover more specific situations within each subject than the [Getting Started sections]({{ site.baseurl }}/#getting-started-pages). Breaking them may risk rejected submissions. If you still have any questions, feel free to ask in **#stashdb-general** or **#ministry-of-truth** on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord).
***
<details open markdown="block">
<summary>
Summaries
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
## **[Getting Started: Tags](getting-started-tags)**
The following sections are general advice and explanations for potentially confusing aspects in our database for tags. Because they don't represent explicit decisions concerning database management or curation, they do not require [formal approval]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals).
### [Picking Tags for a Scene](getting-started-tags#picking-tags-for-a-scene)
- **Start small with "important" tags first, expand as you get more familiar with StashDB's list.**
### [Tag Edit Comments](getting-started-tags#tag-edit-comments)
- **Say what you're doing, why you're doing it, and what your sources are.**
### [Read Tag Edit Histories](getting-started-tags#read-tag-edit-histories)
- **Comments in the "Edits" tab will often explain why a tag is organized a certain way, so check it first before making an edit.**
### [Check Tag Usage](getting-started-tags#check-tag-usage)
- **Look at the scenes underneath a tag to get an idea of its current usage before submitting a destructive edit or description change.**
### [Scraped vs. Manual Tags](getting-started-tags#scraped-vs-manual-tags)
- **Most tags attached to scenes were scraped from studio sources, not manually added by editors.**
### [Sorted vs. Unsorted Tags](getting-started-tags#sorted-vs-unsorted-tags)
- **Tags without categories and/or descriptions are considered "unsorted" and should generally be avoided when manually adding tags to scenes.**
### [Merging and Destroying Tags](getting-started-tags#merging-and-destroying-tags)
- **Unsorted tags that do not have a unique and helpful meaning are candidates for merging/deleting.**
### [Tag Merge Targets](getting-started-tags#tag-merge-targets)
- **Click "Merge" on the page of the tag you want to keep, then select any tags that should be removed and merged.**
### [Destroying Tags](getting-started-tags#destroying-tags)
- **Rarely appropriate, usually there's a potential merge that would be preferred.**
### [Adding Tag Aliases](getting-started-tags#adding-tag-aliases)
- **Make sure there aren't any other tags that would be a better fit for an alias, or that another tag isn't using it already.**
### [Changing a Tag's Primary Name](getting-started-tags#changing-a-tags-primary-name)
- **Prioritize brevity, clarity, familiarity, and consistency.**
### [Assigning Tag Categories](getting-started-tags#assigning-tag-categories)
- **If the tag you're editing doesn't have a category yet, add one yourself even if you have to guess to mark it as "sorted".**
***
## **[Assigning Tags](assigning-tags)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Priority Sources for Tags](assigning-tags#priority-sources-for-tags)
- **From highest to lowest: original video, official tube-site edits, trailers, screenshots, scraped tags, galleries, thumbnails, official descriptions, unofficial descriptions.**
***
## **[Creating Tags](creating-tags)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [New Tag Requirements](creating-tags#new-tag-requirements)
- **Must have a clear, helpful, and distinctive usage. Tags that can be scraped from somewhere are considered more helpful.**
### [Check for Duplicate Tags](creating-tags#check-for-duplicate-tags)
- **Search StashDB for similar terms, check tag descriptions and aliases to avoid overlap.**
***
## **[Editing Tags](editing-tags)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Style Guide](editing-tags#style-guide)
- **TBD.**
***
## **[Merging Tags](merging-tags)**
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
### [Merging Sorted Tags](merging-tags#merging-sorted-tags)
- **"Sorted" tags (already has category/description) shouldn't be considered eligible to be deleted or merged. Ask on Discord first if you think you've found an exception.**

30
docs/tags/assigning-tags.md Normal file
View File

@ -0,0 +1,30 @@
---
layout: default
title: "Assigning Tags"
nav_order: 2
parent: Tags
---
# **Assigning Tags**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Priority Sources for Tags
- **From highest to lowest: original video, official tube-site edits, trailers, screenshots, scraped tags, galleries, thumbnails, official descriptions, unofficial descriptions.**
The primary source for manually curating a scene’s tags is the video itself. Other sources may be used as well, but the video supersedes any other conflicting sources. Order of authority for sources can be considered (from highest to lowest): the original video, official tube-site edits, trailers, screenshots, scraped tags, galleries, thumbnails, official descriptions, unofficial descriptions. Just be sure to mention in your edit comment what your source is and try not to overrule a source with a higher level of authority than yours.
_Unconfirmed guideline, subject to change pending formal approval._

37
docs/tags/creating-tags.md Normal file
View File

@ -0,0 +1,37 @@
---
layout: default
title: "Creating Tags"
nav_order: 3
parent: Tags
---
# **Creating Tags**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### New Tag Requirements
- **Must have a clear, helpful, and distinctive usage. Tags that can be scraped from somewhere are considered more helpful.**
New tags must have a clear, helpful, and distinctive usage for them to be eligible for creation. In other words, if your proposed tag is considered too vague, too niche, or too similar to other tags, it will be rejected by the voters. This of course is very subjective, but nearly everything involving tags will be subjective. New tags will also be considered more helpful if they can be [scraped from a studio source]({{ site.baseurl }}/docs/tags/getting-started-tags/#scraped-vs-manual-tags) already covered on StashDB. So be sure to [check for duplicate tags first](#check-for-duplicate-tags) and make your case to the voters in your [edit comment]({{ site.baseurl }}/docs/tags/getting-started-tags/#tag-edit-comments). [Adding a category]({{ site.baseurl }}/docs/tags/getting-started-tags/#assigning-tag-categories) wouldn't hurt either.
_Unconfirmed guideline, subject to change pending formal approval._
### Check for Duplicate Tags
- **Search StashDB for similar terms, check tag descriptions and aliases to avoid overlap.**
Tags that are considered too similar to existing tags on StashDB will be rejected. Be sure to search [StashDB's tag list](https://stashdb.org/tags) for similar terms and check tag descriptions to see how they compare to the intended usage of your new tag. Some crossover between tags is allowed, but tags require helpful distinctions between them. Also make sure your new tag's primary name and any aliases you've attached to it are not already used by another tag as an alias. Conflicting aliases will cause your submission to fail, even if it is approved by the voters. StashDB's [tag search](https://stashdb.org/tags) considers aliases, so they shouldn't be too hard to spot.
_Unconfirmed guideline, subject to change pending formal approval._

30
docs/tags/editing-tags.md Normal file
View File

@ -0,0 +1,30 @@
---
layout: default
title: "Editing Tags"
nav_order: 4
parent: Tags
---
# **Editing Tags**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Style Guide
- **TBD.**
Placeholder description, ask on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord).
_Unconfirmed guideline, subject to change pending formal approval._

83
docs/tags/getting-started-tags.md Normal file
View File

@ -0,0 +1,83 @@
---
layout: default
title: "Getting Started: Tags"
nav_order: 1
parent: Tags
---
# **Getting Started: Tags**
{: .no_toc }
The following sections are general advice and explanations for potentially confusing aspects in our database for tags. Because they don't represent explicit decisions concerning database management or curation, they do not require [formal approval]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals).
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Picking Tags for a Scene
- **Start small with "important" tags first, expand as you get more familiar with StashDB's list.**
The list of tags on StashDB is long. You don't have to be aware of all of them. You don't have to add every tag that possibly fits. Think of tags as an additional way to describe a scene and focus on adding tags you think are important to describing the scene in front of you. That may require relatively few tags or it could require a lot. You may as well start small and slowly expand from there as you become more familiar with the tags available on StashDB. If you have any questions about how to use a particular tag, first read its description carefully. [Previous edit comments](#tag-edit-comments) may give you more information as well. Otherwise, feel free to ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord). Also, please explain in your own edit comment [where your tags are coming from]({{ site.baseurl }}/docs/tags/assigning-tags/#priority-sources-for-tags), if they're simply scraped or if you've added/removed some yourself.
### Tag Edit Comments
- **Say what you're doing, why you're doing it, and what your sources are.**
Regardless of what kind of edit you're submitting, always include in the comment field what you are doing and why. Bigger or more drastic changes will likely require longer comments, but simple changes likely won't need much. Also please remember to note what you are using as the [source of your edit]({{ site.baseurl }}/docs/tags/assigning-tags/#priority-sources-for-tags) when appropriate. These notes will be helpful when considering further edits on the tag later in addition to justifying your actions now to those who will be voting on it.
### Read Tag Edit Histories
- **Comments in the "Edits" tab will often explain why a tag is organized a certain way, so check it first before making an edit.**
If you're wondering why a tag is named/defined/organized a certain way, often the answer is in its edit history. In a tag's detail page, click on the "Edits" tab underneath its list of aliases. The comments on these edit submissions often explain the reasoning behind them, sometimes at great length. If you feel like a tag needs to be changed or merged in some way, please look through these edit comments first. They may show you that an idea has already been considered and explain why it hasn't been implemented.
### Check Tag Usage
- **Look at the scenes underneath a tag to get an idea of its current usage before submitting a destructive edit or description change.**
Before submitting an edit to a tag, always look through the scenes underneath it first. Most tags are defined to [match their current usage](#scraped-vs-manual-tags), so you will need to have a good idea of how it's currently used before you can make an informed decision about how it should be handled. If you're trying to write a new definition for a tag that's missing one, you may find that its scenes are using that tag differently than what you assumed. A tag's current usage, the consistency of its usage, the source of its scenes, and its total number of scene entries will all factor into decisions regarding possible edits.
### Scraped vs. Manual Tags
- **Most tags attached to scenes were scraped from studio sources, not manually added by editors.**
Currently, most tags attached to scenes are scraped from the original studio or some other official source, not manually added from the editors of StashDB. Our current methods of manually adding/removing a scene's tags individually isn't too bad on a small scale, but they are far too tedious and time-consuming to be worth using for large shifts in our tag organization in most cases. This means that most of StashDB's tag list leans on scraped tags in their organization and usage, rather than attempting to enforce major deviations from those sources. This may explain inaccuracies, inconsistencies, or other peculiarities of a particular tag. [Reading through the edit comments](#read-tag-edit-histories) may explain in further detail.
### Sorted vs. Unsorted Tags
- **Tags without categories and/or descriptions are considered "unsorted" and should generally be avoided when manually adding tags to scenes.**
If a tag doesn't have a category or description, then it is likely still unsorted. It will usually have a sparse or non-existent edit history as well. This means it's exact usage hasn't been determined yet, no potential merge targets have been found, and no decision has been made on if it's even worth keeping. It's usually preferable to avoid unsorted tags when manually adding them to a scene yourself. If you're just adding scraped tags though, don't worry if they're currently sorted or unsorted. More scraped sources for an unsorted tag could help us decide what to do with it in the future. Finally, if you want to find a quick list of sorted tags, lean on the [Tag Categories page of StashDB](https://stashdb.org/categories). Every tag with a category assigned will be organized to some extent already.
### Merging and Destroying Tags
- **Unsorted tags that do not have a unique and helpful meaning are candidates for merging/deleting.**
Great care must be taken when merging or deleting tags. When tags are merged or destroyed, it is not easily reversed. Currently, the goal when handling unsorted tags is consolidation. We are aiming to merge all closely related tags together while deleting any that are considered extraneous. The purpose is to create a curated set of tags that are as helpful and as consistent as possible, spanning every studio on StashDB. Just like with other parts of the database, merging is always preferred over deleting. Candidates for a merge/deletion could be tags that seem too vague, too specific, or otherwise irrelevant. These are of course subjective calls, but the rule of thumb should be, "Does this tag have a unique and helpful meaning?" If the answer is "yes", then keep it. If it's "no", then merging/deleting may be the best option. However, we are still trying to be conservative in our approach. Reverting changes can be tricky, so it's better to err on the side of keeping a tag if there's any doubt. Merges should also aim for a resulting tag that is consistent in its meaning. If the inclusion of a tag would result in less consistency of meaning, then it may be best to leave it separate for now. Finally, please remember to include any merged tag names [as aliases](#adding-tag-aliases). This can be done in your merge submission.
### Tag Merge Targets
- **Click "Merge" on the page of the tag you want to keep, then select any tags that should be removed and merged.**
If you click the big blue "Merge" button at the top of a tag's details page, that tag becomes the target of your merge request. In other words, any additional tags selected in the edit request form will be absorbed into that initial tag. Always merge into the tag you intend to keep. Often it will be the only "sorted" tag in your merge with a category and/or definition assigned to it. If you are merging previously "unsorted" tags, your preferred merge target is usually the most frequently used variation (meaning, it has the most scenes attached). Also please note roughly how many scene entries a tag has in your [edit comment](#tag-edit-comments) before merging. There is no easy way to find these numbers after a merge and they are often taken in consideration when choosing [primary names](#changing-a-tags-primary-name). If you would prefer to change the primary name of the tag as well, it is best to save that for a separate edit after the merge is approved.
### Destroying Tags
- **Rarely appropriate, usually there's a potential merge that would be preferred.**
Great care must be taken when deleting tags. When tags are destroyed, it is not easily reversed. Even if a tag seems irrelevant or useless, be sure to use the [search bar](https://stashdb.org/tags) to look for similar tags first. If you find a lot of similar tags or if those tags represent a large number of scenes, then it may be better to merge than to delete. Merging is always preferred over deleting, and [many of the same considerations apply](#merging-and-destroying-tags). Easy candidates for deletion include performer/director names, but make sure these are also saved in the proper fields of all the scenes themselves before submitting your destroy request. Sometimes series titles are used as tags. These can also be easy deletions, but it can sometimes be better to merge it into a similar tag. In these situations, the series title probably doesn't need to be added as an alias.
### Adding Tag Aliases
- **Make sure there aren't any other tags that would be a better fit for an alias, or that another tag isn't using it already.**
Tag aliases on StashDB have limited usefulness at the moment. They do not have the same functionality as Stash's tag aliases. However, we are still trying to use them in anticipation of future updates to both Stash and Stash-Box. Aliases can be used as alternative primary names, reflections of previously merged tags, terms used by a studio not covered by current aliases, alternate spellings, common misspellings, etc. The only limit for tag aliases other than basic relevancy is the following: Are there other tags using this term as its primary name? Are there other tags using this term as an alias? Are there any tags where this term would better fit as an alias? Would this alias be better suited as its own tag?
### Changing a Tag's Primary Name
- **Prioritize brevity, clarity, familiarity, and consistency.**
Since users can rename a tag to anything they'd like from within Stash, a tag's primary name isn't too important. Many will come down to purely subjective personal preference. Because of this, we don't have to worry about Stash too much when (re)naming tags. The main consideration when picking a primary name is how it will be displayed and organized on StashDB itself. Specifically, we want to find a balance between brevity, clarity, and familiarity, as well as its consistency with the naming of other tags. If you feel like a different name would be preferable for a particular tag, be sure to [check its edit history](#read-tag-edit-histories) first to see if it's been considered before or why it's using the current primary name.
### Assigning Tag Categories
- **If the tag you're editing doesn't have a category yet, add one yourself even if you have to guess to mark it as "sorted".**
If the tag you're editing doesn't have a category yet, try to assign one in the same edit. This shows that somebody has handled a tag, [marking it as "sorted"](#sorted-vs-unsorted-tags) to some extent. Categories are easy to correct afterwards, so don't worry about guessing. Also feel free to ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord) for clarification.

30
docs/tags/merging-tags.md Normal file
View File

@ -0,0 +1,30 @@
---
layout: default
title: "Merging Tags"
nav_order: 5
parent: Tags
---
# **Merging Tags**
{: .no_toc }
The following sections have been [formally approved]({{ site.baseurl }}/docs/getting-started-stashdb/#guideline-proposals) unless stated otherwise. Contributors are still expected to follow any [unconfirmed guidelines]({{ site.baseurl }}/docs/getting-started-stashdb/#unconfirmed-guidelines), but should know that they are subject to change in the near future. Failure to follow any of these guidelines may result in rejected submissions.
***
<details open markdown="block">
<summary>
Table of Contents
</summary>
{: .text-delta }
1. TOC
{:toc}
</details>
***
### Merging Sorted Tags
- **"Sorted" tags (already has category/description) shouldn't be considered eligible to be deleted or merged. Ask on Discord first if you think you've found an exception.**
If a tag has already been assigned a description, then it has already been organized by another editor. These can be considered ["sorted" tags]({{ site.baseurl }}/docs/tags/getting-started-tags/#sorted-vs-unsorted-tags). It could be used as a merge target, but shouldn't be considered eligible to be deleted or merged into something else at this time. If you feel you've found an exception to this, please ask in the **#ministry-of-truth** channel on [Discord]({{ site.baseurl }}/docs/getting-started-stashdb/#joining-our-discord) first.
_Unconfirmed guideline, subject to change pending formal approval._