Choose the Annotate... menu item to create a line-by-line file listing of the changes made to each specified element generation; CMS places this file in your current default directory or a directory you specify. The annotate transaction documents the development of an element, and creates an output file that contains an annotated listing; unless you specify a different name, CMS names the file name the same as the element name and the file type is .ANN. The annotated listing file contains two parts: o A history o A source file listing The history includes the following: o Generation number o Date, time, user, and remark associated with each generation of the element The source file listing includes the following: o All lines inserted or modified from generation 1 to the specified generation.
1 – A sf
If you click on an object or objects before choosing the Annotate... menu item, the Selected box contains those objects. CMS performs the annotate transaction on the selected objects.
2 – A ef
Fill in the Element field with the name of the object or objects you want annotated. The object can be an element name, a group name, a wildcard expression, or a list of these separated by commas. If you specify a group name, CMS annotates each element in the group. If you use wildcards, CMS produces one annotated listing file for each matching element. By default, CMS annotates the most recent generation on the main line of descent of each element. If you want to annotate a specific generation of the element, you must also specify the generation number in the Generation field.
3 – A gf
Fill in the Generation field with the number of the generation you want annotated. For example, 3B2. If you omit this field, CMS by default annotates the most recent generation on the main line of descent.
4 – A mg
Fill in the Merge Generation field with the number of the generation to be merged into the retrieved generation. The merge transaction combines two generations of an element and creates a single file that contains the annotated listing. The file contains text common to both generations. When changes that are not identical are made in the same position of the common ancestor, the changes from both generations are included in the resulting file and are marked as a conflict.
5 – A fa
Click on the Full Annotation button to direct CMS to include all of the following information about the file used to create each generation: o Creation time o Revision time o Revision number o Record format o Record attributes o Deleted lines
6 – A of
The Output Format options control whether the history and source file listing is formatted. You must specify the type of formatting and data partition. The formatting types include: o ASCII o Decimal o Hexadecimal o Octal
6.1 – A ii
Click on the ASCII button to specify that each byte of data be displayed as an ASCII character. ASCII is most useful when files contain textual data.
6.2 – A dc
Click on the Decimal button to specify that each value be displayed as a decimal numeral. If you specify decimal output, you cannot also specify Records as an Output Partition. By default, data is partitioned into longwords.
6.3 – A hx
Click on the Hexadecimal button to specify that each value be displayed as a hexadecimal numeral. If you specify hexadecimal output, you cannot also specify Records as an Output Partition. By default, data is partitioned into longwords.
6.4 – A oc
Click on the Octal button to specify that each value be displayed as an octal numeral. If you specify octal output, you cannot also specify Records as an Output Partition. By default, data is partitioned into longwords.
7 – A op
The Output Partition options control whether the history and source file listing is formatted. You must specify the type of formatting and data partition. The data partition types include: o Records o Byte o Word o Long
7.1 – A rc
Click on the Records button to specify that no further partitioning of data is to occur beyond the record partitioning already in the file. This partitioning is most useful when the files contain textual data. You can only specify Records by itself or in conjunction with the ASCII Output Format.
7.2 – A bp
Click on the Byte button to specify that the data displayed is to be partitioned into bytes.
7.3 – A wp
Click on the Word button to specify that the data displayed is to be partitioned into word values.
7.4 – A lg
Click on the Long button to specify that the data displayed is to be partitioned into longword values. This is the default partitioning for Decimal, Hexadecimal, and Octal Output Formats.
8 – A dfn
Fill in the Output File field with the name of a file to which CMS should write the annotated output. If you do not specify a file name in the Output File field, CMS creates a file with the element name and the file type .ANN in your default directory. You can also choose the Appended option, which appends the output to the existing file. You may annotate multiple elements by using wildcards, a comma list, or a group name; however, if you do not specify wildcards in the output file, CMS creates successive versions of the file.
9 – A atb
Click on the Appended button to control whether CMS appends the history and source file listing to an existing file or creates a new file. If you choose Appended and the output file does not exist, CMS creates a new file. If you do not provide an output file specification, CMS searches your default directory for a file with the element file name and the file type .ANN.