Table of Contents
Advertisement
14
C o m m e n t s
Comments
Comments can appear anywhere in a rules document where white space is permitted,
except within quoted strings. Comments, like those in C code, are surrounded by the
delimiters /* and */. Tables, graphics, and equations can appear within comments but are
erroneous elsewhere in a rules document.
Include files
You can use the C notation for include files in a rules document. For example, assume you
have the following line in a paragraph by itself in a rules document:
#include "fname"
FrameMaker processes the file named fname as though its contents were inserted in place
of the include directive. The syntax of the filename is device-dependent.
You can specify a search path for include files in the structapps.fm file. The default
search path for an include file consists of the directory containing the original rules
document and the directory $STRUCTDIR/isoents/, where $STRUCTDIR is as defined in
"Location of structure files" on page 49. In addition, these directories are added to the end
of the search path you specify in structapps.fm.
If you plan to use the same rules on different systems, avoid specifying directory names in
the #include directive. Instead, let FrameMaker find files in different directories through a
search path.
Important: File paths must be specified in the syntax that is native to the platform
on which you are running FrameMaker. Also, for Windows platforms, pathname
tokens are separated by a backslash character ("\"). When specifying a Windows
path, you must escape the backslash character. For example, the following specify
the same location on Unix, Macintosh, and Windows platforms:
•
Unix
$STRUCTDIR/isoents
•
Macintosh
$STRUCTDIR:isoents
•
Windows
$STRUCTDIR\\isoents
For information on working with the structapps.fm file, see "Application definition file" on
page 50.
Reserved element names
You may use any legal name for an XML or SGML element. If there are no rules to the
contrary, FrameMaker assumes most markup elements correspond to FrameMaker
elements. The following generic identifiers are used by the default declarations for
Read/Write Rules and Their Syntax
214
Advertisement
Table of Contents
