<description> element

Appears in: many

A description may be attached to a many different elements. Descriptions are used by an intelligent IDE to provide help. The Tapestry Inspector may also display a description.

[Note]Note

The DTD supports multiple <description> elements, each localized to a different language. In practice, a single description, in English, is typically used. This approach to providing a localized description is likely to change in the future, and it is probably safest to expect just a single <description> tag to be allowed in the next revision of the DTD.

The descriptive text appears inside the <description> tags. Leading and trailing whitespace is removed and interior whitespace may be altered or removed. Descriptions should be short; external documentation can provide greater details.

Figure B.13. <description> element

NameTypeRequired ?Default ValueDescription
xml:langstringno The language the message is localized to as an ISO language string.