Toolbar
Selects application configuration options in the
Tool
bar. This table describes the options in the Tool
bar.Item | Description |
|---|---|
New File | Creates a template file. A new editor pane will be created starting with the name new (x), (x) being the first new unique number used after the last new file was opened, that is, if a new unsaved file is already loaded with the name new 1 , this editor pane will get the name new 2 . Once the file is saved to disk, this name will be replaced with the actual file name of the template document. |
Open File | Opens the Open dialog to navigate and select a template file to open. Files of type (.txt), (.csv), and (.xml) can be selected and opened. |
Save | Saves the document template file. This button will be enabled when changes are made to the currently active editor pane. If the file has not been previously saved but is a new file, then the Save As dialog will be presented to the engineer allowing for a file name and location to be selected. |
Cut | Cuts the selected text. This button will be enabled when at least one character in the active editor pane is selected. When clicked, the selected text will be cut from the page and stored on the clipboard. |
Copy | Copies the selected text. This button will be enabled when at least one character in the active editor pane is selected. When clicked, the selected text is copied and stored on the clipboard. |
Paste | Pastes the copied text. This button will be enabled when there is information stored on the clipboard and if an active editor pane is selected. When clicked, the contents of the clip board will be pasted into the active editor pane at the currently selected location. |
Delete | Deletes the selected text. This button will be enabled when at least one character in the active editor pane is selected. When clicked, the selected text is deleted from the editor pane. |
Undo | Undoes the previous edit operation in the active editor pane. |
Redo | Redoes the previous undo operation in the active editor pane. |
Word Wrap | Wraps the text in the editor to the space available in the editor pane. If this function is switched off, the text for a line will extend off the page, you can use the horizontal draw bar to view parts of the line that extend past the end of the editor panel. This option will only apply to the currently active editor window and will not be applied on application startup. |
View Line Number | Displays a vertical list of line numbers on the left side of the editor pane when this option is enabled. |
View End Of Line Character | Displays end of line characters (CR / LF). This option will only apply to the currently active editor window and will not be applied on application startup. |
Validate | Runs a validation check on the currently active editor pane. Any detected syntax errors will be displayed in the output Syntax Error pane. If no syntax errors are encountered, the following prompt will be displayed. |
Generate Documentation | Runs a document generation process for the active editor pane. Output, syntax errors and compiling information will be displayed in the Output pane. Compile information will be displayed in the status bar on the left-hand side and progress on the right side while the document generation process is running. |
Stop Document Generation | Stops the generation process. This button will only be enabled when a document generation process is underway. |
Project | Displays the currently loaded ACM project. The Document Generation Editor will always use the loaded project that is active within ACM. This field is not configurable. |
Execute Against | Compiles document template against various available ACM objects. All available project objects will show in a grouped dropdown list control. The categories of items available include Controller, Display, Alarms and Historian. The list will only contain items appearing in the project. All objects in the Execute Against list can be compiled against a specific controller or all controllers in the project by selecting a controller option from the Controller selection option (discussed in the next section), except for Display objects that can only be compiled against all controllers. When selecting a Display item, the Controller selection list will be disabled with the Generate All Controllers option will be pre-set. |
Controller | Displays all controllers configured in the ACM project. Once a project object has been selected as outlined in the previous section (excluding display objects), a single controller or all controllers can be selected to compile against. Output would then only be generated for the specific controller selection. This option will be disabled if a display object is selected in the Execute Against list discussed in the previous section. |
Provide Feedback