◇◆

<table-wrap> Table Wrapper

Wrapper element for a complete table, including the tabular material (rows and columns), caption (including title), footnotes, and alternative descriptions of the table for purposes of accessibility.

Usage/Remarks

This element has been designed to capture a construct named “table”, whether that structure contains an explicit <table> element or contains non-tabular structures such as graphics, lists, or equations. Many publishers associate table captions and table numbers with material that is not explicitly tabular. Within the <table-wrap> element, row and column tags that describe the table cells should be defined by either the <table> element of the NISO JATS table model (based on and designed to be converted easily to the XHTML 1.1 table model) or, less typically, by the OASIS XML Exchange (CALS) table model.
Design Note
Many journal Tag Sets use an element called “Table Footnote” (with a tag such as <tblfn>) for footnotes inside a table. This Tag Set uses <fn> inside tables, as well as everywhere else, relying instead on context to differentiate table footnotes. Footnotes inside a <table-wrap> are assumed to be footnotes to the table and, as part of the table, are displayed at the bottom of the table, usually as part of the <table-wrap-foot>, rather than at the bottom of the page or otherwise separated from the display of the table.
Position
The @position attribute may be used to indicate whether a <table-wrap> 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).
Associating Data with a Table
It is possible to make links to the data behind a table. For example, a summary table aggregating three data sets could point to the datasets it summarized.
If the data resides in the article, use an internal cross-reference (<xref>) to point to the data. If the data is external to the article, for example, in a data repository (more typical), make an external connection using one or more <ext-link> elements within the table tagging. The data behind a table may be integral or supplementary.
Each <table-wrap> within a <table-wrap-group> may make its own external connections using one or more <ext-link> elements within the <table-wrap>s and/or the group as a whole may use the <table-wrap-group> <ext-link>s within the group. The <ext-link> element may be used directly within:
Note that a table and its multiple supporting data objects are described in one table with multiple links, rather than as a table group (<table-wrap-group>) even if the associated data objects are themselves tables.
Multi-language Figure/Tables
JATS provides several ways to tag tables, figures, etc. in multiple languages. The element <block-alternatives> can be used to hold two or more versions of the table or figure, each in a different language. It is also possible to place multiple <label> and <caption> elements inside a single figure or table, one label and caption for each language, differentiated by @xml:lang attributes. In the case of double labels and captions, the content of the table wrap is not repeated, only the labels and captions.
NISO JATS Table Processing Note
In building the NISO JATS table model from the XHTML model, the <caption> element was removed from within the <table> element, because, in the NISO JATS Tag Suite, the <caption> element has been made part of the <table-wrap> element.
Related Elements
The <table> element is an element defined by the NISO JATS table model, which is based on and designed to be converted easily to the XHTML 1.1 table model. This element is not, in itself, a full table, but only the rows and columns portions of a table. A full table may have other features, such as a title, caption, table footnotes, etc. The <table-wrap> element contains the full table, that is, both rows and columns as well as captions and footers. A full table (<table-wrap>) may or may not include an actual <table> element within it, since other constructions, such as 2-part lists, may also be given table titles, captions, etc.
OASIS CALS Table Note: The OASIS XML Exchange (CALS) table model has also been included in the NISO JATS Suite and may be used as an alternative table model. It is even possible, though not easy, to include two different table models in a JATS-based DTD, by using a pseudo-namespace with a fixed prefix to differentiate any name clashes. The XHTML-based table model is usually taken as primary (no namespace prefix) and the OASIS XML Exchange (CALS) table model set up to use a pseudo-namespace (prefix “oasis”) with an xmlns #FIXED attribute. For organizations that choose to use the OASIS table model instead of the more XHTML-like NISO JATS table model, a version of the Archiving DTD has been provided with the OASIS table model (JATS-archive-oasis-article1-4.dtd). A separate Tag Library describing the OASIS table model elements, attributes, and parameter entities may be accessed at: https://jats.nlm.nih.gov/options/OASIS/tag-library/19990315/index.html
Attributes
content-type
orientation (default = portrait)
position (default = float)
specific-use
supplemental

Multi-lang Attributes

lang-focus
lang-focus-custom
lang-group
lang-source
lang-source-custom
lang-translate
lang-variant
lang-variant-custom

Base Attributes

