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

26
i s f m c h a r
Details
•
For SGML, instead of using this rule to translate an SDATA entity, you can use a
parameter literal of a particular form. For information on how to do so, see "Translating
SDATA entities as special characters in FrameMaker" on page 260.
•
For XML, SDATA entities are not allowed. This rule translates internal entities to
FrameMaker characters, and it translates FrameMaker to internal entities.
• You can use the is fm char rule within an entity rule at the highest level to have
the translation occur in both directions. Or you can put the entity rule inside a reader
rule to have the translation occur only when reading a markup document into
FrameMaker. For example, your SGML document might use a period entity for entering
some instances of the period character in your SGML document. If you use this rule:
entity "period" is fm char ".";
then the entity references for period in the instance are translated correctly to the period
character in FrameMaker. But on export, all periods in the document become references
to the period entity (which is not likely what you had in mind). To have the period
entities read correctly when importing an instance, but have periods remain the period
character on export, use this version of the rule:
reader
•
Without the in clause, the software translates the entity using the default character
format of the enclosing paragraph element. Frequently, however, special characters
require a font change. In these cases, you use the in clause.
•
For SGML, DTDs frequently use the entity sets defined in Annex D of the SGML
Standard, often called ISO public entity sets, for providing commonly used special
characters. FrameMaker includes copies of these entity sets and provides rules to handle
them for your application. For information on how FrameMaker supports ISO public
entities, see Appendix F, "ISO Public Entities."
Examples
• To translate the SDATA entity sum as the mathematical summation sign in the Symbol
font ( Σ ), you could use either of these rules in your rules document:
entity "sum" is fm char "S" in "Symbol";
entity "sum" is fm char "\x53" in "Symbol";
entity "sum" is fm char 0x53 in "Symbol";
If FrameMaker encounters a reference to the summation entity when importing a
markup document, it replaces the reference with Σ (assuming your FrameMaker template
defines the Symbol character format appropriately and the entity is declared in the DTD).
If the software encounters Σ when exporting an document, it generates a reference to
the summation entity (assuming the Symbol character format is defined appropriately
Structure Application Developer's Guide
entity "period" is fm char ".";
417