ArborX

tcom

Longname: t com ment   Open the Documentation Legend
Released: not available 
Created: not available 
See also: tdcom tfread

Summary
 Allows you to create and edit a comment stream which is assigned to an entity. You can use comments to describe how a tag works or what it is for. A more powerful feature of comments is that they can be used to store variable values which can then be 'read' automatically by a Arbortext APP script with tfread. This use of comments is discussed further in the 'Scripts' section of the Programming manual.
Example extract

The example below attaches the comment stream 'cm1' to the text stream 'tx1'.

 tcom "tx1", "cm1"

Syntax (SVNNA)
tcom  [  mode:n  entity:n?  ]?   tag name:t?  comment name:t?
mode:n
Ø|0  Calls up the Create/Edit comment stream for an entity dialogue box.
1  Edit the existing comment stream relating to the entity. Do nothing if it does not exist.
2  Edit the existing comment stream relating to the entity. Create a new comment and edit it if one does not exist.
entity:n
1  Text in the selected frame will be commented. If neither an entity nor a tag name are specified a context-sensitive default will be chosen.
2  Object graphic in the selected frame will be commented.
3  Raster graphic in the selected frame will be commented.
tag name:t

The name of the entity to comment. This parameter can only be present if the entity parameter is not present. If neither an entity nor a tag name are specified a context-sensitive default will be chosen.
comment name:t

The name of the comment stream to assign to the entity that is being commented.

Document created on 08-Feb-2003 (revision 1)