Skip to content

Commit b29ba1a

Browse files
hlomzikhlomzik
committed
Use insertmd directive to use generated details
1 parent 2649ce4 commit b29ba1a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+43
-830
lines changed

‎docs/source/tags/audio.md

Lines changed: 1 addition & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,46 +10,7 @@ The Audio tag plays audio and shows its waveform. Use for audio annotation tasks
1010

1111
Use with the following data types: audio
1212

13-
### Parameters
14-
15-
| Param | Type | Default | Description |
16-
| --- | --- | --- | --- |
17-
| name | <code>string</code> | | Name of the element |
18-
| value | <code>string</code> | | Data field containing path or a URL to the audio. |
19-
| [defaultspeed] | <code>string</code> | <code>1</code> | Default speed level (from 0.5 to 2). |
20-
| [defaultscale] | <code>string</code> | <code>1</code> | Audio pane default y-scale for waveform. |
21-
| [defaultzoom] | <code>string</code> | <code>1</code> | Default zoom level for waveform. (from 1 to 1500). |
22-
| [defaultvolume] | <code>string</code> | <code>1</code> | Default volume level (from 0 to 1). |
23-
| [hotkey] | <code>string</code> | | Hotkey used to play or pause audio. |
24-
| [sync] | <code>string</code> | | Object name to sync with. |
25-
| [height] | <code>string</code> | <code>96</code> | Total height of the audio player. |
26-
| [waveheight] | <code>string</code> | <code>32</code> | Minimum height of a waveform when in `splitchannels` mode with multiple channels to display. |
27-
| [splitchannels] | <code>boolean</code> | <code>false</code> | Display multiple audio channels separately, if the audio file has more than one channel. (**NOTE: Requires more memory to operate.**) |
28-
| [decoder] | <code>string</code> | <code>&quot;webaudio&quot;</code> | Decoder type to use to decode audio data. (`"webaudio"` or `"ffmpeg"`) |
29-
| [player] | <code>string</code> | <code>&quot;html5&quot;</code> | Player type to use to play audio data. (`"html5"` or `"webaudio"`) |
30-
31-
### Sample Results JSON
32-
33-
| Name | Type | Description |
34-
| --- | --- | --- |
35-
| original_length | <code>number</code> | length of the original audio (seconds) |
36-
| value | <code>Object</code> | |
37-
| value.start | <code>number</code> | start time of the fragment (seconds) |
38-
| value.end | <code>number</code> | end time of the fragment (seconds) |
39-
| value.channel | <code>number</code> | channel identifier which was targeted |
40-
41-
### Example JSON
42-
```json
43-
{
44-
"original_length": 18,
45-
"value": {
46-
"start": 3.1,
47-
"end": 8.2,
48-
"channel": 0,
49-
"labels": ["Voice"]
50-
}
51-
}
52-
```
13+
{% insertmd includes/tags/audio.md %}
5314

5415
### Example
5516

‎docs/source/tags/brush.md

Lines changed: 1 addition & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,7 @@ The `Brush` tag is used for image segmentation tasks where you want to apply a m
1010

1111
Use with the following data types: image.
1212

13-
### Parameters
14-
15-
| Param | Type | Default | Description |
16-
| --- | --- | --- | --- |
17-
| name | <code>string</code> | | Name of the element |
18-
| toName | <code>string</code> | | Name of the image to label |
19-
| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure whether the data labeler can select one or multiple labels |
20-
| [maxUsages] | <code>number</code> | | Maximum number of times a label can be used per task |
21-
| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
22-
| [smart] | <code>boolean</code> | | Show smart tool for interactive pre-annotations |
23-
| [smartOnly] | <code>boolean</code> | | Only show smart tool for interactive pre-annotations |
24-
25-
### Sample Results JSON
26-
27-
| Name | Type | Description |
28-
| --- | --- | --- |
29-
| original_width | <code>number</code> | Width of the original image (px) |
30-
| original_height | <code>number</code> | Height of the original image (px) |
31-
| image_rotation | <code>number</code> | Rotation degree of the image (deg) |
32-
| value | <code>Object</code> | |
33-
| value.format | <code>&quot;rle&quot;</code> | Format of the masks, only RLE is supported for now |
34-
| value.rle | <code>Array.&lt;number&gt;</code> | RLE-encoded image |
35-
36-
### Example JSON
37-
```json
38-
{
39-
"original_width": 1920,
40-
"original_height": 1280,
41-
"image_rotation": 0,
42-
"value": {
43-
"format": "rle",
44-
"rle": [0, 1, 1, 2, 3],
45-
"brushlabels": ["Car"]
46-
}
47-
}
48-
```
13+
{% insertmd includes/tags/brush.md %}
4914

