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)
( text data or keyword or option or parmname or apiname or cmdname or msgnum or varname or wintitle or term) (any number)
Name | Description | Data Type | Default Value | Required? |
---|---|---|---|---|
%id-atts; (id, conref) | A set of related attributes, described at %id-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 | A common attribute described in Other common DITA attributes |
<task id="progexample"> <title>Programming Example</title> <titlealts><searchtitle>Example of Required Programming</searchtitle></titlealts> <taskbody> . . . </taskbody> </task>
OASIS DITA Language Specification v1.0 -- 09 May 2005
Copyright (c) OASIS Open 2005. All Rights Reserved.