Engee documentation

Annotations

Annotations are designed using text markup, the subtleties of which are described in the article. Text markup in Engee.

Annotations annotation 1 1 — these are the areas in workspace Engee, to which you can add text and format it, add lines of code, images, and more using markup languages. For example:

annotation example 1 en

For example, annotations use markup language syntax. Markdown with the ability to extend functionality using HTML and LaTeX.

To add annotations, left-click on an empty area of the Engee workspace. This will open a context menu with a button Add annotation annotation 1 1:

annotation 1 en

Annotations are located one level below any elements of the Engee workspace, which eliminates their unwanted overlap with the Engee interface model or tools.

Interface

When an annotation is added, an accessible interface opens.

annotation 2

  1. Bold annotation 3

  2. Italic annotation 4

  3. Underlined annotation 1 x

  4. Strikethrough annotation 5

  5. Monospaced annotation 2 x

  6. Highlighted annotation 3 x

As well as other actions annotation 4 x, which include the main set of auxiliary templates for text markup:

annotation 5 x en

Templates help you use all the basic functionality of annotations without diving into the subtleties of markup language syntax!

Inserting Images

The following syntax is used to insert images:

![]()

In square brackets [] you can specify an alternative text, in round brackets () is a link to an image on the Internet. Annotations in Engee do not support local paths to images located in file browser file browser 7.

Formulas

The library is used to write formulas in annotations. KaTeX. To display the formula correctly, enclose single—line expressions in $…​$ and multi-line expressions in .... This is necessary both for correct rendering and for the operation of the visual editor (WYSIWYG), which recognizes formulas only by such a frame. For example:

Code (KaTeX)

Formula Display

 
$x = \frac{-b \pm{b^2 - 4ac}}{2a}$
 

$$
\frac{1}{\sigma{2\pi}}
\exp\left(-\frac{(x - \mu)^2}{2 \sigma^2}\right)
$$

One-line formulas can also be wrapped in ... — in this case, they will be centered and displayed in enlarged size as multi-line expressions.:

annotation example 1 x
After switching Engee to KaTeX, old annotations with LaTeX formulas without $ or ` will be displayed incorrectly. Make sure that all formulas are wrapped in `$` or `, and if necessary, remove any extra escape characters (\) that might have been added automatically.

For more information and to implement a more complex syntax, see official KaTeX documentation.

Specifying the language in the code block

To specify the programming language in the annotation code block, a syntax is used indicating the language after a triple back apostrophe. For example, to specify the Python language:

```python
print("Hello, world!")
```

Basic operations

  • To edit an already created annotation, double-click on it with the left mouse button.

  • To move an annotation across the canvas, hold it down with the left mouse button.

  • To delete an annotation, left-click on it and use the Del or Backspace. The annotation will also be deleted automatically when its contents are deleted.

Limitations

  • Annotations do not support interactive mouse movement of text, images, or files from other sources (Drag-and-drop).

  • Annotations do not support copied coordinate planes from the window signal visualization graphs icon 1.

  1. Interface

  2. Markdown Syntax