◇◆
<preformat> Preformatted Text
Text in which spaces, tabs, and line feeds must be preserved. Content is typically
displayed in monofont to preserve character alignment.
Usage/Remarks
The <preformat> element is typically used for machine-related communication such as ASCII art and
error
message reports, in which whitespace such as tabs, line feeds, and spaces should be
preserved.
Position
The @position attribute may be used to indicate whether this element must be anchored at its exact
location within the text, or whether it may float (for example, to the top of the
next page, into the next column, to the end of a logical file, or within a separate
window). For the typical <preformat> element, the “float or anchor” decision will be governed by the size of the
object. For example, short preformat fragments are typically anchored whereas longer
preformats are typically placed elsewhere such as in a separate window or at the end
of the document.
Equations
The MathML elements to describe equations are not permitted within <preformat>. If equations are encountered within computer code, they
can be tagged using the element <named-content> to
preserve the fact that they were equations or the element <styled-content> to preserve that fact that they were set in a math font.
Attributes
orientation (default = portrait)
position (default = float)
Multi-lang Attributes
Miscellaneous non-JATS-specific Attributes
xml:space (fixed value = preserve)
Models and Context
May be contained in
Description
Any combination of:
- Text, numbers, or special characters
- Accessibility Elements
- Linking Elements
- Ownership Elements
- Emphasis Elements
- Other Inline Elements
- Baseline Change Elements
Content Model
<!ELEMENT preformat %preformat-model; >
Expanded Content Model
(#PCDATA | alt-text | long-desc | email | ext-link | uri | attrib | permissions | bold | fixed-case | italic | monospace | overline | roman | sans-serif | sc | strike | underline | ruby | abbrev | index-term | index-term-range-end | named-content | styled-content | sub | sup)*
Tagged Samples
Error message
...
<preformat preformat-type="dialog" xml:space="preserve"
position="anchor">
C:\users\lap make
'make' is not recognized as:
- an internal or external command
- an operable program
- a batch file
</preformat>
...
Poem
...
<preformat preformat-type="poem">
it’s
spring
and
the
goat-footed
balloonMan whistles
far
and
wee
</preformat>
...
Transcription
...
<preformat preformat-type="transcription">
00 A: so, my [opinion is that]
00 B: [you're not letting [me
00 C: [but
A: first of all ]
B: finish] speaking]
C: really ]
00 A: that is not true at all
</preformat>
...
Related Resources
- See: Accessibility