Adobe 65030365 - FrameMaker - PC Developer's Manual page 274

17
D e f a u l t t r a n s l a t i o n
PI entities
XML: The XML specification does not support PI entities—the following information
pertains to SGML, only.
PI entities are processing instructions in the form of entities. They are a convenient way of
providing one level of indirection, allowing the user to change the processing instructions in
one place if the document is moved to a different system. In addition, using a PI entity
allows the processing instruction to contain the PIC delimiter (> in the reference concrete
syntax). The following is an example of a PI entity:
<!ENTITY break PI "MYSYS: pgbrk">
Unless PI entities correspond to one of the forms supported by FrameMaker (to represent
books and book components), FrameMaker stores them in markers of
type SGML Entity Reference by default. In the above example, the marker text would
be:
break
Processing instructions
XML and SGML: The XML specification defines the PI closing delimiter as ?>,
while in SGML the closing delimiter is >. This section uses the XML specification to
illustrate PI syntax.
As stated at the beginning of this chapter, processing instructions in XML or SGML provide
a way to perform system-specific actions on a markup document. By default, FrameMaker
recognizes a small set of processing instructions. Those it does not recognize in a
document instance it stores in a marker of type DOC PI. (You can change the marker type
used for this purpose with a rule.) For example, if your document instance contains this
processing instruction:
<?mypi?>
then FrameMaker creates a DOC PI marker with this marker text:
mypi
In addition to processing instructions for books, book components, and conditional text,
FrameMaker recognizes another processing instruction format it uses to create non-element
markers. For example, if your document instance contains this processing instruction:
<?FM MARKER [MyMarkerType] Some marker text here?>
then FrameMaker creates a MyMarkerType marker with this marker text:
Some marker text here
You can use a read/write rule to drop processing instructions on import or to specify a
different marker type to store this information.
Translating Entities and Processing Instructions 256