Comment Node

The Comment node provides you with a means for documenting a dataflow. Although all nodes include a comment field in their Info parameter tabs, the Comment node is a more conspicuous marker that makes it immediately apparent that a specific comment exists.

You can place as many Comment nodes in the workspace as you need to document the network. When you create a Comment node, Chalice assigns it a unique name (for example, "comment1"). It can be helpful to replace the default name with a more descriptive name. Type a unique name in the Name field of the Comment node panel.

Reading Comments:
Comments can easily be referred to whenever you are working in a Chalice network: Click and hold the Info (i) button on the right side of the Comment node, and your comment will be displayed in the popup panel. You do not have to access the Comment node panel to read a comment, only to edit one.

The Comment node features an Info parameter tab only. Unlike other nodes, the Comment node passes data without change to and from any nodes to which it is connected. Therefore, the Comment node can accept one input or no input, and its output connector may or may not be connected to another node in the dataflow.

If the Icon Image box in the local node menu of the Comment node is checked, the Frame Icon of the Comment node will display the image from the input node (if a node is connected to the Comment node). To save room in the workspace, turn off (uncheck) the Icon View box in the Comment node menu.

Info Parameter Tab

The feature of the Info tab that is relevant to the Comment node, the comment field, is described here. (For a complete description of the Info Tab , refer to chapter 6, "Node Panels and Parameters .")

Comment Field

To key in a comment, click the left mouse button in the Comment field and begin typing. If you wish to enter a carriage return, hold down the Alt key on the keyboard and press the Enter key. (Otherwise, the text will stream past the visible edge of the field to the left.)

To access the text for editing, click and drag the scroll bars at the bottom and side of the Comment field to view portions of the text that extend beyond the field frame.

Tip:
You can open a text editor window in which to write and edit your comments. Click the cursor in the Comment field and press Alt-e to bring up the text editor window.



Table of Contents | Index



Copyright 1996-1999 by Silicon Grail Corporation