id
xml:base
xml:lang
Models and Context
May be contained in
<abstract>, <ack>, <answer>, <app>, <app-group>, <bio>, <block-alternatives>, <body>, <boxed-text>, <disp-quote>, <explanation>, <fig>, <floats-group>, <glossary>, <legend>, <license-p>, <named-content>, <notes>, <option>, <p>, <question>, <question-preamble>, <ref-list>, <sec>, <styled-content>, <supplementary-material>, <table-wrap-group>, <trans-abstract>
Description
The following, in order:
Content Model
<!ELEMENT  table-wrap   %table-wrap-model;                           >
Expanded Content Model
((object-id)*, (label)*, (caption)*, (legend)*, (abstract)*, (kwd-group)*,
(subj-group)*, (alt-text | long-desc | email | ext-link | uri)*, (disp-quote | speech | statement |
verse-group | def-list | list | alternatives | chem-struct-wrap | code | disp-formula | graphic |
media | preformat | table | xref)*, (table-wrap-foot | attrib |
permissions)*)
Tagged Samples
With <label> and <caption> 
...
<table-wrap id="t2" orientation="portrait" position="float">
 <label>Table II.</label>
 <caption>
  <p>Models to approximate the bound frequencies as waves 
   in X→M (<inline-graphic id="g1" xlink:href="d1"/>: Rotational, 
   <inline-graphic id="g2" xlink:href="d2"/>: Vibrate in <italic>y</italic> 
   direction, <inline-graphic id="g3" xlink:href="d3"/>: Vibrate in
   <italic>x</italic> direction, <inline-graphic id="g4" xlink:href="d4"/>: 
   Vibrate mainly in <italic>y</italic> direction including a small 
   portion of vibration in <italic>x</italic> direction, 
   <inline-graphic id="g5" xlink:href="d5"/>: Vibrate mainly in 
   <italic>x</italic> direction including a small portion of vibration 
   in <italic>y</italic> direction).</p>
 </caption>
 <table border="1">...</table>
</table-wrap>
...
With <caption>, <table>, and <table-wrap-foot> 
...
<table-wrap id="TN0.170">
 <caption>
  <title>Patient Care at End of Follow Up</title>
  <p>Numbers of patients receiving institutional care at
   the end of scheduled follow up and use of hospital beds
   among those allocated to day hospital or alternative
   services</p>
 </caption>
 <table frame="box" rules="all" cellpadding="5">
  <tbody>
   <tr>
    <th></th>
    <th colspan="3" align="center" rowspan="1">Institutional care</th>
    <th></th>
    <th colspan="2" align="center" rowspan="1">&#x2003;Bed use (days)</th>
   </tr>
   <tr>
    <td colspan="3"><hr/></td>
    <td colspan="2"><hr/></td>
   </tr>
   <tr>
    <th>Control group</th>
    <th align="center">Day hospital</th>
    <th align="center">Control</th>
    <th align="center">Odds ratio (95% CI)</th>
    <th></th>
    <th align="center">Day hospital</th>
    <th align="center">Control</th>
   </tr>
   <tr>
    <td colspan="7"><hr/></td>
   </tr>
   <tr>
    <td>Comprehensive care (5 trials)</td>
    <td align="center">151/597<xref ref-type="table-fn"
      rid="TF1-150"></xref></td>
    <td align="center">159/584</td>
    <td align="center">0.91 (0.70 to 1.19)</td>
    <td></td>
    <td align="center">20.5</td>
    <td align="center">21.4</td>
   </tr>
   <tr>
    <td>Domiciliary care (4 trials)</td>
    <td align="center">20/216</td>
    <td align="center">&#x2002;19/227</td>
    <td align="center">1.61 (0.30 to 8.55)</td>
    <td></td>
    <td align="center">&#x2002;7.7</td>
    <td align="center">11.1</td>
   </tr>
   <tr>
    <td>No comprehensive care (3 trials)</td>
    <td align="center">37/411</td>
    <td align="center">&#x2002;66/403</td>
    <td align="center">0.50<xref ref-type="table-fn"
      rid="TF1-151"></xref> (0.26 to 0.96)</td>
    <td></td>
    <td align="center">11.2</td>
    <td align="center">11.7</td>
   </tr>
   <tr>
    <td>Total</td>
    <td align="center">208/1224</td>
    <td align="center">244/1214</td>
    <td align="center">0.77 (0.52 to 1.13)</td>
    <td></td>
    <td align="center">15.0</td>
    <td align="center">16.4</td>
   </tr>
  </tbody>
 </table>
 <table-wrap-foot>
  <fn-group>
   <fn id="TF1-150"><p>Data not available for 1 trial.</p></fn>
   <fn id="TF1-151"><p>P&lt;0.05 (random effects model).</p></fn>
  </fn-group>
 </table-wrap-foot>
</table-wrap>
...
Table linked to data from which the table was derived 
...
<table-wrap id="table1">
 <label>Table 1</label>
 <caption>
  <p>Steady-state kinetic analyses for each IGF1R protein.</p>
 </caption>
 ...
 <xref ref-type="supplementary-material" rid="source-data-3" />
