The searchtitle element is used to specify a title that is displayed by search tools that locate the topic. This is most useful when the topic has a title that makes sense in the context of a single information set, but might be too general in a list of search results; for example, a topic title of "Markup example" might make sense as part of a guide to DITA, but when found among thousands of unrelated topics, a search title of "DITA markup example" is more useful.
Content models
See appendix for information about this element in OASIS document type shells.
Inheritance
"- topic/searchtitle " when used in topics, and "- map/searchtitle " when used in maps.
Example
In the following example, the general title "Programming Example" is likely very useful in a set of information about XSLT basics; however, the same title is not helpful among a set of search results from the entire internet. In that case, "Example of basic programming in XSLT" will be much more helpful.
<task id="progexample">
<title>Programming Example</title>
<titlealts><searchtitle>Example of basic
programming in XSLT</searchtitle></titlealts>
<taskbody> . . . </taskbody>
</task>
<topicref href="progexample.dita">
<topicmeta>
<navtitle>Programming example</navtitle>
<searchtitle>Example of programming in XSLT</searchtitle>
</topicmeta>
</topicref>
Attributes
The following attributes are available on this element: Universal attribute group and outputclass.