Documenting an Object
Use
You use this function to create documentation for an object.
Prerequisites
You have opened the
object to be documented. To call the documentation editor, choose 
with the quick info Show/Hide Documentation.
Features
Display mode displays the object documentation. The documentation is structured by using key blocks. Different key blocks are used for different object types.
Change mode splits the editor into two screen areas.
Screen Areas in Change Mode
Area |
Function |
HTML editor |
You use this area to create texts in HTML source code. You can only enter text for one key block at a time. You use the dropdown list box at the top of the editor window to select the key block where you want to enter text. |
Preview area |
This area shows you the entire documentation with all the key blocks. |
Other Functions
In the documentation editor you can set hyperlinks to external documentation.
Functions of the Toolbar
Icon |
Function |
|
Create: Creates new documentation for an object The system switches to change mode when you first create an object. |
|
Change Documentation: Switches from display to change mode The mode of the documentation editor is independent of the mode of the object editor in which the relevant object is open. |
|
Save: Saves the documentation. |
|
Print Documentation: Prints the documentation. |
|
Change Language: You can set the original language for the object documentation. An information window displays the current logon language and the original language set. You define the original language in the Original Language field. |
|
Close Documentation: Closes the documentation editor |
