<uicontrol>

The <uicontrol> element is used to mark up user interface controls, such as names of buttons, entry fields, menu items, or other objects that allow the user to control the interface. Use the <uicontrol> element inside a <menucascade> element to identify a sequence of menu choices in a nested menu, such as File > New. This element is part of the DITA user interface domain, a special set of DITA elements designed to document user interface tasks, concepts and reference information.

Content models

See appendix for information about this element in OASIS document type shells.

Inheritance

+ topic/ph ui-d/uicontrol

Example

This section is non-normative.

<p>Press the <uicontrol>OK</uicontrol> button.</p>

Content model

(Text | <data> | <data-about> | <foreign> | <unknown> | <keyword> | <term> | <text> | <image> | <shortcut>)*

Contained by

<menucascade>

Zero or more of the following
  • Text
  • <data>
  • <data-about>
  • <foreign>
  • <image>
  • <keyword>
  • <shortcut>
  • <term>
  • <text>
  • <unknown>

Contained by

  • <menucascade>

Inheritance

+ topic/ph ui-d/uicontrol

The <uicontrol> element is specialized from <ph>. It is defined in the ui-domain module.

Attributes

The following attributes are available on this element: Universal attribute group, outputclass, and @keyref.