Text markup in Engee
General information
-
In the text cells of script editor
(more details below):
-
And in annotations (see below for details):
In addition, opening .md and .html files also uses a special interface to simplify markup handling (see Sect. Marking up .md and .html files).
Text markup in Engee is mainly used in the script editor, which uses interactive scripts with .ngscript, .jl and .ipynb formats. Text cells with several markup modes are available for these formats (see .ngscript, .jl and .ipynb for details). Markup modes in text cells).
Markup modes in text cells
Markup in text cells is performed by the following modes:
-
Visual editor (wysiwyg)
- Instant text formatting mode (used by default, recommended); -
Markdown markup
- manual editing of the source text in Markdown syntax; -
Preview
- preview of the markup result without the possibility of editing.
Read more about the text cell interface in the article Script editor.
Visual editor (wysiwyg)
Script Editor Engee provides markup using the WYSIWYG paradigm ("What you see is what you get"), which allows you to design content using the built-in toolbar without the need for manual text markup. WYSIWYG is used by default text cells.
The WYSIWYG 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:
-
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 - to select the desired one, just press Tab, Enter, the corresponding hotkey or click with the mouse.
Markdown markup
If your tasks require more complex markup, use the Markdown editing mode. To do this, select the Markdown markup mode in the script editor’s text cell editing modes .
The Markdown markup mode is intended for manual text input with usage of Markdown markup language syntax. This approach is convenient when preparing complex structures (e.g. nested lists, tables, code) and allows you to edit and see the original markup directly.
Example of a text cell in the mode Markdown markup:
Markup in annotations
Annotations are areas in workspace Engee, inside which 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 
*:
Annotations, like text cells, use the markup languages Markdown with the ability to extend functionality with HTML and LaTeX.
For more information on working with annotations in Engee, see Abstracts.
Marking up .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.
