<titlehint>
A title hint provides information to map authors about the title of the referenced resource. This is useful if the referenced resources are not available.
Usage information
The <titlehint> element is a convenience
element. It is equivalent to a <titlealt>
element with @title-role set to
hint.
Processing expectations
Processing expectations are dictated by the rules for the
<titlealt> element.
Specialization hierarchy
The <titlehint> element is specialized from
<titlealt>. It is defined in the
alternative-titles domain module.
Content model
(Text |
<data>
|
<sort-as>
|
<foreign>
|
<keyword>
|
<term>
|
<text>
|
<ph>
|
<strong>
|
<em>
|
<b>
|
<i>
|
<line-through>
|
<overline>
|
<sup>
|
<sub>
|
<tt>
|
<u>
|
<draft-comment>
|
<required-cleanup>
)*
Attributes
The following attributes are available on this element: universal
attributes and @title-role.
For this element, @title-role has a default value of
hint.
The following attributes are available on this element: universal attributes and the attributes defined below.
@title-role(REQUIRED)- Specifies the role that the alternative title serves.
Multiple roles are separated by white space. The following
roles are defined in the specification:
linking, navigation,
search, subtitle, and
hint.
Processors can define custom values for the
@title-roleattribute.
Example
This section is non-normative.
The following code sample shows how a
<titlehint> element is used to show the
title of a referenced topic to map authors. This might be
especially helpful in the context of a CCMS with opaque URIs.
<topicref href="x-id://AOE82KJAW1B0">
<topicmeta>
<titlehint>Getting started</titlehint>
</topicmeta>
</topicref>