5015
### Example
5116

‎docs/source/tags/brushlabels.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -10,40 +10,7 @@ The `BrushLabels` tag for image segmentation tasks is used in the area where you
1010

1111
Use with the following data types: image.
1212

13-
### Parameters
14-
15-
| Param | Type | Default | Description |
16-
| --- | --- | --- | --- |
17-
| name | <code>string</code> | | Name of the element |
18-
| toName | <code>string</code> | | Name of the image to label |
19-
| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure whether the data labeler can select one or multiple labels |
20-
| [maxUsages] | <code>number</code> | | Maximum number of times a label can be used per task |
21-
| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
22-
23-
### Sample Results JSON
24-
25-
| Name | Type | Description |
26-
| --- | --- | --- |
27-
| original_width | <code>number</code> | Width of the original image (px) |
28-
| original_height | <code>number</code> | Height of the original image (px) |
29-
| image_rotation | <code>number</code> | Rotation degree of the image (deg) |
30-
| value | <code>Object</code> | |
31-
| value.format | <code>&quot;rle&quot;</code> | Format of the masks, only RLE is supported for now |
32-
| value.rle | <code>Array.&lt;number&gt;</code> | RLE-encoded image |
33-
34-
### Example JSON
35-
```json
36-
{
37-
"original_width": 1920,
38-
"original_height": 1280,
39-
"image_rotation": 0,
40-
"value": {
41-
"format": "rle",
42-
"rle": [0, 1, 1, 2, 3],
43-
"brushlabels": ["Car"]
44-
}
45-
}
46-
```
13+
{% insertmd includes/tags/brushlabels.md %}
4714

4815
### Example
4916

‎docs/source/tags/choice.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,7 @@ meta_description: Customize Label Studio with choice tags for simple classificat
88

99
The `Choice` tag represents a single choice for annotations. Use with the `Choices` tag or `Taxonomy` tag to provide specific choice options.
1010

11-
### Parameters
12-
13-
| Param | Type | Description |
14-
| --- | --- | --- |
15-
| value | <code>string</code> | Choice value |
16-
| [selected] | <code>boolean</code> | Specify whether to preselect this choice on the labeling interface |
17-
| [alias] | <code>string</code> | Alias for the choice. If used, the alias replaces the choice value in the annotation results. Alias does not display in the interface. |
18-
| [style] | <code>style</code> | CSS style of the checkbox element |
19-
| [hotkey] | <code>string</code> | Hotkey for the selection |
20-
| [html] | <code>string</code> | Can be used to show enriched content, it has higher priority than `value`, however `value` will be used in the exported result (should be properly escaped) |
21-
| [hint] | <code>string</code> | Hint for choice on hover |
22-
| [color] | <code>string</code> | Color for Taxonomy item |
11+
{% insertmd includes/tags/choice.md %}
2312

2413
### Example
2514

‎docs/source/tags/choices.md

Lines changed: 1 addition & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,24 +12,7 @@ Choices can have dynamic value to load labels from task. This task data should c
1212

1313
The `Choices` tag can be used with any data types.
1414

