Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
The items on the eXtyles Insert Tag menu allow greater control over the XML output. Note that not all of these tags will necessarily be available in your eXtyles configuration. Inera typically adds specifically required tags as needed. Contact eXtyles-support@inera.com if you believe that you would benefit from the addition of any of these tags to your configuration.
| Info |
|---|
Any time instructions below call for an eXtyles Tag (tag names highlighted in bold) to be added to a figure, table, or text box, you must add the eXtyles Tag to the end of the object title. Adding it at the beginning of the object title will interfere with eXtyles processes to automatically assign IDs to objects during export. |
Reference Tags
The first section of the Insert Tag menu consists of tags for various reference types (Book Reference, Conference Reference, etc.) to allow the type of reference to be tagged manually if the eXtyles Bibliographic Reference Processing fails to identify the reference type correctly, even when the reference is correctly copy-edited. To use these tags, follow these steps:
- Remove the incorrect tags from the start and end of the problematic reference. The safest way to do this is to place the cursor immediately after the tag and use the Backspace key twice to first highlight and then delete the tag.
- Highlight the entire paragraph with the reference.
- Select the appropriate reference type from the Insert Tag menu.
After applying the tag manually, you may add additional markup to the reference with Word character styles as necessary.
Figure Tags
Special Figure Filenames
In some cases, you may want to use an explicit filename for figures instead of using the auto-assigned eXtyles name. This may be especially true for unnumbered figures. For example, if you have a book about animals, you might want to name each image for the name of the animal. This can be done by using the Insert Tag item on the eXtyles Menu to insert an Inline Graphic tag (Named Graphic in some configurations).
When doing this to override the automatic figure filename assignment in a figure caption, this tag must be placed at the end of the figure caption. If the figure has a multi-paragraph caption, this tag should be inserted at the end of the last paragraph. If the figure has an attribution, source, or copyright line, the tag should be inserted after any of these paragraphs.
Doing so inserts a tag like this:
Fig. 1. Effect of DGC or PDE overexpression in B. bronchiseptica biofilm formation.<graphic></graphic>
And then you should type in the name of the figure file in between the tags like this:
Fig. 1. Effect of DGC or PDE overexpression in B. bronchiseptica biofilm formation.<graphic>Biofilm-image</graphic>
When the XML is created, the name inside the tags is used as the pointer to the graphic file, as in:
| Code Block | ||
|---|---|---|
| ||
<graphic xlink:href="Biofilm-image"/> |
Figure Placement
Sometimes it's necessary to insert a figure that has no caption at an arbitrary location (e.g. a custom logo at the end of each article). This can be done by using the Insert Tag item on the eXtyles Menu to insert an Inline Graphic/Named Graphic tag at any point in the text. Doing so inserts a tag like this:
....end of article text.<graphic></graphic>
And then you should type in the name of the figure file in between the tags like this:
...end of article text. |
When the XML is created, the name inside the tags is used as the pointer to the graphic file, e.g.:
...end of article text.<inline-graphic xlink:href="CustomLogo"/>
As with other figures, no file extension is used because the file extension will be added during the rendering process. However if you add an explicit extension inside the <graphic> tag, it will be carried through into the XML.
In
Fig. 3. Illustration of a large map<landscape></landscape>
This yields the following XML:
| Code Block | ||
|---|---|---|
| ||
<fig id="f3" position="float" fig-type="figure"
orientation="landscape"><label>Fig.
3</label><caption><p>Illustration of a large
map</p></caption><graphic
xlink:href="123-f3"></graphic></fig> |
Figures Made Up of Multiple Image Files
Sometimes a figure may have multiple image files (panels), particularly when it is in multiple parts. For example, an author might have created figures 1A, 1B, 1C, and 1D, each as a separate file. In this situation, you will need four <graphic> elements in the XML.
This can be done by using the Insert Tag item on the eXtyles Menu to insert a Figure Panels tag at the end of the figure caption, which inserts a tag like this:
<panel></panel>
If each panel is a separate image file, type in the letter of the last panel, like this:
Figure 1: This is a figure<panel>d</panel>
The resulting XML will look like this:
| Code Block | ||
|---|---|---|
| ||
<fig id="F001" position="float" fig-type="figure">
<label>Figure 1</label>
<caption><p>This is a figure made up of four image files.</p></caption>
<graphic xlink:href="BK06557_C001_F001a"></graphic>
<graphic xlink:href="BK06557_C001_F001b"></graphic>
<graphic xlink:href="BK06557_C001_F001c"></graphic>
<graphic xlink:href="BK06557_C001_F001d"></graphic>
</fig> |
The Figure Panels tag can even be used in cases where the parts of the figure are not evenly distributed, one per image file. For example:
Figure 2: This is a figure title<panel>ad,ef,gk</panel>
yields this XML:
| Code Block | ||
|---|---|---|
| ||
<fig id="f2" position="float" fig-type="fig">
<label>Figure 2</label>
<caption><title>This is a figure title</title></caption>
<graphic xlink:href="56789-f04-f2ad"/>
<graphic xlink:href="56789-f04-f2ef"/>
<graphic xlink:href="56789-f04-f2gk"/>
</fig> |
This would correspond to three image files, one containing parts (a)–(d), a second containing parts (e) and (f), and a third with parts (g)–(k), with each file named appropriately.
Video Files
Video files can be treated in the same way as static figures when exporting XML to the JATS or NLM Book DTDs. If your figure caption style is applied to a caption for the video, and the video is cited as e.g. "Video 1" or "Movie 1" in the text and the caption, then eXtyles will export the appropriate XML (Citation Matching will also match citations of videos in the same way that it matches citations of figures, tables, etc.).
One thing to bear in mind is that the export will create both a <media> element (for the video file itself) and a <graphic> element in the XML. This <graphic> element should point to a static file that can then be used as a placeholder for the video file in a print publication or as the preview frame online.
The following XML will be created:
| Code Block | ||
|---|---|---|
| ||
<fig id="vid1" position="float" fig-type="video">
<label>Video 1</label>
<caption><p>This is the caption for the video.</p></caption>
<graphic xlink:href="CDT-2012-35-vid1"></graphic>
<media xlink:href="CDT-2012-35-vid1"/>
</fig> |
The XML would need to be accompanied by files named CDT-2012-35-vid1.tif (or perhaps .gif or .jpg) for the placeholder and, for example, CDT-2012-35-vid1.avi for the video itself.
Object Type Tags
In many cases, it can be useful to have multiple types of "objects" when driving formatting from XML. For example, a chapter might have "Box" and "Essay" sidebars, each with unique formatting. eXtyles supports this well by automatically setting the content-type attribute when an "Essay" label is found in text, e.g.
Essay 1: This is an essay
becomes the following in XML:
| Code Block |
|---|
<boxed-text id="ES001" content-type="essay">
<label>Essay 1: </label>
<caption><title>This is an essay</title></caption> |
However, in some cases, you may have boxes for which you would like a unique content-type attribute. This can be set easily in eXtyles using the Box Type tag found on the eXtyles Insert Tag menu. By adding this tag at the end of a box title, and placing the box type in between the tags, eXtyles will convert that information into the content-type attribute on export.
For example, this content in the Word file:
Pearls and Pitfalls<Box_Type>Pearl</Box_Type> [Box Title]
- Head CT is critical to diagnosis, management, and prognosis following TBI [Box Text]
would yield this XML:
| Code Block |
|---|
<boxed-text id="c002_bb" content-type="Pearl" location="intext" position="anchor">
<title>Pearls and Pitfalls</title>
<list id="c002_l014"
list-type="bullet"><list-item><label>•</label><p>Head
CT is critical to diagnosis, management, and prognosis following
TBI</p></list-item>
</boxed-text> |
This
Section
by using the appropriate tags on the Insert Tag menu, as indicated. This feature gives tremendous flexibility to format books without requiring a large number of new paragraph styles.
MIME Type Tags
As mentioned earlier, the file type extension for image files is not included in the XML. However, there may be occasions when it is necessary to specify the type of image file that is associated with a given <graphic> element. The Mime Type tag can be used in this case. The following text in the Word file:
Figure 1: This is a figure title<mime>TIFF</mime>
results in the following XML:
| Code Block |
|---|
<fig id="f1" position="float" fig-type="fig">
<label>Figure 1</label>
<caption><title>This is a figure title</title></caption>
<graphic xlink:href="56789-f04-f1" mimetype="TIFF"/>
</fig> |
Specific Use Tags
JATS and versions 3.0 of the NLM Journal Publishing and Book DTDs contain an attribute "specific-use"; this attribute is not available in version 2.3 or earlier of the DTDs. This attribute is found in most elements and can be used very effective in place of processing instructions to set up information in the XML specific to your environment. While not widely needed in journals, this attribute is very useful in books. For example, if you have a paragraph that needs to be centered in the PDF, you could set up the following:
Paragraph<su>centered</su>
by selecting Specific Use from the eXtyles Insert Tag menu and then typing into the tags the text you want in the attribute. This results in the following XML
| Code Block |
|---|
<p specific-use="centered">Paragraph</p> |
This tag can be applied to figures, tables, boxes, extract quotes, lists, and paragraphs.
As another example, the markup:
- Which refers to communicating between people about general information?
- intrapersonal<su>2col</su>
- impersonal
- interpersonal
- public
- Which speaking context refers to the values and beliefs of your audience?
specifies that the nested list items a through d should appear in a 2-column layout (note that this could also be accomplished with a two-column inline table, but then the 2-column layout would be required in both print and electronic formats, which using specific-use lets each rendering system display with a different layout).
This would give the following XML:
| Code Block |
|---|
<list list-type="order" id="L1">
<list-item><p>Which refers to communicating between people about general information?</p>
<list specific-use="2col" list-type="alpha-lower" id="L2">
<list-item><p>intrapersonal</p></list-item>
<list-item><p>impersonal</p></list-item>
<list-item><p>interpersonal</p></list-item>
<list-item><p>public</p></list-item>
</list>
</list-item>
<list-item><p>Which speaking context refers to the values and beliefs of your audience?</p></list-item>
</list> |
To apply specific use to a list item (rather than the entire list), it is necessary to use the List Item Specific Use tag at the end of the list item in question.
Another example of the specific-use attribute is to indicate a photo that should have a clipping path applied for rendering, as in:
In what ways can you be ethical in researching speech topics?<su>clip-path</su>
If this tag were used at the end of a photo caption, it would yield the following XML:
| Code Block |
|---|
<fig id="fa" position="float" fig-type="photo" specific-use="clip-path">
<caption><p>In what ways can you be ethical in researching speech topics?</p></caption>
<graphic xlink:href="0-123456-78-9c003-fa"></graphic>
</fig> |
List Continued Tag
It is sometimes necessary to interrupt a list with, say, a subheading. Under normal circumstances, this would cause the next item in the list to be placed in a new list in the XML file. Because it is not permitted by JATS or the NLM Book DTD to start a new XML section within a list, it isn't possible to set up a Word paragraph style for a heading in a list. Instead, the List Continued tag should be placed at the end of the first list item after the heading, which has the effect of connecting the two lists by a continued-from attribute in the XML. An example of the use of this tag in Word follows:
Section 1. Bibliography
1. Poetry collections
2. Books, prose
3. Drama
Section 2. External links
4. Profiles<list-cont></list-cont>
5. Archive and works
which yields the following XML:
| Code Block |
|---|
<sec id="ss-s09-01-01">
<title>Section 1. Bibliography</title>
<list id="ss-L18" list-type="order">
<list-item><label>1</label><p>Poetry collections</p></list-item>
<list-item><label>2</label><p>Books, prose</p></list-item></list>
<list-item><label>3</label><p>Drama</p></list-item></list>
</sec>
<sec id="ss-s09-01-02">
<title>Section 2. External links</title>
<list id="ss-L19" list-type="order" continued-from="ss-L18">
<list-item><label>4</label><p>Profiles</p></list-item>
<list-item><label>5</label><p>Archive and works</p></list-item></list>
</sec> |
XML Tag
There may be times when you need to insert some XML exactly as it appears in the Word document, perhaps to include some XML that isn't supported by your current export filter. This can be achieved by adding the XML tag and placing the raw XML code between the start and end tags. For example:
Abstract: this is the <xml><monospace>courier</monospace><named-content content-type="test">species</named-content></xml> document in English.
yields this XML:
| Code Block |
|---|
<abstract>
<sec><title>Abstract</title><p>this is the
<monospace>courier</monospace>
<named-content content-type="test">species</named-content>
document in English.</p></sec>
</abstract> |
Note that this raw XML will still need to be valid against the appropriate DTD, and will cause a parsing error if not.
Typéfi Tags
For eXtyles customers who use Typéfi to create PDF files in InDesign from their JATS- or NLM Book DTD-compliant XML, there are a number of tags on the Insert Tag menu that give great control over display items in composition. The precise effect of each of these tags will have been arranged with Typéfi to suit the needs of your layout. Note that these effects could also be achieved by using the content-type attribute, as outlined for the various Object Type tags. These tags must appear at the end of the caption of the item to which they apply.
Size Tags
Tags are available to set display items to be small, medium, or large (e.g. Tbl_Small, Fig_Med, and Box_Large). These tags should be placed at the end of the table title, figure caption, or box caption. They result in processing instructions (e.g. <?Table Small?>, <?Figure Med?>, and <?Box Large?>) being added to the XML that will direct Typéfi to set the tables, figures, or boxes a particular size.
For example, this text in the Word file:
Figure 3 The Future Value of a Five-Year Ordinary Annuity<Fig_Large></Fig_Large>
will yield this XML:
| Code Block |
|---|
<fig id="DOC0123-R-F3" position="float"
fig-type="figure"><?Figure Large?><label>Figure 3
</label><caption><title>The Future Value of a
Five-Year Ordinary Annuity</title></caption><graphic
xlink:href="DOC0123-R-F3"></graphic></fig> |
Turn Tags
Tags are also available to force display items (tables, figures, and boxes; e.g. Tbl_Turn1, Fig_Turn2, Box_Turn3) to be displayed in a landscape orientation.
Span Tags
The span tags (Tbl_Small_Span, etc.) map to full-table or individual cell styles in InDesign, such as cell shading.
On This Page
Table of Contents
Child pages (Children Display)