include file-name

Argument definitions

A quoted string containing a system-specific filename.


Includes a source file in the current program by using an include declaration. The content of the included file is processed as if it appeared in place of the include declaration.

An include declaration can appear anywhere in an OmniMark program. Files inserted by include declarations can contain include declarations -- the maximum nesting depth is 100. An included file, however, must not include itself. Use include-guard to prevent any file being included twice.

An include declaration ends any rule that appears before it. Similarly, if a rule's definition starts inside an included file, the definition ends with the end of the included file.

Rules and declarations in an include file are only allowed if they are permitted where the include declaration occurs. For example, an escape declaration can only appear in an include file if the include declaration occurs at the start of a program.