Table of Contents
Advertisement
11
U s i n g U n i q u e I D a n d I D R e f e r e n c e a t t r i b u t e s
Para (using the Attributes dialog box). He or she can go to the source from the Para later
by searching for the element with the ID.
SGML: When importing and exporting between FrameMaker and SGML, the
UniqueID and IDReference attributes are preserved. UniqueID attributes in
FrameMaker translate to ID attributes in SGML, and IDReference attributes
translate to IDREF attributes. For more information, see Chapter 20, "Translating
Cross-References."
UniqueID attributes
You can assign a UniqueID attribute to any element in FrameMaker. If you plan to use the
element as a source for cross-references, the element will likely be a chapter, section, table,
or figure. An element can have only one UniqueID attribute.
In the attribute definition, insert a UniqueID element after the name. For example:
Element (Container): Section
General rule: <TEXT>
Attribute list
The value in an instance of a UniqueID attribute must be unique for this attribute type in
a document or book. Even if a document has two different elements (such as Section and
Chapter) that have a UniqueID attribute, you cannot have any duplication of ID values.
It is possible for a document to end up with IDs that are not unique—for example, if the end
user shows hidden text that contains an element with a conflicting ID, or if you change an
attribute type to UniqueID and instances of the attribute already have duplicate values.
FrameMaker identifies duplicate IDs as invalid.
An end user can provide ID values, or FrameMaker can generate the values. Each method
has its advantages:
•
If a user provides the IDs, he or she can use values that are meaningful (whereas an ID
that FrameMaker generates is a random string). This can make it much easier to
remember IDs and to recognize them in the Cross-Reference dialog box and the
Structure View.
•
If FrameMaker generates the IDs, the IDs are virtually guaranteed to be unique within a
document or book, and they will remain unique because a user cannot edit them. The
IDs that FrameMaker generates also conform to the SGML reference concrete syntax.
Although UniqueID attributes are often used in sources for cross-references, an element
with this attribute is not required to have a reference to it.
When an end user provides an ID
An end user can provide an ID value of up to 255 characters in the Attributes dialog box or
in some cases by pasting (unless the attribute is read-only). FrameMaker tries to ensure
Attribute Definitions
1. Name: ID
UniqueID
Optional
Read-only
178
Advertisement
Table of Contents
