Show TOC

Procedure documentationShowing and Creating Documentation Locate this document in the navigation structure

 

A data flow and its objects can contain documentation. You can show or edit the documentation on the data flow maintenance screen.

Procedure

Showing Documentation

To display the documentation, choose Show Documentation (Show Documentation).

A documentation screen area appears below the data flow.

  • Once you have selected a data flow object, the documentation for this object is displayed.

  • If you have not selected a data flow object, the documentation for the data flow is displayed.

The documentation title consists of the TLOGO object type, the object description and the technical object name. For the data flow, only the object type and technical name are shown in the title.

To switch to a documentation for a different object, select the required data flow object. To switch to the data flow documentation, select the background of the data flow maintenance screen.

Creating and Editing Documentation

  1. To create documentation for the data flow or a selected object, chooseDisplay <-> Change (Display <-> Change) in the documentation area of the data flow maintenance screen (change mode).

  2. Choose Document Type [Text/HTML] (Document Type) and specify the format of the documentation that you want to create. You can create a plain text file or you can use HTML (if you have special formatting requirements). You can change this setting for every document (in other words, every data flow object).

  3. Create the documentation in the editor.

    If the documentation is available as a local file, you can add it by choosing Load Local File (Load Local File).

    Note Note

    If you want HTML documentation, we recommend that you create the documentation in an external HTML editor. Then you can transfer it to the documentation maintenance screen for graphic modeling. You can do this by either dragging and dropping the HTML file into the editor or by inserting the file using the function Load Local File (Load Local File).

    End of the note.

  4. Save the documentation with the data flow.

Additional Functions
Search

To search for specific character strings in the documentation, chooseFind (Find).

Export

To save the documentation on a local computer, chooseSave As Local File (Save As Local File).