Book Interchange Tag Suite (BITS) Version 1.0 Tag Library Version 1.0

<preformat>

Preformatted Text

Text in which spaces, tabs, and line feeds must be preserved. Content is typically displayed in monofont to preserve character alignment.

Remarks

The <preformat> element is typically used for machine-related communication such as man-machine dialogs and error messages with descriptions, 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, 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 fragments are typically anchored whereas longer preformats such as ASCII art are typically placed elsewhere such as in a separate window or at the end of the document.

Attributes

id Document Internal Identifier
orientation Orientation
position Position
preformat-type Type of Preformatted Text
specific-use Specific Use
xml:base Base
xml:lang Language
xml:space Space

Related Elements

Best Practice: Although poetry may be tagged with the <preformat> element if spacing is critical, this element is not intended for poetry. Poetry and verse should usually be tagged with the <verse-group> element, which may not preserve the exact indentation, but is likely to be displayed in a proportional font. Similarly, this element is not intended for equations and math.

Content Model

<!ELEMENT  preformat    %preformat-model;                            >

Expanded Content Model

(#PCDATA | alt-text | long-desc | email | ext-link | uri | inline-supplementary-material | related-article | related-object | hr | bold | fixed-case | italic | monospace | overline | overline-start | overline-end | roman | sans-serif | sc | strike | underline | underline-start | underline-end | ruby | alternatives | inline-graphic | private-char | chem-struct | inline-formula | tex-math | mml:math | abbrev | index-term | index-term-range-end | milestone-end | milestone-start | named-content | styled-content | fn | target | xref | sub | sup | x | attrib | permissions)*

Description

Any combination of:

This element may be contained in:

<abstract>, <ack>, <alternatives>, <answer>, <app>, <app-group>, <bio>, <body>, <boxed-text>, <chem-struct>, <chem-struct-wrap>, <disp-formula>, <disp-quote>, <fig>, <floats-group>, <glossary>, <index>, <index-div>, <index-group>, <license-p>, <named-book-part-body>, <named-content>, <notes>, <p>, <question>, <ref-list>, <sec>, <see>, <see-also>, <see-also-entry>, <see-entry>, <styled-content>, <supplementary-material>, <table-wrap>, <td>, <term>, <th>, <toc>, <toc-div>, <toc-entry>, <toc-group>, <trans-abstract>

Example 1

    
...
<body>
<disp-quote>
<preformat>... who would fardels bear,
To grunt and sweat under a weary life,
But that the dread of something after death,
The undiscover&rsquo;d country from whose bourn
No traveller returns, puzzles the will
And makes us rather bear those ills we have
Than fly to others that we know not of?</preformat>
<attrib>William Shakespeare, Hamlet, Act III,
Scene IV</attrib>
</disp-quote>
<p>Shakespeare well understood the underpinning of
our society&rsquo;s tenacious need to cling to life:
the fear of death, the fear of the unknown.  Yes, we
acknowledge death is part of nature&rsquo;s cycle,
but even as we do so, we struggle ...</p>
<sec>...</sec>
</body>
...

Example 2

    
...
<list list-type="bullet">
...
<list-item id="bid.101">
<p>Each 3D Domain identified in an MMDB record is
assigned a unique integer identifier that is appended to 
the Accession number of the chain to which it belongs 
(e.g., 1B8G A 2). This new Accession number becomes 
its identifier in Entrez 3D Domains. New 3D Domain 
identifiers are assigned whenever a new MMDB-ID is 
assigned.</p>
</list-item>
<list-item id="bid.102">
<p>For conserved domains, the Accession number is
based on the source database:
<preformat>
    Pfam:          pfam00049
    SMART:         smart00078
    LOAD:          LOAD Toprim
    CD:            cd00101
    COG:           COG5641
</preformat>
</p>
</list-item>
</list>
...

Example 3

    
...  
<p>Trees, of course, are hardly a random choice for our
methodology. ... Hierarchical trees have been understood as a
way of viewing document structures since the earliest days of
SGML development. Our initial tree structure was very simple:
<preformat>
&lt;!ELEMENT  implications  (tree+) &gt;
&lt;!ELEMENT  tree          (root, branches) &gt;
&lt;!ELEMENT  root          (term, synonym?) &gt;
&lt;!ELEMENT  branches      (term | (term, synonym) | tree)* &gt;
</preformat>
Terms are the literal strings for which the Ferret engine searches; they
are the most specific expressions to be found in real documents of the
concepts on which classifications rules act.</p>  
...

Example 4

    
...  
<p>As you can see in the following excerpt, use of literal
result elements is very convenient:
<preformat>
&lt;xsl:template match="div/divhead" priority="2"&gt;
  &lt;<named-content content-type="literal result">h2</named-content>&gt;
    &lt;xsl:apply-templates/&gt;
  &lt;<named-content content-type="literal result">/h2</named-content>&gt;
&lt;/xsl:template&gt;
</preformat>
</p>
...

Book Interchange Tag Suite (BITS) Version 1.0 Tag Library Version 1.0

Version of December 2013