Update docs (#948)

This commit is contained in:
pollfly
2024-11-03 15:32:30 +02:00
committed by GitHub
parent af5639ac99
commit be102be4c3
51 changed files with 458 additions and 48 deletions

View File

@@ -181,7 +181,7 @@ or the arrow keys on the keyboard). Closing the frame editor will prompt you to
|<img src="/docs/latest/icons/ico-metadata.svg" alt="edit metadata" className="icon size-md space-sm" />|Edit metadata|Hover over an annotation in the list and click the icon to open the edit window. Input the metadata dictionary in JSON format. This metadata is specific to the selected annotation, not the entire frame.|
|<img src="/docs/latest/icons/ico-lock-open.svg" alt="Lock annotation" className="icon size-md space-sm" />|Lock / Unlock annotation |Click the button on a specific annotation to make it uneditable. You can also click the button on top of the annotations list to lock all annotations in the frame.|
|<img src="/docs/latest/icons/ico-trash.svg" alt="Trash" className="icon size-md space-sm" />|Delete annotation|Click the annotation or bounded area in the frame and then click the button to delete the annotation.|
|<img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />|Show/hide all annotations |Click the button to view the frame without annotations. When annotations are hidden, they can't be modified. |
|<img src="/docs/latest/icons/ico-show.svg" alt="Eye Show All" className="icon size-md space-sm" />|Show/hide annotations |Click the button on a specific annotation to hide it. You can also click the button on top of the annotations list to hide all annotations. Hidden annotations can't be modified. |
||Delete label |In the relevant annotation, click **x** on the label you want to remove.|
### Frame Labels

View File

@@ -248,9 +248,15 @@ according to the previously configured setting.
#### Preview Source
When using multi-source FrameGroups, users can choose which of the FrameGroups' sources will be displayed as the preview.
Select a source from the **PREVIEW SOURCE** menu.
Select a source from the **Current Source** menu.
Choose the `Default preview source` option to present the first available source for each frame (sources are retrieved in ASCIIbetical order).
Choose the `All sources` option to present all the FrameGroups sources in a grid. In this view, the annotation panel
shows annotations grouped by their respective sources. Additionally, annotation tools (e.g. create/delete/modify
annotations) are not available in this view.
![All sources preview](../../img/hyperdatasets/preview_all_sources.png)
:::note Unavailable Source
If a FrameGroup doesn't have the selected preview source, the preview displays the "Source not available" message.
:::