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)


Contents

[edit] Example 

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

 <taskbody> . . . </taskbody>
</task>

[edit] 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)

[edit] Contained by

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

[edit] Inheritance:

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


[edit] 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      

TOC: Language Specification 1.1
Parent topic: Topic elements
Previous topic: navtitle
Next topic: abstract

Retrieved from "http://www.ditawiki.org/index.php/Searchtitle"

This page has been accessed 1,319 times. This page was last modified 21:38, 11 July 2007.





This page
Discuss this page
Post a comment
Printable version
My pages
Log in / create account