Using Documentor : Producing the Document Segments : Creating a Document

Creating a Document

To create a document:

1.
Click New. The New Document dialog box opens.
2.
Enter a name for the new document in the text box. The name must begin with a letter, and can contain only alphanumeric characters or underscores.

The name must be unique in this project. If a document with this name already exists, the system displays a warning. You can cancel or confirm your choice to overwrite the old document. To modify an existing name, select a name from the drop-down list and modify it in the text box.
3.
4.
Click OK.

The Documentor checks the template for errors. If there are compilation errors, the tool displays a warning. You must correct all the errors before you can generate any segments. See Creating a Template for more information. When all of the errors have been resolved, click New again.

If there were no errors, the Generate Document dialog box opens, as shown in the figure. This dialog box enables you to select all or some of the template segments and enter values for the parameters to be used when generating the document.

The Generate Document dialog box contains two tables:
a.
Parameter Name—Displays the current parameter values. If you assigned initial values to the parameters in the template, these values are displayed in the Parameter Value column. If you change these values, the new values are stored and displayed prior to any regeneration of the document segments. (For more information, see Regenerating Document Segments.)
b.
Segment Name—Lists the document segments, all of which will be generated by default (see the Yes value in the Gen column). If you do not want to generate a specific segment, click on the Yes next to that segment and the field changes to No.

By default, the view is collapsed so the segment information is not displayed. Click Expand to expand the view.

Regardless of the template segments that you select for execution, the initiation section of the template is always executed. See Overview of Documentor for an explanation of template segments.

5.
6.
Click OK to apply your changes and dismiss the dialog box.

The tool generates the segments and the new document name is included in the list in the Document Management dialog box.

 
Generate Document Dialog Box (shown expanded)