Objects for Standards XML
On this page
In this section
Figure, Table, and Box Captions
As demonstrated in the following examples, eXtyles will automatically separate the object number from the rest of the caption paragraph, provided that the object is referred to by a recognized name (e.g., Figure, Fig., Example, Illustration, Table, Box, Video, etc.) and a consistent character (e.g., period, colon) is used to separate the two parts (i.e., caption and label).
The Figure Caption Continued style should be used for the second paragraph of a caption, if present.
Example:
Figure 1. Security Software Log Entry Examples
yields this XML:
<fig id="fig_1" position="anchor" fig-type="figure">
<label>Figure 1</label><caption><title>Security Software Log Entry Examples</title></caption><graphic xlink:href="jms10-fig_1"/>
</fig>If you need additional terms to be recognized as the label for a figure, table, or box (e.g. “Photo”, “Case”), please contact Inera.
Example 1: Tables
When styling tables, multiple lines within a table cell are limited to the following paragraph formatting rules:
Table heading cells do not allow hard returns; soft returns are used to create multiple lines.
Table body cells allow both soft and hard returns.
Table footer cells do not allow soft returns; hard returns are used to create multiple lines.
Tables that contain graphics use the same paragraph styles as described in the previous sections. For more information on styling tables, see the section Table Styling.
The following example shows a properly styled table, including a title, table column heads, table body text, and a table footnote.
Word Sample
XML Sample
The border and alignment formatting in the Word document is preserved in the XML.
Simple Table with Footnote
<table-wrap id="tab_4" position="anchor">
<label>Table 4</label><caption><title>Injectivity Test Decision Matrix</title>
</caption>
<table width="624" rules="groups">
<col width="28.16%"/>
<col width="35.03%"/>
<col width="36.81%"/>
<thead>
<tr>
<th valign="middle" align="center" scope="col" style="border-left: solid 3px; border-top: solid 3px; border-right: solid 1px; border-bottom: solid 3px">Casing Pressure while Pumping<xref ref-type="table-fn" rid="table-fn_4.1"><sup>a</sup></xref></th>
<th valign="middle" align="center" scope="col" style="border-left: solid 1px; border-top: solid 3px; border-right: solid 1px; border-bottom: solid 3px">Casing Pressure after Pump Stopped</th>
<th valign="middle" align="center" scope="col" style="border-left: solid 1px; border-top: solid 3px; border-right: solid 3px; border-bottom: solid 3px">Action Indicated</th>
</tr>
</thead>
<tbody>
<tr>
<td valign="top" align="left" style="border-left: solid 3px; border-top: solid 3px; border-right: solid 1px; border-bottom: solid 1px" scope="row">Continues to build until last formation test is reached.</td>
<td valign="top" align="left" style="border-left: solid 1px; border-top: solid 3px; border-right: solid 1px; border-bottom: solid 1px"/>
<td valign="top" align="left" style="border-left: solid 1px; border-top: solid 3px; border-right: solid 3px; border-bottom: solid 1px">Cure losses with LCM.</td>
</tr>
<tr>
<td valign="top" align="left" style="border-left: solid 3px; border-top: solid 1px; border-right: solid 1px; border-bottom: solid 1px" scope="row">Builds to above allowable maximum working pressure of RCD or riser, but below last formation test and stabilizes.</td>
<td valign="top" align="left" style="border-left: solid 1px; border-top: solid 1px; border-right: solid 1px; border-bottom: solid 1px">Slowly bleeds down to hydrostatic (plus injectivity pressure).</td>
<td valign="top" align="left" style="border-left: solid 1px; border-top: solid 1px; border-right: solid 3px; border-bottom: solid 1px">Increase annular mud weight enough to reduce the surface annular pressure with the pumps running below maximum allowable working pressure for RCD or riser and switch to PMCD.</td>
</tr>
<tr>
<td valign="top" align="left" style="border-left: solid 3px; border-top: solid 1px; border-right: solid 1px; border-bottom: solid 1px" scope="row">Builds to below maximum working pressure and stabilizes.</td>
<td valign="top" align="left" style="border-left: solid 1px; border-top: solid 1px; border-right: solid 1px; border-bottom: solid 1px">Slowly bleeds down to hydrostatic (plus injectivity pressure).</td>
<td valign="top" align="left" style="border-left: solid 1px; border-top: solid 1px; border-right: solid 3px; border-bottom: solid 1px">PMCD can proceed using the same mud weight that is already in the hole.</td>
</tr>
<tr>
<td valign="top" align="left" style="border-left: solid 3px; border-top: solid 1px; border-right: solid 1px; border-bottom: solid 3px" scope="row">Builds to a pressure that is less than the desired surface annular pressure while using PMCD (150–200 psi) and stabilizes.</td>
<td valign="top" align="left" style="border-left: solid 1px; border-top: solid 1px; border-right: solid 1px; border-bottom: solid 3px">Falls off and stabilizes quickly.</td>
<td valign="top" align="left" style="border-left: solid 1px; border-top: solid 1px; border-right: solid 3px; border-bottom: solid 3px">Reduce annular mud weight enough so that there will be the desired annular pressure at the surface with the pumps off and the surface annular pressure with the pumps on will still be less than the maximum allowable working pressure. Switch to PMCD.</td>
</tr>
</tbody>
</table><table-wrap-foot>
<fn id="table-fn_4.1"><label><sup>a</sup></label><p>Calculated based on measured pressure at BOP plus a column of the same mud to surface.</p></fn>
</table-wrap-foot></table-wrap>
Example 2: Lists in Tables
Lists in tables should be styled using the appropriate list style, rather than using the table styles.
For example, the table in the following Word sample uses a Table Body style for the regular cell content and the appropriate List styles for the list content.
You can apply the list style to a unique paragraph in a table cell by holding the CTRL key while selecting the style from the palette.
Word Sample
In this example, the list items are formatted as separate paragraphs in one table cell. The dashed lines indicate the boundaries of the table cells in this example.
This is formatting is important, because if each list item is included in a single table cell the XML export may not be correct.
XML Sample
In the following XML sample, note the <list> and <list-item> elements, corresponding to the numbered list in the Word table above. Note also that in the XML, the <td> element for the merged cells includes a rowspan attribute (rowspan="2").
<table-wrap id="tab_a" position="anchor">
<table width="656" rules="groups">
<col width="29.44%"/>
<col width="37.23%"/>
<col width="33.33%"/>
<thead>
<tr>
<th valign="top" align="left" scope="col" style="border-top: solid 2px; border-bottom: solid 2px"><bold>Table header</bold></th>
<th valign="top" align="left" scope="col" style="border-top: solid 2px; border-bottom: solid 2px"><bold>Table header</bold></th>
<th valign="top" align="left" scope="col" style="border-top: solid 2px; border-bottom: solid 2px"><bold>Table header</bold></th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="2" valign="top" align="left" style="border-top: solid 2px; border-bottom: solid 2px" scope="row">Table body</td>
<td valign="top" align="left" style="border-top: solid 2px">Table body</td>
<td rowspan="2" valign="top" align="left" style="border-top: solid 2px; border-bottom: solid 2px">
<list id="L3" list-type="order">
<list-item><label>1.</label><p>Number list style</p></list-item>
<list-item><label>2.</label><p>Number list style</p></list-item>
<list-item><label>3.</label><p>Number list style</p></list-item>
</list>
</td>
</tr>
<tr>
<td valign="top" colspan="1" align="left" style="border-bottom: solid 2px" scope="col">Table body</td>
</tr>
</tbody></table></table-wrap>
Example 3: Figures/Graphics
The following example shows a properly styled figure/graphic and caption.
XML Sample
The graphic pointer in the following XML sample has an href (cross reference) that is generated from the Object ID Prefix entered into the eXtyles Document Information dialog.
Figure Graphic and Caption
Copyright © 2022 Atypon Systems, LLC. All Rights Reserved.