User Interface

Authoring and viewing Technical Document content is done using the Technical Document Form.
The window for Items of type Technical Document has two views: Form and Editor. These Views are accessed using a sidebar menu displayed in the left margin.

Figure 1.

Click the Form Button in the sidebar menu to display the Form. The Form shows all the properties of the Technical Document that have been exposed. If there are any related Items added to the Technical Document, they appear as separate tabs in the lower portion of the window as is usual for ItemType Forms. Click the Editor Button in the sidebar menu to display the Technical Documentation Framework.

Relationship Item Tabs are turned off by default. Update the ItemType to display Relationship tabs as required.

Figure 2.

The Technical Documentation Framework contains three main panes: Toolbar, Navigation Pane, and the Content Viewer/Editor. The toolbar contains various buttons to invoke separate functions for viewing and content editing. The buttons exposed on the toolbar are context-sensitive based on the currently selected Document Element. The navigation pane (sometimes called Structure Tree) displays individual ‘nodes’ each representing the hierarchy of Document Elements that comprise the document. Selecting the ‘+’ icon at various levels expands the tree by displaying all the child Document Elements. Selecting a node in the navigation pane causes the corresponding content associated with that node to be scrolled and highlighted in the Content Viewer/Editor. The Content Viewer/Editor displays the content of the document and represents the canvas on which content is added and modified by the author. Selecting content in the editor/viewer causes the corresponding Document Element node in the navigation pane to be scrolled and highlighted.