<screen>
The <screen>
element contains a textual representation of a
terminal console or other text-based computer interface.
Rendering expectations
Processors SHOULD preserve the
line breaks and spaces that are present in the content of a
<screen>
element.
The contents of the <screen>
element is typically enclosed within a box to suggest a computer
display screen. It also is typically rendered in a monospaced
font.
Specialization hierarchy
The <screen>
element is specialized from
<pre>
. It is defined in the user-interface domain module.
Content model
(Text | <cite>
| <include>
| <keyword>
| <ph>
| <q>
| <term>
| <text>
| <xref>
| <data>
| <foreign>
| <draft-comment>
| <fn>
| <indexterm>
| <required-cleanup>
)*
Not contained by any element.
- Text
<cite>
<data>
<draft-comment>
<fn>
<foreign>
<include>
<indexterm>
<keyword>
<ph>
<q>
<required-cleanup>
<term>
<text>
<xref>
Not contained by any element.
Inheritance
+ topic/pre ui-d/screen
The <screen>
element is specialized from <pre>
. It is defined in the ui-domain module.
Attributes
The following attributes are available on this element: display
attributes, universal
attributes, and @xml:space
.
The following attributes are available on this element: universal attributes and the attributes defined below.
@expanse
(display attributes)- Specifies the horizontal placement of the element. The
following values are valid:
- column
- Indicates that the element is aligned with the current column margin.
- page
- Indicates that the element is placed on the left page margin for left-to-right presentation or the right page margin for right-to-left presentation.
- spread
- Indicates that the object is rendered across a multi-page spread. If the output format does not have anything that corresponds to spreads, then spread has the same meaning as page.
- textline
- Indicates that the element is aligned with the left (for left-to-right presentation) or right (for right-to-left presentation) margin of the current text line and takes indentation into account.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
For
<table>
, in place of the@expanse
attribute that is used by other DITA elements, the@pgwide
attribute is used in order to conform to the OASIS Exchange Table Model.Some processors or output formats might not support all values.
@frame
(display attributes)- Specifies which portion of a border surrounds the element.
The following values are valid:
- all
- Indicates that a line is rendered at the top, bottom, left, and right of the containing element.
- bottom
- Indicates that a line is rendered at the bottom of the containing element.
- none
- Indicates that no lines are rendered.
- sides
- Indicates that a line is rendered at the left and right of the containing element.
- top
- Indicates that a line is rendered at the top of the containing element.
- topbot
- Indicates that a line is rendered at the top and bottom of the containing element.
- -dita-use-conref-target
- See Using the -dita-use-conref-target value for more information.
Some processors or output formats might not support all values.
@scale
(display attributes)- Specifies the percentage by which fonts are resized in
relation to the normal text size. The value of this attribute
is a positive integer. When used on
<table>
or<simpletable>
, the following values are valid: 50, 60, 70, 80, 90, 100, 110, 120, 140, 160, 180, 200, and -dita-use-conref-target.This attribute is primarily useful for print-oriented display. Some processors might not support all values.
If the
@scale
attribute is specified on an element that contains an image, the image is not scaled. The image is scaled only if a scaling property is explicitly specified for the<image>
element. @xml:space
- Specifies how to handle white space in the
current element. This attribute is provided
on
<pre>
,<lines>
, and on elements specialized from those. It ensures that parsers respect white space that is part of the data in those elements, including line-end characters. When defined, it has a fixed value of preserve, making it a default property of the element that cannot be changed or deleted by authors.
Example
This section is non-normative.
In the following code sample, the <screen>
element is used to illustrate the steps needed to clone a git repository and check
status:
<screen>
workspace $ git clone git@example.com:oasis-tcs/dita-techcomm.git
Cloning into 'dita-techcomm'...
remote: Enumerating objects: 1023, done.
remote: Counting objects: 100% (31/31), done.
remote: Compressing objects: 100% (23/23), done.
remote: Total 1023 (delta 6), reused 21 (delta 4), pack-reused 992
Receiving objects: 100% (1023/1023), 9.87 MiB | 729.00 KiB/s, done.
Resolving deltas: 100% (367/367), done.
workspace $ cd dita-techcomm
dita-techcomm $ git status
On branch main
Your branch is up to date with 'origin/main'.
nothing to commit, working tree clean
dita-techcomm $
</screen>