User Interface
Copy
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.
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.
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.
You can search for words or phrases within the document by clicking the icon
that appears in the upper right corner of the document window. The icon is replaced by a search box. Enter your search term in the box and press Enter. If the search term you specified is contained in the document, all instances of the term appear in a different font color.
You can scroll through the document by clicking on the up/down arrows in the Search box. The currently active match is highlighted as you scroll. The search box also displays the ordered position of the highlighted search term. If the document does not contain the search term you specified, the phrase “no matches are found” is displayed.
To replace text, select the down arrow in the upper right corner of the Search/Replace dialog. Doing so will expose the Replace portion of the dialog. Select ‘Replace Next’ icon
to step through the searched text results and replace with the text entered in the ‘Replace’ text box. Select the Replace All icon
to replace all found search strings in the document. Note that only editable portions of the document can have the text updated.
Images in a Technical Document can be resized dynamically using the left mouse button while selecting/dragging the image ‘resize handles’. Resize handles are shown in the Editor when the document is in Edit mode and the Image Document Element is selected.
Resize handles are small, circular icons rendered at each corner of a selected image. When the mouse is placed over any of the resize handles, the cursor image is switched to a two-sided arrow signifying that if the user presses and holds down the left mouse button while dragging, the image size will be dynamically updated. As the user drags the mouse, the actual image size (height and width values, in pixels) is displayed below the image.
Lifting the left mouse after dragging to resize will result in the image being resized. Note that the image is resized dynamically as the user drags the mouse and image size updates retain the original aspect ratio. The updated image size will be saved with the document content. The system will not allow a resize in either dimension of less than 10 pixels.
You can view different versions of the same document simultaneously using the following procedure:
Click the Document View icon
in the toolbar. The Document View dialogue box appears.
- Click the Side-by-Side button. The Language and Revision dropdowns are activated.
- Add
- Remove
- Copy
- Cut
- Convert to External
- Change Condition
- Copy
- View Condition
Select the Language and the document version for both documents. You cannot specify the same document version and language for both documents. If you do an error message similar to the following appears:
Specify how the documents appear by selecting either Rendered HTML or XML. You can also select the filters to use for each document.
Press Apply. Both documents appear side-by-side.
The left side contains the document that you opened first in the main grid. The document that appears on the right is the one you selected in the Document View dialog box.
You can only edit the document that appears on the left side view which is marked as Current. The document on the right side is marked as ReadOnly. The context menus for each document are different. The context menu for the editable document displays the following items:
The context menu for the read-only document displays the following items:
The Content Generator enables you to automatically generate a Table of Contents using the TOC-Section Document Element. The Content Generator for the TOC child Document Element iterates through a document and adds all the Chapter and Section document headings to the Table of Contents as shown here:
You can customize the number of headings displayed in the TOC by editing the TOC Item. For more information, refer to the Aras Innovator 30 – TDF Administrator’s Guide.
Adding a Table of Contents
Use the following procedure to add sections to the Table of Contents:
Right-click the Standard Doc folder in the Navigation pane. Select Insert>TOC-Section from the context menu.
A TOC-Section folder appears in the Navigation pane.
Select the Title Element and enter a title for the Table of Contents, as shown here:
Right-click the Title Element and select Add>TOC from the context menu to add entries to the Table of Contents.
