Import/Export File Formats

TechWriter supports importing and exporting annotations either as a comma-delimited (CSV) text file or an XML file depending on the comment model that you are using. The comma-delimited file format is only available if you are using the Plain Text comment model, while the XML file format can be used for any of the comment models.

XML File Format

The XML file format is the recommended import/export file format because it supports all of the rich formatting capabilities of the TechWriter annotation editor. The elements and attributes used for this file format are described in the table below.

Element Attribute Description

Annotations Outermost container (document) element.

model Required attribute specifying the comment model used for the annotations. Valid values are: Html, JavaDoc and XmlComments.

Source Container element used to group annotations belonging to the same database.

name The "friendly name" you gave the database when you added it to your project.

Annotation The contents of the Annotation element include the item description, remarks and related comments formatted based on the comment model being used.

type Required attribute specifying the type of item the annotation applies to. Valid values are: Tables, Views, Columns, Functions, Procedures, Parameters, Sources.

title Optional attribute specifying the title of the item's topic page.

name Optional attribute specifying the name of the item. Omit this attribute for summary pages. Note that local items must be qualified using the same syntax used under the annotation tab.

Element	Attribute	Description
Annotations		Outermost container (document) element.
	model	Required attribute specifying the comment model used for the annotations. Valid values are: Html, JavaDoc and XmlComments.
Source		Container element used to group annotations belonging to the same database.
	name	The "friendly name" you gave the database when you added it to your project.
Annotation		The contents of the Annotation element include the item description, remarks and related comments formatted based on the comment model being used.
	type	Required attribute specifying the type of item the annotation applies to. Valid values are: Tables, Views, Columns, Functions, Procedures, Parameters, Sources.
	title	Optional attribute specifying the title of the item's topic page.
	name	Optional attribute specifying the name of the item. Omit this attribute for summary pages. Note that local items must be qualified using the same syntax used under the annotation tab.

To create an example of an XML export file, use the Export All Annotations option on the File Menu.

Comma-Delimited File Format

The comma-delimited file format is a common text file format that can be read and written by a variety of applications, such as Microsoft Excel. TechWriter can use this file format for importing and exporting annotations. The layout of the comma-delimited file format is described in the table below.

Column	Name	Description
1	Source	The "friendly name" you gave the database when you added it to your project.
2	Item Type	The type of item the annotation applies to. Valid values are: Tables, Views, Columns, Functions, Procedures, Parameters, Sources.
3	Item Name	The name of the item. Leave this column blank for summary pages. Note that local items must be qualified using the same syntax used under the annotation tab.
4	Parent Type	Item type of the parent. For Parameters, this should be set to either Functions or Procedures. For Columns, this should be set to either Tables or Views. For all other types this will be blank.
5	Parent Name	Name of the parent. For Parameters, this will the name of the function or stored procedure that the parameter belongs to. For Columns, this will be the name of the table or view that the column is defined in.
6	Annotation Type	The type of annotation. Valid values are: Title, Description.
7	Text	The text of the annotation.

The first line of the comma-delimited file is reserved for the column names as shown in the above table. Column values may be quoted with double quotes.

Please note: Due to limitations in the comma-delimited file format, the XML File Format is the recommended import/export file format. Annotations exported to this file format will always be converted to the Plain Text comment model which will not preserve most of the formatting capabilities of TechWriter.