Skip to content

Commit

Permalink
open spec auto (#7587)
Browse files Browse the repository at this point in the history
  • Loading branch information
mdacoca authored Mar 11, 2024
1 parent 58b6bad commit cd5cd44
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions site/content/en/docs/manual/advanced/specification.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,35 @@ To add specification to the **Task**, do the following:

## 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)).
The specification is opened automatically when the job has `new annotation` state.
It means, that it will open when the assigned user begins working on the first
job within a **Project** or **Task**.

The specifications will not automatically reopen
if the user moves to another job within the same **Project** or **Task**.

The specification is opened automatically once for a user when the job has `new annotation` state.
If a **Project** or **Task** is reassigned to another annotator, the specifications will
automatically be shown when the annotator opens the first job but will
not reappear for subsequent jobs.

Additionally, you may tell CVAT interface to open the specification, by adding a dedicated query parameter to link:
To enable the option for specifications to always open automatically,
append the `?openGuide` parameter to the end of the job URL you share with the annotator:

`

```
/tasks/<task_id>/jobs/<job_id>?openGuide
`
```
For example:

```
https://app.cvat.ai/tasks/taskID/jobs/jobID?openGuide
```

To open specification manually, 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

Expand All @@ -100,7 +117,7 @@ You can write in raw markdown or use the toolbar on the top of the editor.
| 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. |
| 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. |
Expand Down

0 comments on commit cd5cd44

Please sign in to comment.