searchtitle

When your DITA topic is transformed to XHTML, the <searchtitle> element is used to create a title element at the top of the resulting HTML file. This title is normally used in search result summaries by some search engines, such as that in Eclipse (http://eclipse.org); if not set, the XHTML's title element defaults to the source topic's title content (which may not be as well optimized for search summaries)

Example

<task id="progexample">
 <title>Programming Example</title>
  <titlealts><searchtitle>Example of Required Programming</searchtitle></titlealts>
 <taskbody> . . . </taskbody>
</task>

Contains

Doctype Content model
ditabase, topic, task, reference, concept ( text data or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or term or data or data-about or foreign or unknown) (any number)
map, bookmap ( text data or keyword or term or data or data-about or foreign or unknown) (any number)

Contained by

Doctype Parents
ditabase, topic, task, concept, reference titlealts
bookmap topicmeta, bookmeta
map topicmeta

Inheritance:

"- topic/searchtitle " when used in topics, and "- map/searchtitle " when used in maps.

Attributes

Name Description Data Type Default Value Required?
%univ-atts; (%select-atts;, %id-atts;, %localization-atts;) A set of related attributes, described at %univ-atts; parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass Common attributes described in Other common DITA attributes