15-
### Parameters
16-
17-
| Param | Type | Default | Description |
18-
| --- | --- | --- | --- |
19-
| name | <code>string</code> | | Name of the group of choices |
20-
| toName | <code>string</code> | | Name of the data item that you want to label |
21-
| [choice] | <code>single</code> \| <code>single-radio</code> \| <code>multiple</code> | <code>single</code> | Single or multi-class classification |
22-
| [showInline] | <code>boolean</code> | <code>false</code> | Show choices in the same visual line |
23-
| [required] | <code>boolean</code> | <code>false</code> | Validate whether a choice has been selected |
24-
| [requiredMessage] | <code>string</code> | | Show a message if validation fails |
25-
| [visibleWhen] | <code>region-selected</code> \| <code>no-region-selected</code> \| <code>choice-selected</code> \| <code>choice-unselected</code> | | Control visibility of the choices. Can also be used with the `when*` parameters below to narrow down visibility |
26-
| [whenTagName] | <code>string</code> | | Use with `visibleWhen`. Narrow down visibility by name of the tag. For regions, use the name of the object tag, for choices, use the name of the `choices` tag |
27-
| [whenLabelValue] | <code>string</code> | | Use with `visibleWhen="region-selected"`. Narrow down visibility by label value. Multiple values can be separated with commas |
28-
| [whenChoiceValue] | <code>string</code> | | Use with `visibleWhen` (`"choice-selected"` or `"choice-unselected"`) and `whenTagName`, both are required. Narrow down visibility by choice value. Multiple values can be separated with commas |
29-
| [perRegion] | <code>boolean</code> | | Use this tag to select a choice for a specific region instead of the entire task |
30-
| [perItem] | <code>boolean</code> | | Use this tag to select a choice for a specific item inside the object instead of the whole object |
31-
| [value] | <code>string</code> | | Task data field containing a list of dynamically loaded choices (see example below) |
32-
| [allowNested] | <code>boolean</code> | | Allow to use `children` field in dynamic choices to nest them. Submitted result will contain array of arrays, every item is a list of values from topmost parent choice down to selected one. |
15+
{% insertmd includes/tags/choices.md %}
3316

3417
### Example
3518

‎docs/source/tags/collapse.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,7 @@ order: 501
66

77
Collapse tag, a content area which can be collapsed and expanded.
88

9-
### Parameters
10-
11-
| Param | Type | Default | Description |
12-
| --- | --- | --- | --- |
13-
| [accordion] | <code>boolean</code> | <code>true</code> | Works as an accordion |
14-
| [bordered] | <code>string</code> | <code>false</code> | Shows border |
9+
{% insertmd includes/tags/collapse.md %}
1510

1611
### Example
1712
```html

‎docs/source/tags/datetime.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,7 @@ The DateTime tag adds date and time selection to the labeling interface. Use thi
88

99
Use with the following data types: audio, image, HTML, paragraph, text, time series, video
1010

11-
### Parameters
12-
13-
| Param | Type | Default | Description |
14-
| --- | --- | --- | --- |
15-
| name | <code>string</code> | | Name of the element |
16-
| toName | <code>string</code> | | Name of the element that you want to label |
17-
| only | <code>string</code> | | Comma-separated list of parts to display (date, time, month, year) date and month/year can't be used together. The date option takes precedence |
18-
| format | <code>string</code> | | Input/output strftime format for datetime (internally it's always ISO); when both date and time are displayed, by default shows ISO with a "T" separator; when only date is displayed, by default shows ISO date; when only time is displayed, by default shows a 24 hour time with leading zero |
19-
| [min] | <code>string</code> | | Set a minimum datetime value for only=date in ISO format, or minimum year for only=year |
20-
| [max] | <code>string</code> | | Set a maximum datetime value for only=date in ISO format, or maximum year for only=year |
21-
| [required] | <code>boolean</code> | <code>false</code> | Whether datetime is required or not |
22-
| [requiredMessage] | <code>string</code> | | Message to show if validation fails |
23-
| [perRegion] | <code>boolean</code> | | Use this option to label regions instead of the whole object |
24-
| [perItem] | <code>boolean</code> | | Use this option to label items inside the object instead of the whole object |
11+
{% insertmd includes/tags/datetime.md %}
2512

2613
### Example
2714
```html

