<preformat> Preformatted Text
Text in which spaces, tabs, and line feeds must be preserved. Content is typically displayed in monofont to preserve character alignment.
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.
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, 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 preformatted material is typically placed elsewhere such as in a separate window or at the end of the document.
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 the fact that they were set in a math font.
When Content is a Form
The @is-form attribute can be used to indicate that the preformatted text contains/is a form. What constitutes a “form” is not defined by NISO STS.
orientation (default = portrait)
position (default = float)
Miscellaneous non-JATS-specific Attributes
xml:space (fixed value = preserve)
Models and Context
May be contained in
<ack>, <alternatives>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <chem-struct>, <chem-struct-wrap>, <disp-formula>, <disp-quote>, <fig>, <glossary>, <index>, <index-div>, <index-group>, <license-p>, <named-content>, <non-normative-example>, <non-normative-note>, <normative-example>, <normative-note>, <notes>, <p>, <ref-list>, <sec>, <see>, <see-also>, <see-also-entry>, <see-entry>, <styled-content>, <supplementary-material>, <table-wrap>, <tbx:crossReference>, <tbx:definition>, <tbx:entailedTerm>, <tbx:example>, <tbx:externalCrossReference>, <tbx:note>, <tbx:pronunciation>, <tbx:see>, <tbx:source>, <tbx:term>, <tbx:usageNote>, <td>, <term>, <term-display>, <term-sec>, <th>
Any combination of:
- Text, numbers, or special characters
- Accessibility Elements
- External Linking Elements
- Citation Elements
- Ownership Elements
- Emphasis Elements
- Inline Display Elements
- Other Inline Elements
- <fn> Footnote
- <target> Target of an Internal Link
- <tbx:entailedTerm> Entailed Term (TBX)
- <xref> X(cross) Reference
- Baseline Change Elements
ASCII representation of a diagram
... <fig id="fig1"> <caption> <title>Security Gateway to Security Gateway Tunnel</title> </caption> <preformat><![CDATA[ +-+-+-+-+-+ +-+-+-+-+-+ | | IPsec | | Protected |Tunnel | tunnel |Tunnel | Protected Subnet <-->|Endpoint |<---------->|Endpoint |<--> Subnet | | | | +-+-+-+-+-+ +-+-+-+-+-+ ]]></preformat> </fig> ...