Text markup in Engee

General information

Three markup languages are used for marking up text in Engee - Markdown, HTML, and LaTeX. Use them:

In annotations (see below for details):
In text cells of script editor (see below for details):

In addition, opening .html and .md files also uses a special interface to simplify markup handling (see sect. Markup of .md and .html files).

Text markup in Engee is mainly used in the script editor, which uses scripts with .ngscript, .jl and .ipynb formats. Text cells with a visual editor and Markdown support are available for these formats.

The script editor uses an extended Markdown dialect based on the CommonMark specification - Yandex Flavored Markdown (YFM) (see YFM documentation for details). This dialect contains additional markup elements (e.g., annotations, cat, etc.), which greatly simplifies work with text cells.

Standard Markdown elements are visually separated from the extended ones by a vertical separator on the toolbar:

script editor text x

External environments such as GitHub and GitLab do not support the extended YFM syntax. Therefore, markup in Engee that uses its specific constructs will not display correctly.

Markup in text cells

To add a text cell in the script editor, open the script and press +Text:

Text cells support markup in Markdown, LaTeX, and HTML. Double-click on a cell to open the interface:

text interface script

Example of a text cell with Markdown, LaTeX, HTML and plain text markup:

script example 1

Read more about the text cell interface in the article Script editor.

WYSIWYG Editor

The WYSIWYG editor is used by default by the script editor text cell. To change the text editing mode, click on the text editing mode script editor text 20 and select the mode you are interested in:

- visual editor (WYSIWYG), displays formatting immediately (used by default, recommended);
- Markdown markup, manually edit the source text in Markdown syntax;
- preview of markdown result without the ability to edit.

Script Editor Engee provides markup using the WYSIWYG ("What you see is what you get") paradigm, allowing you to format content using the built-in toolbar without having to manually mark up text.

The editor provides a wide range of tools for formatting text, inserting links, tables, images and other elements. For this purpose, a panel of 20 buttons is provided, each of which fulfils a specific function. You can use them to:

text interface script

Quickly format text with the desired styles (bold, italic, underline, etc.);
Insert headings, lists and checklists to form the structure of the script, hide subheadings (sections), etc…;
Place explanatory code, notes, quotations and annotations;
Add a table, image or link;
Set text colour and background to highlight important points;
Visualise the section in a hiding section (cat), for better perception of information;

A detailed description of each button of the WYSIWYG editor is given in article.

Formatting can be applied either by using the buttons on the panel, or by using hotkeys or Russian-language symbols (e.g. / Heading 1 for the first level heading). The editor automatically converts them into an understandable visual style. For example, entering a slash character (/) opens a menu with available options - just press Tab, Enter, the corresponding hotkey or click the mouse to select the desired one.

Markdown editor

If your tasks require more complex markup, then use the Markdown editing mode. To do this, select Markdown markup script editor text 21 in the edit modes script editor text 20 . Let’s look at the basic syntax of the Markdown language:

For more information about Markdown

Headings - use # to denote the first-level heading (the largest heading). Use ## for the second level header, and so on up to the sixth level:

# Заголовок первого уровня

## Заголовок второго уровня

...

###### Заголовок шестого уровня

* Text Selection* - use * or _ to italicise text. Use * * * or _ _ to bold text. Use ~ ~ ~ for strikethrough text.
```
*Курсивный текст*

**Полужирный текст**

~~Зачеркнутый текст~~
```

Lists - use *, - or + to create an unordered list. Use numbers with a dot to create an ordered list.

* Пункт списка 1
* Пункт списка 2

1. Пункт списка 1
2. Пункт списка 2

Quotes - use > to create quotes.
```
> Ваша цитата.
```
Code - wrap text with a backward apostrophe (backtick) ` to insert single-line code. Use three backward apostrophes ( ` ` ` ` ) to insert multi-line code.
```
Пример `кода` внутри текста.