</table-wrap>
...
<supplementary-material id="source-data-3" content-type="sdata" 
  mimetype="application/vnd.ms-excel" xlink:href="source-data-3.xlsx">
 <label>Supplementary File 3</label>
 <caption>
  <title>Representative curves of steady-state kinetic analyses 
   for each IGF1R protein characterized</title>
  <p>Each data point was performed in duplicate and is shown 
   separately.</p>
 </caption>
</supplementary-material>
...
Two languages: two labels, two captions 
...
<table-wrap id="t1">
 <label xml:lang="pt">Tabela 1</label>
 <label xml:lang="en">Table 1</label>
 <caption xml:lang="pt">
  <title>Matriz de análise política.</title>
 </caption>
 <caption xml:lang="en">
  <title>Political Analysis Matrix.</title>
 </caption>
 <table frame="hsides" rules="groups">
  ...
 </table>
 <table-wrap-foot>
  <attrib>Source: Prepared by authors from
   <xref ref-type="bibr" rid="B10">Monke and Pearson (1989)</xref>.
  </attrib>
 </table-wrap-foot>
</table-wrap>
...
@headers attribute 
...
<table-wrap position="float" id="ch1.tab2" orientation="portrait">
 <label>Table B</label>
 <caption>...</caption>
 <table frame="hsides" rules="groups">
  <thead>
   <tr>
    <th headers="hd_h_ch1.tab2_1_1_1_1" id="hd_h_ch1.tab2_1_1_1_1" 
        valign="bottom" align="left" rowspan="2" 
        colspan="1">Bariatric Procedure</th>
    <th id="hd_h_ch1.tab2_1_1_1_2" valign="bottom" align="center" 
        rowspan="1" colspan="4">Method of surgery</th>
   </tr>
   <tr>
    <th headers="hd_h_ch1.tab2_1_1_1_2" id="hd_h_ch1.tab2_1_1_2_1" 
        valign="bottom" align="left" rowspan="1" 
        colspan="1">Open only</th>
    <th headers="hd_h_ch1.tab2_1_1_1_2" id="hd_h_ch1.tab2_1_1_2_2" 
        valign="bottom" align="left" rowspan="1" 
        colspan="1">Laparoscopic only</th>
    <th headers="hd_h_ch1.tab2_1_1_1_2" id="hd_h_ch1.tab2_1_1_2_3" 
        valign="bottom" align="left" rowspan="1" 
        colspan="1">Either open or laparoscopic</th>
    <th headers="hd_h_ch1.tab2_1_1_1_2" id="hd_h_ch1.tab2_1_1_2_4" 
        valign="bottom" align="left" rowspan="1" 
        colspan="1">Not reported</th>
   </tr>
  </thead>
  <tbody>
   <tr>
    <td headers="hd_h_ch1.tab2_1_1_1_1" valign="top" 
        align="left" rowspan="1" colspan="1">AGB</td>
    <td headers="hd_h_ch1.tab2_1_1_1_2 hd_h_ch1.tab2_1_1_2_1" 
        valign="top" align="left" rowspan="1" colspan="1"/>
    <td headers="hd_h_ch1.tab2_1_1_1_2 hd_h_ch1.tab2_1_1_2_2" 
        valign="top" align="left" rowspan="1" colspan="1">23</td>
    <td headers="hd_h_ch1.tab2_1_1_1_2 hd_h_ch1.tab2_1_1_2_3" 
        valign="top" align="left" rowspan="1" colspan="1"/>
    <td headers="hd_h_ch1.tab2_1_1_1_2 hd_h_ch1.tab2_1_1_2_4" 
        valign="top" align="left" rowspan="1" colspan="1">1</td>
   </tr>
   ...
  </tbody>
 </table>
 <table-wrap-foot>...</table-wrap-foot>
</table-wrap>
...
Alternative Spanish and English Variants of a Table 
...
<table-wrap id="t0001" lang-group="t0001"  
  position="float" orientation="portrait" 
  xml:lang="es" lang-variant="original" 
  lang-source="author" lang-focus="primary">
 <label>Tabla 1.</label>
 <caption><p>Estadísticos descriptivos por edad</p></caption>
 <table>...</table>
</table-wrap>

<table-wrap id="t0006" lang-group="t0001"  
  position="float" orientation="portrait" 
  xml:lang="en"  lang-variant="translation" 
  lang-source="translator" lang-focus="secondary">
 <label>Table 1.</label>
 <caption><p>Descriptive statistics by age</p></caption>
 <table>...</table>
</table-wrap>
...
Related Resources