<screen>

The <screen> element contains or refers to a textual representation of a computer screen or user interface panel (window).

Use <screen> to contain representations of text-based online panels, text consoles ("term" or "curses" windows, for example), or other text-based user interface components. The default print representation is to enclose the screen within a box, suggesting a computer display screen. In contrast to graphical screen captures normally used to represent GUI parts (see the <image> element description), this element specifically supports constructions for which text is the primary content.

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/pre ui-d/screen

Example

Using the <screen> element to represent a DOS edit session

<p>Type "edit" after the command line prompt and press Enter.  The following
editing interface will be displayed.</p>
<screen>
   File  Edit  Search  View  Options  Help
+--------------------------------- UNTITLED1 ----------------------------------+
¦                                                                              ¦
¦                                                                              ¦
¦                                                                              ¦
¦                                                                              ¦
¦  Line:1    Col:1  F1=Help                                                    ¦
+------------------------------------------------------------------------------+
</screen>

Potential result from an rendering process

Type "edit" after the command line prompt and press Enter. The following editing interface will be displayed.

   File  Edit  Search  View  Options  Help
+--------------------------------- UNTITLED1 ----------------------------------+
¦                                                                              ¦
¦                                                                              ¦
¦                                                                              ¦
¦                                                                              ¦
¦  Line:1    Col:1  F1=Help                                                    ¦
+------------------------------------------------------------------------------+

Attributes

The following attributes are available on this element: Universal attribute group, Display attribute group, @outputclass, @xml:space, and @spectitle.

Was this helpful?