|
|
|
|
tdcom |
Longname: | t d ocument com ment |  |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Released: | not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Created: | not available | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See also: | tcom tfcom tfread | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Summary |
Creates a document comment stream called _doc_com_ if it does not already exist, and places the text cursor at the top of the stream. The tdcom macro can, therefore, be used both to create and examine document comments. You can use comments to describe how a document 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. |
Example (n/a) |
No example is available for this feature. |
Syntax
|
|
|
Comment streams must always be the first tag in a document, since this saves unnecessary searching. When you comment a document from within Arbortext APP, the comment will always appear at the start of the document. If you are planning to add comments to a document using an external editor or database program, you may want to examine the way Arbortext APP writes a comment by setting one up as normal and looking at the resulting .3d file. |
Document created on 08-Feb-2003 (revision 1)