Text markup in Engee

General information

Three markup languages are used to mark up text in Engee - Markdown, HTML, and LaTeX. Use them in annotations and text cells in script editor. When opening .html and .md files, Engee provides a special interface for easier markup (see Engee for details). Layout of .md and .html files).

You can work with text in Engee using the WYSIWYG paradigm ("What you see is what you get") by simply adding your text to annotations and the script editor:

text markup instruments

If your tasks require more complex markup, use Markdown. Let’s look at its basic syntax:

More 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 supports displaying LaTeX formulas using the MathJax library. For example, you can write LaTeX formulas in Markdown and see the following result:

LaTeX formula in Markdown

Result in Markdown

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

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

Choose the markup language you need or combine them based on your objectives for your project.

Annotation markup

Annotations are areas in workspace Engee inside which you can add text and formatting, add lines of code and images.

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

annotation example 1

To add annotations, left-click on an empty space in the Engee workspace. This will open a context menu with the Add Annotation button :

Within annotations you can use Markdown, LaTeX and HTML:

annotation example x

Markdown in a text cell

The .ngscript and .ipynb (Jupyter Notebook) scripts in Engee have their own text cells. To add a text cell, open the script and click +Text:

Text cells have a similar interface to annotations and also support layout in Markdown, LaTeX and HTML. Double-click on a cell to open the interface:

text interface script

For more information about the text cell interface, see Script editor.

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

script example 1

Layout 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 the finished 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