<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.
Remarks
Table Content: This element has been designed to capture a construct named
“table”, whether that structure contains an explicit <table> element (from the NISO JATS XHTM™-inspired table model) contains non-tabular structures such as graphics, lists, or paragraphs. Many publishers associate table captions and table numbers with material that is not explicitly tabular.
Related Resource:
- For a discussion on the use of <table-wrap>, see Table and Table Wrapper.
- For additional information concerning Accessibility (specifically, the @scope and @headers attributes) see Accessibility: Table Headers
Within the <table-wrap> element, the row
and column tags that describe the table cells should be defined by the NISO JATS 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. In fact, an author can put both referenced footnotes and unreferenced paragraphs directly into the <table-wrap-foot>.
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 Supplementary Data with a Table: When the data (such as a spreadsheet or dataset) associated with a document has been described using a
<supplementary-material> element, then a table (<table-wrap>) can use an internal <xref> to point to that <supplementary-material>. This provides a mechanism to expose the data behind the table. For example, assume that a table (<table-wrap>) is associated with three pieces of supplementary material (each described in a <supplementary-material> element). Three cross references (<xref>) can be embedded in the table tagging to associate the table with all three supplementary items, which may be datasets, additional figures or tables, spreadsheets, etc.
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.
Attributes
Content Model
<!ELEMENT table-wrap %table-wrap-model; >
Expanded Content Model
((object-id)*, (caption)?, (alt-text | long-desc)*, (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?)
Description
The following, in order:
- <object-id> Object Identifier, zero or more
- <caption> Caption of a Figure, Table, etc., zero or one
- Any combination of:
- Accessibility Elements
- Any combination of:
- <disp-quote> Quote, Displayed
- <speech> Speech
- <statement> Statement, Formal
- <verse-group> Verse Form for Poetry
- Lists
- <alternatives> Alternatives For Processing
- <chem-struct-wrap> Chemical Structure Wrapper
- <code> Code
- <disp-formula> Formula, Display
- <graphic> Graphic
- <media> Media Object
- <preformat> Preformatted Text
- <table> Table (NISO JATS table model)
- <xref> X (cross) Reference
- <table-wrap-foot> Table Wrapper Footer, zero or one
- Ownership Elements
- <attrib> Attribution, zero or one
- <permissions> Permissions, zero or one
This element may be contained in:
Example 1
A table wrapper containing the label and caption for a <table>:
...
<table-wrap id="t2" orientation="portrait" position="float">
<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>
...
Example 2
A table wrapper showing the interior table:
...
<table-wrap id="TN0.170">
<caption>
<title>Patient Care at End of Follow Up</title>
<p>Numbers of patients receiving institutional
care ...</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"> Bed use (days)</th>
</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<0.05 (random effects model).</p></fn>
</fn-group>
</table-wrap-foot>
</table-wrap>
...
Example 3
A table wrapper showing use of the @headers attribute:
...
<table-wrap position="float" id="ch1.tab2" orientation="portrait">
<caption>...</caption>
<table frame="hsides" rules="groups">
<thead>
<tr>
<th id="hd_h_ch1.tab2_1_1_1_1" rowspan="2" valign="bottom" align="left"
colspan="1" headers="hd_h_ch1.tab2_1_1_1_1"
>Bariatric Procedure</th>
<th id="hd_h_ch1.tab2_1_1_1_2" align="center" valign="bottom"
colspan="4" rowspan="1">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>
...