Creating Object Documentation in the HTML Editor

Use

You use the HTML editor that is integrated in the ES Builder to create language-specific texts for an object.

Prerequisites

In the software component version that the object belongs to the checkbox Uses External Documentation is not set.
More information: Editing Software Component Versions
You have opened the object to be documented. To call the HTML editor, in the menu bar in the object editor, choose with the quick info Show/Hide Documentation.

Features

Display mode displays the object documentation. The content of the documentation is structured in blocks with defined headings (for example, Use). The number of blocks and the headings used vary depending on the object type.

Change mode splits the HTML editor into two screen areas.

Screen Areas in Change Mode

Area	Function
Editor	You use this area to create texts in HTML source code. You can only enter text for one block at a time. You use the dropdown list box at the top of the editor window to select the block for which you want to enter text. You can create texts without formatting in the HTML editor. In addition, you can enter hyperlinks. More information: Entering Hyperlinks
Preview Area	This area shows you the entire documentation with all the blocks.

Area

Function

Editor

You use this area to create texts in HTML source code. You can only enter text for one block at a time. You use the dropdown list box at the top of the editor window to select the block for which you want to enter text.

You can create texts without formatting in the HTML editor. In addition, you can enter hyperlinks.

More information: Entering Hyperlinks

Preview Area

This area shows you the entire documentation with all the blocks.