```
Многострочный
код
```
```

Links - use the [link text](URL) construct to create a hyperlink.

[Документация Engee](https://engee.com/helpcenter/stable/)

Images - use the construct ![alternative text](image URL) to insert an image.

![Логотип](https://astralinux.ru/upload/iblock/ef6/398hnxlwiur3hci7uozjn9n9wagwp1n6.png)

Horizontal dash - use three hyphens - - - - - or three asterisks * * * * * to insert a horizontal dash.
```
---
```

Tables - use | and - to create tables.

| Заголовок 1 | Заголовок2 |
| ----------- | ----------- |
| Ячейка 1 | Ячейка 2 |
| Ячейка 3 | Ячейка 4 |

The Markdown interpreter in Engee supports text-based HTML markup. Let’s take a look at the most popular HTML tags:

For more information about HTML.

 or  - tags are used to make text bold.  is preferred in semantically relevant cases, when the text is really important.
```
Этот текст выделен с помощью тега strong, а этот тега b.
```

 or  - tags are used to italicise text. As with bold tags,  is preferred in semantically relevant cases.

<p>Этот текст выделен с помощью <em>тега em</em>, а этот <i>тега i</i>.</p>

<s> - tag is used to add strikethrough to text.

<p>Этот текст <s>зачеркнут</s>.</p>

 - tag is used to create a paragraph of text. Paragraphs are usually indented at the top and bottom.
```
Этот текст находится в абзаце.
```

<h1> - <h6> - tags are used to create headings of different levels. Headings have different sizes and are usually intended to structure the page content.

<h1>Заголовок уровня 1</h1>
<h2>Заголовок уровня 2</h2>
<h3>Заголовок уровня 3</h3>
<h4>Заголовок уровня 4</h4>
<h5>Заголовок уровня 5</h5>
<h6>Заголовок уровня 6</h6>

<ul>, <ol>, <li> - tags are used to create unordered <ul> and ordered <ol> lists, and their elements <li>.

<ul>
  <li>Первый элемент неупорядоченного списка</li>
  <li>Второй элемент неупорядоченного списка</li>
</ul>

<ol>
  <li>Первый элемент упорядоченного списка</li>
  <li>Второй элемент упорядоченного списка</li>
</ol>

<img> - tag is used to insert images into the page.

<img src="https://astralinux.ru/upload/iblock/ef6/398hnxlwiur3hci7uozjn9n9wagwp1n6.png" alt="Логотип Engee">

<a> - tag is used to insert links.

<a href="https://engee.com/helpcenter/stable/">Документация Engee</a>

Markdown and HTML in Engee by default support displaying LaTeX formulas using the KaTeX library.

For correct display, wrap the formula in $:

$…$ - for single line formulas, example:
```
 $x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a}$ 
```

$&dollar;…$&dollar; - for multi-line formulas, example:

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

After Engee switched to KaTeX, old scripts with LaTeX formulas without $ or &dollar;$ will not display correctly. Make sure all formulas are wrapped in $ or $&dollar;$ , and if necessary, remove any extra escape characters (\) that may have been added automatically.

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

MarkDown and HTML in Engee do not support video and audio tags, event attributes, global attributes, browser support attributes, and other HTML tags and attributes for more complex HTML customisation, or any LaTeX syntax beyond KaTeX.

Choose the markup language you need or combine them based on the tasks in your projects!

Annotation markup

Annotations are areas in workspace Engee where you can add text and format it, add lines of code and images.

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

Annotations, like text cells, use the markup languages Markdown with the ability to extend the functionality with HTML and LaTeX.

annotation example 1

For more information on working with annotations in Engee, see Abstracts.

Markup of .md and .html files

The .md and .html files in Engee have additional interface elements in the script editor with three display modes:

Editor - displays only the editor with Markdown syntax.
Editor and presentation mode - displays the editor and a preview of the finished markup.
Presentation mode - displays only ready markup.

script example 2

Useful links

Markdown Official Site
Official HTML site
Official LaTeX site
Markdown Syntax
Official LaTeX Documentation [Official LaTeX Documentation]
HTML Tags
KaTeX Documentation