Merge pull request #1717 from pypeclub/feature/subset_template_documentation

Subset template and TVPaint subset template docs

website/docs/admin_hosts_tvpaint.md

@@ -0,0 +1,30 @@
+---
+id: admin_hosts_tvpaint
+title: TVPaint
+sidebar_label: TVPaint
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+## Subset name templates
+Definition of possibile subset name templates in TVPaint integration.
+
+### [Render Layer](artist_hosts_tvpaint#render-layer)
+Render layer has additional keys for subset name template. It is possible to use **render_layer** and **render_pass**.
+
+- Key **render_layer** is alias for variant (user's input).
+- For key **render_pass** is used predefined value `"Beauty"` (ATM value can't be changed).
+
+### [Render pass](artist_hosts_tvpaint#render-pass)
+Render pass has additional keys for subset name template. It is possible to use **render_layer** and **render_pass**.
+- Key **render_layer** is filled with value of **render_pass** from `renderLayer` group.
+- Key **render_pass** is alias for variant (user's input).
+
+:::important Render Layer/Pass templates
+It is recommended to use same subset name template for both **renderLayer** and **renderPass** families.
+- Example template: `"{family}{Task}_{Render_layer}_{Render_pass}"`
+:::
+
+### [Review](artist_hosts_tvpaint#review) and [Workfile](artist_hosts_tvpaint#workfile)
+Families **review** and **workfile** are not manually created but are automatically generated during publishing. That's why it is recommended to not use **variant** key in their subset name template.

website/docs/artist_hosts_tvpaint.md

@@ -45,7 +45,7 @@ In TVPaint you can find the Tools in OpenPype menu extension. The OpenPype Tools
 
 
 ## Create 
-In TVPaint you can create and publish **[Reviews](#review)**, **[Render Passes](#render-pass)**, and **[Render Layers](#render-layer)**. 
+In TVPaint you can create and publish **[Reviews](#review)**, **[Workfile](#workfile)**, **[Render Passes](#render-pass)** and **[Render Layers](#render-layer)**.
 
 You have the possibility to organize your layers by using `Color group`.  
 
@@ -67,26 +67,13 @@ OpenPype specifically never tries to guess what you want to publish from the sce
 
 When you want to publish `review` or `render layer` or `render pass`, open the `Creator` through the Tools menu `Create` button.
 
-### Review 
+### Review
+`Review` renders the whole file as is and sends the resulting QuickTime to Ftrack.
+- Is automatically created during publishing.
 
-<div class="row markdown">
-<div class="col col--6 markdown">
-
-`Review` renders the whole file as is and sends the resulting QuickTime to Ftrack. 
-
-To create reviewable quicktime of your animation:
-
-- select `Review` in the `Creator`
-- press `Create`
-- When you run [publish](#publish), file will be rendered and converted to quicktime.`
-
-</div>
-<div class="col col--6 markdown">
-
-![createreview](assets/tvp_create_review.png)
-
-</div>
-</div>
+### Workfile
+`Workfile` stores the source workfile as is during publishing (e.g. for backup).
+- Is automatically created during publishing.
 
 ### Render Layer
 

website/docs/project_settings/settings_project_global.md

@@ -172,6 +172,39 @@ 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 published content. Subset name is defined using one of templates defined in **Subset name profiles settings**. The template is filled with context information at the time of creation.
+
+Usage of template is defined by profile filtering using creator's family, host and task name. Profile without filters is used as default template and 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.
 

website/sidebars.js

@@ -90,7 +90,8 @@ module.exports = {
                 "admin_hosts_maya",
                 "admin_hosts_resolve",
                 "admin_hosts_harmony",
-                "admin_hosts_aftereffects"
+                "admin_hosts_aftereffects",
+                "admin_hosts_tvpaint"
             ],
         },
         {