Skip to content
This repository has been archived by the owner on Nov 14, 2023. It is now read-only.

Commit

Permalink
Annotators Guides documentation added (cvat-ai#6411)
Browse files Browse the repository at this point in the history
<!-- Raise an issue to propose your change
(https://github.com/opencv/cvat/issues).
It helps to avoid duplication of efforts from multiple independent
contributors.
Discuss your ideas with maintainers to be sure that changes will be
approved and merged.
Read the [Contribution
guide](https://opencv.github.io/cvat/docs/contributing/). -->

<!-- Provide a general summary of your changes in the Title above -->

### Motivation and context
<!-- Why is this change required? What problem does it solve? If it
fixes an open
issue, please link to the issue here. Describe your changes in detail,
add
screenshots. -->

### How has this been tested?
<!-- Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc. -->

### Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply.
If an item isn't applicable for some reason, then ~~explicitly
strikethrough~~ the whole
line. If you don't do that, GitHub will show incorrect progress for the
pull request.
If you're unsure about any of these, don't hesitate to ask. We're here
to help! -->
- [x] I submit my changes into the `develop` branch
- [ ] I have added a description of my changes into the
[CHANGELOG](https://github.com/opencv/cvat/blob/develop/CHANGELOG.md)
file
- [ ] I have updated the documentation accordingly
- [ ] I have added tests to cover my changes
- [ ] I have linked related issues (see [GitHub docs](

https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
- [ ] I have increased versions of npm packages if it is necessary

([cvat-canvas](https://github.com/opencv/cvat/tree/develop/cvat-canvas#versioning),

[cvat-core](https://github.com/opencv/cvat/tree/develop/cvat-core#versioning),

[cvat-data](https://github.com/opencv/cvat/tree/develop/cvat-data#versioning)
and

[cvat-ui](https://github.com/opencv/cvat/tree/develop/cvat-ui#versioning))

### License

- [x] I submit _my code changes_ under the same [MIT License](
https://github.com/opencv/cvat/blob/develop/LICENSE) that covers the
project.
  Feel free to contact the maintainers if that's a concern.

---------

Co-authored-by: Boris Sekachev <[email protected]>
  • Loading branch information
2 people authored and mikhail-treskin committed Oct 25, 2023
1 parent 54178a6 commit 320bce5
Show file tree
Hide file tree
Showing 9 changed files with 111 additions and 1 deletion.
2 changes: 1 addition & 1 deletion site/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ the weight (affects the order of files display on the sidebar) and description (
### Start site localy

To start the site locally, you need a recent [extended version hugo](https://github.com/gohugoio/hugo/releases)
(recommend version 0.75.0 or later).
(recommend version 0.83.1).
Open the most recent release and scroll down until you find a list of Extended versions. [Read more](https://gohugo.io/getting-started/installing/#quick-install)

Add a path to "hugo" in the "Path" environment variable.
Expand Down
110 changes: 110 additions & 0 deletions site/content/en/docs/manual/advanced/specification.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,110 @@
---
title: 'Specification for annotators'
linkTitle: 'Specification for annotators'
weight: 16
description: 'Learn how to easily create and add specification for annotators using the Guide feature.'
---

The **Guide** feature provides a built-in markdown editor that
allows you to create specification for annotators.

Once you create and submit the specification,
it will be accessible from the annotation interface (see below).

You can attach the specification to **Projects** or to **Tasks**.

The attachment procedure is the same for individual users and organizations.

See:

- [Adding specification to Project](#adding-specification-to-project)
- [Editing rights](#editing-rights)
- [Adding specification to Task](#adding-specification-to-task)
- [Editing rights](#editing-rights-1)
- [Access to specification for annotators](#access-to-specification-for-annotators)
- [Markdown editor guide](#markdown-editor-guide)
- [Specification for annotators' video tutorial](#specification-for-annotators-video-tutorial)

## Adding specification to Project

To add specification to the **Projects**, do the following:

1. Go to the **Projects** page and click on the project to which you want to add specification.
2. Under the **Project description**, click **Edit**.

![Project specification](/images/project_spec.jpg)

3. Add instruction to the [Markdown editor](#markdown-editor-guide), and click **Submit**.

### Editing rights

- **For individual users**: only the project owner and the project assignee can edit the specification.
- **For organizations**: specification additionally can be edited by the organization owner and maintainer

![Editor rights](/images/editor_access_rights_1.jpg)

## Adding specification to Task

To add specification to the **Task**, do the following:

1. Go to the **Tasks** page and click on the task to which you want to add specification.
2. Under the **Task description**, click **Edit**.

![Task specification](/images/task_spec.jpg)

3. Add instruction to the [Markdown editor](#markdown-editor-guide), and click **Submit**.

### Editing rights

- **For individual users**: only the task owner and task assignee can edit the specification.
- **For organizations**: only the task owner, maintainer, and task assignee can edit the specification.

![Editor rights](/images/editor_access_rights_2.jpg)

## Access to specification for annotators

To open specification, do the following:

1. Open the job to see the annotation interface.
2. In the top right corner, click **Guide button**(![Guide Icon](/images/guide_icon.jpg)).

## Markdown editor guide

The markdown editor for **Guide** has two panes.
Add instructions to the left pane, and the editor
will immediately show the formatted result on the right.

![Markdown editor](/images/markdown_editor.jpg)

You can write in raw markdown or use the toolbar on the top of the editor.

![Markdown editor](/images/editor_toolbar.jpg)

<!--lint disable maximum-line-length-->

| Element | Description |
| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1 | Text formatting: bold, cursive, and strikethrough. |
| 2 | Insert a horizontal rule (horizontal line). |
| 3 | Add a title, heading, or subheading. It provides a drop-down list to select the title level (from 1 to 6). |
| 4 | Add a link. <br>**Note:** If you left-click on the link, it will open in the same window. |
| 5 | Add a quote. |
| 6 | Add a single line of code. |
| 7 | Add a block of code. |
| 8 | Add a comment. The comment is only visible to Guide editors and remains invisible to annotators. |
| 9 | Add a picture. To use this option, first, upload the picture to an external resource and then add the link in the editor. Alternatively, you can drag and drop a picture into the editor, which will upload it to the CVAT server and add it to the specification. |
| 10 | Add a list: bullet list, numbered list, and checklist. |
| 11 | Hide the editor pane: options to hide the right pane, show both panes or hide the left pane. |
| 12 | Enable full-screen mode. |

<!--lint enable maximum-line-length-->

## Specification for annotators' video tutorial

Video tutorial on how to use the **Guide** feature.

<!--lint disable maximum-line-length-->

<iframe width="560" height="315" src="https://www.youtube.com/embed/hAN9UGRvwOk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

<!--lint enable maximum-line-length-->
Binary file added site/content/en/images/editor_access_rights_1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/editor_access_rights_2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/editor_toolbar.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/guide_icon.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/markdown_editor.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/project_spec.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added site/content/en/images/task_spec.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 320bce5

Please sign in to comment.