WinANT Help

 

About Include Files

This topic describes the structure of include files, which nominate supplementary files to be included in an Ant build.

Include file is a WinANT term meaning a text file containing a list of supplementary, supporting files that need to be copied to the output folder during the transformation of DITA content into an HTML-based reading format. The same term is also used in the context of Microsoft HTML Help authoring, where its meaning is supplemtary, supporting files to be compiled into the CHM file along with normal content files.

The include file is a simple text file, with the name of required files listed one per line, as in the following example:

d:\apps\WinANT\bin\resource\images\tactics_01.jpg
d:\apps\WinANT\bin\resource\hwcs.h
note_image.png

The file paths nominated in the include file can be relative addresses or absolute addresses. Relative addresses are relative to the WinANT resources folder (typically [program files]\HyperWrite\WinANT\resource\).

In addition to the user-nominated support files, some supplementary files are needed for WinANT functionality (such as an XSL-T file used to format the log file). These files are nominated in the winant_support.inc text file in the resource folder, but you must not modify this system include file.

Before WinANT invokes Ant, the system copies the files listed in the include file (and in the system include file) to the output folder. For HTML Help output, it also adds the name of the include file to the HHP project file.

When you might need to supplementary, supporting files

The CSS file that you have created to be attached to your HTML output topics refers to an image file to be used as a background for the body of the topic. While Ant is aware of the need for the CSS file (because it is nominated in the build file), it is not aware that the CSS references a supplementary image file. (Ant doesn't parse or interrogate the CSS file looking for references.) You must therefore manually nominate that the supporting image file should be copied to the output. This is done by creating an include file, and adding a line to the include file specifying the location of the image.