Overview of Documentor : Designing a Document Using Templates : Include Files

Include Files

You can include files outside of your project database within your documents. In the template example, the introductory sys_overview section is not part of the database, but is an external file. You can create such files while you work with the Documentor, or you can copy them from outside your workarea. In the example, this file is assumed to already be in the workarea. Therefore, the file path is not specified—only the file name. The file is accessed via the INCLUDE statement within the template and inserted in the segment files when the template is executed.

The same include files can be used in a number of different documents, and can be called from a number of different templates.

The figure illustrates the relationship between templates, include files, and parameters, and the segments that are produced after the templates are executed. Template A contains parameters and is generated twice—once using set 1 of the parameter values and once using set 2.

Using the first set of parameter values, the segments of document A1 are generated. In addition, template A contains a statement calling an external include file, F1, into the generated document segments of A1.

When the second set of parameters is used, the segments of document A2 are generated. Again, the include file F1 is included in the output segments.

Template B is used to generate the segments of document B1. These segments contain two include files: F1, which was also included in the segments of document A1, and a separate include file, F2.