‎docs/source/tags/ellipse.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,7 @@ The `Ellipse` tag is used to add an elliptical bounding box to an image. Use for
1010

1111
Use with the following data types: image.
1212

13-
### Parameters
14-
15-
| Param | Type | Default | Description |
16-
| --- | --- | --- | --- |
17-
| name | <code>string</code> | | Name of the element |
18-
| toName | <code>string</code> | | Name of the image to label |
19-
| [opacity] | <code>float</code> | <code>0.6</code> | Opacity of ellipse |
20-
| [fillColor] | <code>string</code> | | Ellipse fill color in hexadecimal |
21-
| [strokeColor] | <code>string</code> | <code>&quot;#f48a42&quot;</code> | Stroke color in hexadecimal |
22-
| [strokeWidth] | <code>number</code> | <code>1</code> | Width of the stroke |
23-
| [canRotate] | <code>boolean</code> | <code>true</code> | Show or hide rotation control |
24-
| [smart] | <code>boolean</code> | | Show smart tool for interactive pre-annotations |
25-
| [smartOnly] | <code>boolean</code> | | Only show smart tool for interactive pre-annotations |
13+
{% insertmd includes/tags/ellipse.md %}
2614

2715
### Example
2816

‎docs/source/tags/ellipselabels.md

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -10,50 +10,7 @@ The `EllipseLabels` tag creates labeled ellipses. Use to apply labels to ellipse
1010

1111
Use with the following data types: image.
1212

13-
### Parameters
14-
15-
| Param | Type | Default | Description |
16-
| --- | --- | --- | --- |
17-
| name | <code>string</code> | | Name of the element |
18-
| toName | <code>string</code> | | Name of the image to label |
19-
| [choice] | <code>single</code> \| <code>multiple</code> | <code>single</code> | Configure whether you can select one or multiple labels |
20-
| [maxUsages] | <code>number</code> | | Maximum number of times a label can be used per task |
21-
| [showInline] | <code>boolean</code> | <code>true</code> | Show labels in the same visual line |
22-
| [opacity] | <code>float</code> | <code>0.6</code> | Opacity of ellipse |
23-
| [fillColor] | <code>string</code> | | Ellipse fill color in hexadecimal |
24-
| [strokeColor] | <code>string</code> | | Stroke color in hexadecimal |
25-
| [strokeWidth] | <code>number</code> | <code>1</code> | Width of stroke |
26-
| [canRotate] | <code>boolean</code> | <code>true</code> | Show or hide rotation option |
27-
28-
### Sample Results JSON
29-
30-
| Name | Type | Description |
31-
| --- | --- | --- |
32-
| original_width | <code>number</code> | width of the original image (px) |
33-
| original_height | <code>number</code> | height of the original image (px) |
34-
| image_rotation | <code>number</code> | rotation degree of the image (deg) |
35-
| value | <code>Object</code> | |
36-
| value.x | <code>number</code> | x coordinate of the top left corner before rotation (0-100) |
37-
| value.y | <code>number</code> | y coordinate of the top left corner before rotation (0-100) |
38-
| value.radiusX | <code>number</code> | radius by x axis (0-100) |
39-
| value.radiusY | <code>number</code> | radius by y axis (0-100) |
40-
| value.rotation | <code>number</code> | rotation degree (deg) |
41-
42-
### Example JSON
43-
```json
44-
{
45-
"original_width": 1920,
46-
"original_height": 1280,
47-
"image_rotation": 0,
48-
"value": {
49-
"x": 3.1,
50-
"y": 8.2,
51-
"radiusX": 20,
52-
"radiusY": 16,
53-
"ellipselabels": ["Car"]
54-
}
55-
}
56-
```
13+
{% insertmd includes/tags/ellipselabels.md %}
5714

5815
### Example
5916

‎docs/source/tags/filter.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,7 @@ meta_description: Customize Label Studio with the Filter tag to filter labels to
88

99
Use the Filter tag to add a filter search for a large number of labels or choices. Use with the Labels tag or Choices tag.
1010

