CSV Record Format

The CSV record is formatted as:

Type, Scope, Name, Description, Data Type, Specifier

where:

Type

Indicates the type or subtype of the record. Valid types are Tag, Alias, and Comment.

To support the Project Documentation Languages feature, the description of the top level CSV/TSV tag is moved from the Tag row to a Comment row. The Type token is modified to also contain a language ID. For tags, this means that the Comment identifier is modified to COMMENT:<language_ID>, for example, COMMENT-en-US.

Rung Comments for the CSV/TSV format are also enhanced to allow for multi-lingual comments. Similar to tag descriptions, the members of the Type column that can have multiple languages are modified to also include a language ID. RCOMMENT changes to RCOMMENT:<language_ID> and TEXTBOX changes to TEXTBOX:<language_ID>, for example, RCOMMENT:fr-FR and TEXTBOX:de-DE.

Scope

Indicates the program in which the tag resides. The scope is empty for controller scope tags and contains the program name for program scope.

Name

Indicates the name of the tag.

Description

A description of the component, enclosed in quotation marks. If no description is available, an empty quoted string should be used (for example, " ").

Data Type

Defines the data type of the tag. This field is only used when the type is Tag; For Alias and Comment types, this field is blank.

Note that multi-dimensional arrays require the use of a comma and must be enclosed within quotes.

Specifier

Defines additional information needed for Tag Alias and Tag Comment. When the type is Tag, the specifier is not used and should contain an empty string (for example, " ").

When the type is Alias, this field specifies the operand for which this tag is an alias.

When the type is Comment, this field specifies the actual element with which the description should be associated.

Note that multi-dimensional arrays require the use of a comma and must be enclosed within quotes.