Документация Engee

Аннотации

Аннотации оформляются с помощью текстовой разметки, тонкости использования которой описаны в статье Разметка текста в Engee.

Аннотации annotation 1 1 — это области в рабочем пространстве Engee, в которые можно добавлять текст и форматировать его, добавлять строки кода, изображения и многое другое средствами языков разметки. Например:

annotation example 1

Так, в аннотациях используется синтаксис языка разметки Markdown с возможностью расширения функциональности с помощью HTML и LaTeX.

Для добавления аннотаций нажмите левой кнопкой мыши на пустой области рабочего пространства Engee. Это откроет контекстное меню с кнопкой Добавить аннотацию annotation 1 1:

annotation 1

Аннотации находятся на уровень ниже любых элементов рабочего пространства Engee, что исключает их нежелательное наложение на модель или инструменты интерфейса Engee.

Интерфейс

При добавлении аннотации открывается доступный интерфейс

annotation 2

  1. Полужирный annotation 3

  2. Курсив annotation 4

  3. Подчеркнутый annotation 1 x

  4. Зачеркнутый annotation 5

  5. Моноширинный annotation 2 x

  6. Выделенный annotation 3 x

А также другие действия annotation 4 x, включающие основной набор вспомогательных шаблонов для разметки текста:

annotation 5 x

Шаблоны помогают использовать весь базовый функционал аннотаций без погружения в тонкости синтаксиса языков разметки!

Вставка изображений

Для вставки изображений используется следующий синтаксис:

![]()

В квадратных скобках [] вы можете задать альтернативный текст, в круглых () – ссылку на изображение в сети интернет. Аннотации в Engee не поддерживают локальные пути до изображений, лежащих в файловом браузере file browser 7.

Формулы

Для написания формул в аннотациях используется библиотека KaTeX. Чтобы формула корректно отображалась, заключайте однострочные выражения в $…​$, а многострочные — в $$…​$$. Это необходимо как для корректного рендеринга, так и для работы визуального редактора (WYSIWYG), который распознает формулы только по такому обрамлению. Например:

Код (KaTeX)

Отображение формулы

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

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

Однострочные формулы можно также оборачивать в $$…​$$ — в этом случае они будут центрированы и отображены увеличенным размером, как многострочные выражения:

annotation example 1 x
После перехода Engee на KaTeX, старые аннотации с LaTeX-формулами без $ или $$ будут отображаться некорректно. Убедитесь, что все формулы обернуты в $ или $$, и при необходимости удалите лишние символы экранирования (\), которые могли быть добавлены автоматически.

Для получения дополнительной информации и для реализации более сложного синтаксиса см. официальную документацию KaTeX.

Указание языка в блоке кода

Для указания языка программирования в блоке кода аннотации используется синтаксис с указанием языка после тройного обратного апострофа. Например, для указания языка Python:

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

Основные операции

  • Для редактирования уже созданной аннотации дважды нажмите по ней левой кнопкой мыши.

  • Для перемещения аннотации по холсту зажмите ее левой кнопкой мыши.

  • Для удаления аннотации нажмите по ней левой кнопкой мыши и используйте клавишу Del или Backspace. Аннотация также будет удалена автоматически при удалении ее содержимого.

Ограничения

  • Аннотации не поддерживают интерактивное перемещение мышью текста, картинок или файлов из других источников (Drag-and-drop).

  • Аннотации не поддерживают скопированные координатные плоскости из окна графиков graphs icon 1.

Полезные ссылки

  1. Интерфейс

  2. Синтаксис Markdown