Documentation Toolbar
DocumentationTab.jpg

This toolbar appears when you select View } Process Explorer from the application’s main menu or Process Explorer from the flowsheet’s toolbar show/hide menu. As a shortcut, you can show/hide the process explorer by clicking on the ProcessExplBtn00085.jpg button on the main toolbar Clicking on the “Doc” tab will display the above window. For more details on the Process Explorer, see Process Explorer Toolbar interface and Process Explorer.

Up until v9.5 SuperPro Designer allowed users to include comments behind many objects used as part of a simulation file (e.g. Sections, Procedures, Equipment, Operations, Streams, resources, etc.). For all such objects, there has been a tab dedicated to entering and/or viewing comments (see the “Equipment Data Dialog: Comments Tab” for example).

However, once such comments are entered, it is difficult to know where they are unless a user looks for them by opening one-by-one all objects in file and looking under the “Comments” tab. Clearly that is not very productive, especially if the creator of the process file passes along the file to another coworker. Starting with version 9.5, SuperPro Designer has a dedicated interface for managing such comments. There's a tab (“Doc”) under the Process Explorer that when selected displays information just related to comments.

The various controls on the “Doc’ tab are described bellow:

Tree Control buttons:

The ShowHideCommentsNodes.jpg Button:

This button will show or hide nodes in the tree that don’t have any comments in their respective object (section procedure, equipment, operation, etc). By default only objects that contain comments are displayed in the tree structure.

The FindBtnSmall.jpg Button:

Clicking on this button will locate and select the object behind the selected node, in the flowsheet. Clearly it is not possible to locate specific resources such as materials, utilities or consumables as they may be used in many areas in the flowsheet, and therefore the button is disabled when such node is selected. The locate button applies to equipment, procedures, operations, streams and flowsheet comments.

The Drop Down control:

This control allows the user to search through the comments of all objects for key words or phrases. The drop down box keeps a history of all search strings. Click on the FindNextBtn.jpg button to find the next instance (find forward) of the search string and click on the FindPrevBtn.jpg button to find the previous instance (find backwards).

Comments Editing buttons:

The Edit.jpg Button:

Clicking on this button allows the user to get into editing mode to change existing comments or add new comments to an existing object. The same can be accomplished just by double clicking on a tree node above. Please note the some nodes do not allow any comments to be added, as they are there for tree grouping purposes.

The AcceptChgs.jpg Button:

When in editing mode clicking on this button will save any changes you have made to the comments of the selected node and will return to viewing mode. While in editing mode the editing area of the tab is enabled and has the focus. Clicking away from the editing window will also save any changes made to the comments.

The Delete00086.jpg Button:

After changes have been made and while still in editing mode, clicking on this button will discard any modifications made and will return to viewing mode.