docs: DOC-121: Update Taxonomy tag page for external taxonomy (#4855)

* [submodules] Build static HumanSignal/label-studio-frontend Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/6398047806 * docs: LSF Update Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/6398047806 * ci: Build frontend Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/6398115755 * [submodules] Build static HumanSignal/label-studio-frontend Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/6511594450 * docs: LSF Update Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/6511594450 * [frontend] Get build lsf Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/6857489390 --------- Co-authored-by: Caitlin Wheeless <[email protected]> Co-authored-by: robot-ci-heartex <[email protected]> Co-authored-by: hlomzik <[email protected]> Co-authored-by: hlomzik <[email protected]>
HumanSignal · Nov 14, 2023 · f20e120 · f20e120
1 parent b9d7d7a
commit f20e120
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 10 deletions.
diff --git a/docs/source/tags/taxonomy.md b/docs/source/tags/taxonomy.md
@@ -8,6 +8,8 @@ meta_description: Customize Label Studio with the Taxonomy tag and use hierarchi
 
 The `Taxonomy` tag is used to create one or more hierarchical classifications, storing both choice selections and their ancestors in the results. Use for nested classification tasks with the `Choice` tag.
 
+You can define nested classifications using the `Choice` tag, or retrieve external classifications using the `apiUrl` parameter. For more information on these options, see the [Taxonomy template page](/templates/taxonomy).
+
 Use with the following data types: audio, image, HTML, paragraphs, text, time series, video.
 
 [^1]: `fflag_feat_front_lsdv_4583_multi_image_segmentation_short` should be enabled for `perItem` functionality
@@ -20,18 +22,19 @@ Use with the following data types: audio, image, HTML, paragraphs, text, time se
 | --- | --- | --- | --- |
 | name | <code>string</code> |  | Name of the element |
 | toName | <code>string</code> |  | Name of the element that you want to classify |
-| [apiUrl] | <code>string</code> |  | URL to fetch taxonomy from remote source; API should accept optional array `path` param: `apiUrl?path[]=root&path[]=child1` to return only nested children of `child1` node[^2] |
+| [apiUrl] | <code>string</code> |  | Retrieve the taxonomy from a remote source. This can be a JSON-formatted file or a hierarchical data source read as an API.[^2] For more information, see the [Taxonomy template page](/templates/taxonomy) |
 | [leafsOnly] | <code>boolean</code> | <code>false</code> | Allow annotators to select only leaf nodes of taxonomy |
 | [showFullPath] | <code>boolean</code> | <code>false</code> | Whether to show the full path of selected items |
-| [pathSeparator] | <code>string</code> | <code>&quot;/&quot;</code> | Separator to show in the full path (default is " / ") |
-| [maxUsages] | <code>number</code> |  | Maximum number of times a choice can be selected per task |
+| [pathSeparator] | <code>string</code> | <code>&quot;/&quot;</code> | Separator to show in the full path (default is " / "). To avoid errors, ensure that your data does not include this separator |
+| [maxUsages] | <code>number</code> |  | Maximum number of times a choice can be selected per task or per region |
 | [maxWidth] | <code>number</code> |  | Maximum width for dropdown |
 | [minWidth] | <code>number</code> |  | Minimum width for dropdown |
 | [required] | <code>boolean</code> | <code>false</code> | Whether taxonomy validation is required |
 | [requiredMessage] | <code>string</code> |  | Message to show if validation fails |
 | [placeholder=] | <code>string</code> |  | What to display as prompt on the input |
 | [perRegion] | <code>boolean</code> |  | Use this tag to classify specific regions instead of the whole object |
 | [perItem] | <code>boolean</code> |  | Use this tag to classify specific items inside the object instead of the whole object[^1] |
+| [legacy] | <code>boolean</code> |  | Use this tag to enable the legacy version of the Taxonomy tag. When true, the `apiUrl` parameter is not useable[^2] |
 
 ### Example
 

diff --git a/label_studio/core/static/js/478.chunk.js.map b/label_studio/core/static/js/478.chunk.js.map
diff --git a/label_studio/frontend/dist/lsf/js/main.js b/label_studio/frontend/dist/lsf/js/main.js
diff --git a/label_studio/frontend/dist/lsf/js/main.js.map b/label_studio/frontend/dist/lsf/js/main.js.map
diff --git a/label_studio/frontend/dist/lsf/version.json b/label_studio/frontend/dist/lsf/version.json
@@ -1,6 +1,6 @@
 {
-  "message": "feat: LEAP-336: Collapsible cards in Ranker",
-  "commit": "da3030a3311928aab6c33aba47fbb9998f8dbe5b",
+  "message": "docs: DOC-121: Update Taxonomy tag page for external taxonomy (#1577)",
+  "commit": "10d60d6626b9a405cc6ba9ccbbe4b54d77e18278",
   "branch": "master",
-  "date": "2023/11/10 16:24:55"
-}
+  "date": "2023-11-13T19:56:12Z"
+}