Frame13/ayon-core
1
0
Fork 1
mirror of https://github.com/ynput/ayon-core.git synced 2025-12-24 21:04:40 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

initial commit of subset name template docstrings

Browse source
This commit is contained in:
iLLiCiTiT 2021-06-16 14:33:58 +02:00
parent a6ad5ad704
commit 00998f310d
1 changed files with 32 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

32
website/docs/project_settings/settings_project_global.md
View file

@ -172,6 +172,38 @@ Applicable context filters:
## Tools
Settings for OpenPype tools.
## Creator
Settings related to [Creator tool](artist_tools.md#details).
### Subset name profiles
![global_tools_creator_subset_template](assets/global_tools_creator_subset_template.png)
Subset name helps to identify published content. More specific name helps with organization and avoid mixing of content. Subset name is defined using one of templates defined in Subset name profiles settings. The template is filled with information from context in which creation was triggered.
Templates in settings are filtered by creator's family, host and task name. Template without filters is used as default template. It is recommend to set default template. If default template is not available `"{family}{Task}"` is used.
**Formatting keys**
All templates can contain text and formatting keys **family**, **task** and **variant** e.g. `"MyStudio_{family}_{task}"` (example - not recommended in production).
|Key|Description|
|---|---|
|family|Creators family|
|task|Task under which is creation triggered|
|variant|User input in creator tool|
**Formatting keys have 3 variants with different letter capitalization.**
|Task|Key variant|Description|Result|
|---|---|---|---|
|`bgAnim`|`{task}`|Keep original value as is.|`bgAnim`|
|`bgAnim`|`{Task}`|Capitalize first letter of value.|`BgAnim`|
|`bgAnim`|`{TASK}`|Each letter which be capitalized.|`BGANIM`|
Template may look like `"{family}{Task}{Variant}"`.
Some creators may have other keys as their context may require more information or more specific values. Make sure you've read documentation of host you're using.
## Workfiles
All settings related to Workfile tool.