#include Directive

Used to include the contents of another file inside the current one.

Syntax:

where "path/to/file.yuma" is a path to a Yuma or HTML file, relative to one of the include directories.

Paths must be separated by the forward-slash, regardless of what platform the Yuma engine is running on. Also, note that use of "." and ".." to indicate the current or parent directory is not allowed.

Include directories are searched in order, starting with the directory containing the file with the #include directive, and then proceeding to check any include directories specified in the Yuma configuration settings.

When a matching file is found, its contents are inserted into the file containing the directive, replacing the #include line. However, the context of the inserted data is HTML, rather than Yuma code. This means that include files containing Yuma code must begin with "<?yuma" and end with "?>". However, it also means that you can include HTML or plain text without needing any special Yuma-related markup in the included file.

Any particular file is included only once; subsequent #include lines specifying the same file have no effect. This means that utility files can safely include whatever other utility files they need, without having to worry about multiple-definition errors. This is similar to PHP's "require_once" command.