11-
### Parameters
12-
13-
| Param | Type | Default | Description |
14-
| --- | --- | --- | --- |
15-
| [placeholder] | <code>string</code> | <code>&quot;\&quot;Quick Filter\&quot;&quot;</code> | Placeholder text for filter |
16-
| [minlength] | <code>number</code> | <code>3</code> | Size of the filter |
17-
| [style] | <code>string</code> | | CSS style of the string |
18-
| [hotkey] | <code>string</code> | | Hotkey to use to focus on the filter text area |
11+
{% insertmd includes/tags/filter.md %}
1912

2013
### Example
2114

‎docs/source/tags/header.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,7 @@ meta_description: Customize Label Studio with the Header tag to display a header
88

99
The `Header` tag is used to show a header on the labeling interface.
1010

11-
### Parameters
12-
13-
| Param | Type | Default | Description |
14-
| --- | --- | --- | --- |
15-
| value | <code>string</code> | | Text of header, either static text or the field name in data to use for the header |
16-
| [size] | <code>number</code> | <code>4</code> | Level of header on a page, used to control size of the text |
17-
| [style] | <code>string</code> | | CSS style for the header |
18-
| [underline] | <code>boolean</code> | <code>false</code> | Whether to underline the header |
11+
{% insertmd includes/tags/header.md %}
1912

2013
### Example
2114

‎docs/source/tags/hypertext.md

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -10,45 +10,7 @@ The `HyperText` tag displays hypertext markup for labeling. Use for labeling HTM
1010

1111
Use with the following data types: HTML.
1212

13-
### Parameters
14-
15-
| Param | Type | Default | Description |
16-
| --- | --- | --- | --- |
17-
| name | <code>string</code> | | Name of the element |
18-
| value | <code>string</code> | | Value of the element |
19-
| [valueType] | <code>url</code> \| <code>text</code> | <code>text</code> | Whether the text is stored directly in uploaded data or needs to be loaded from a URL |
20-
| [inline] | <code>boolean</code> | <code>false</code> | Whether to embed HTML directly in Label Studio or use an iframe |
21-
| [saveTextResult] | <code>yes</code> \| <code>no</code> | | Whether to store labeled text along with the results. By default, doesn't store text for `valueType=url` |
22-
| [encoding] | <code>none</code> \| <code>base64</code> \| <code>base64unicode</code> | | How to decode values from encoded strings |
23-
| [selectionEnabled] | <code>boolean</code> | <code>true</code> | Enable or disable selection |
24-
| [clickableLinks] | <code>boolean</code> | <code>false</code> | Whether to allow opening resources from links in the hypertext markup. |
25-
| [highlightColor] | <code>string</code> | | Hex string with highlight color, if not provided uses the labels color |
26-
| [showLabels] | <code>boolean</code> | | Whether or not to show labels next to the region; unset (by default) — use editor settings; true/false — override settings |
27-
| [granularity] | <code>symbol</code> \| <code>word</code> \| <code>sentence</code> \| <code>paragraph</code> | | Control region selection granularity |
28-
29-
### Sample Results JSON
30-
31-
| Name | Type | Description |
32-
| --- | --- | --- |
33-
| value | <code>Object</code> | |
34-
| value.start | <code>string</code> | xpath of the container where the region starts (xpath) |
35-
| value.end | <code>string</code> | xpath of the container where the region ends (xpath) |
36-
| value.startOffset | <code>number</code> | offset within start container |
37-
| value.endOffset | <code>number</code> | offset within end container |
38-
| [value.text] | <code>string</code> | text content of the region, can be skipped |
39-
40-
### Example JSON
41-
```json
42-
{
43-
"value": {
44-
"start": "/div[1]/p[2]/text()[1]",
45-
"end": "/div[1]/p[4]/text()[3]",
46-
"startOffset": 2,
47-
"endOffset": 81,
48-
"hypertextlabels": ["Car"]
49-
}
50-
}
51-
```
13+
{% insertmd includes/tags/hypertext.md %}
5214

5315
### Example
5416

0 commit comments

Comments
 (0)