Tagging Figures/Graphics/Media
This Tag Set provides several elements related to the still graphic images and the multimedia objects contained within an article. These elements do not contain the image or object; they point to an external file that contains the image or object. The primary ones are:
- Graphic, Inline (<inline-graphic>) — inline still images such as logos,
- Graphic (<graphic>) — block-level still images such as drawings and photographs, and
- Media, Inline (<inline-media>) — inline moving images, sound files (such as pronunciation files), and other media that cannot be represented in print.
- Media (<media>) — block-level moving images, sound files, and other media that cannot be represented in print.
Inline Graphic
The simplest graphic object is the <inline-graphic>, which is used when the image should appear inline with surrounding text. Inline graphics may contain no labels, titles, or captions. A typical inline graphic is an empty element, using an attribute to point to a logo or to a special math or chemistry symbol that is used inside a paragraph or a title. (Best Practice: If the image represents a special private character, the <private-char> element should be used instead of <inline-graphic>.)
Graphic
Still images that do not appear inline are tagged with the <graphic> element, typically inside a figure (<fig>), which holds associated information such as a figure number, title, caption, etc. (see below). When an image in an article has no associated information (title, figure number, etc.), a <graphic> element should not be embedded in a <fig> element.
Most <graphic> elements are empty, used only to point to the external file. A <graphic> element may contain a <label> or <caption>, but <graphic> elements that are block-level objects in the text rather than inside a larger object such as a figure rarely do. When a <graphic> is within a figure (<fig>), the associated <label> or <caption> is typically within the <fig>, not within the <graphic>. A <label> within a <graphic> is typically used only when a single figure (<fig><label>Fig 4.</label>...</fig>) contains 3 or 4 graphics, each with a separate label such as:
...<graphic ...><label>Part A</label>...</graphic>...
or
...<graphic ...><label>Part B</label>...</graphic>...
Accessibility: A <graphic> that is not inside a <fig> or <table-wrap> should contain several sub-elements, including <alt-text> and <long-desc>, which are especially important to enable access for visually impaired users. For graphics inside another element (such as a <fig>), the containing element typically holds the accessibility information, although in rare cases the accessibility elements may need to be in both places.
Decorations: If a graphic is purely decorative and is not part of the narrative of an article (such as a background image of a wheat field on the first page of an article about crop grains or a section symbol between sections), the <graphic> element may be marked with an empty @alt attribute to indicate that it is purely decorative, and thus can be ignored by screen readers and other accessibility aids.
Media
Objects such as an MP3 sound clip accompanying an article are tagged with the <media> element, typically inside a figure (<fig>), which holds associated information such as a figure number, title, caption, etc. (see below). When a media object in an article has no associated information (title, figure number, etc.), a <media> element should be not be embedded in a <fig> element.
Accessibility: A <media> object that is not inside a <fig> or <table-wrap> should contain several sub-elements, including <alt-text> and <long-desc>, which are especially important to enable access for visually impaired users. For objects inside another element (such as a <fig>), the containing element typically holds the accessibility information, although in rare cases the accessibility elements may need to be in both places.
Figures and Figure Groups
This Tag Set also contains two elements typically used for associating a graphic or media object with related information (such as a caption, label, title, or credits and other attribution) or with other graphic, media, or textual objects.
- Figure (<fig>) — typically, a labeled wrapper for images and media and their metadata
- Figure Group (<fig-group>) — A grouping of several <fig> elements
Inside a figure (<fig>), the most commonly occurring related information is a figure number (<label>) and a caption (<caption>). Some publishers consider the display of a figure number definitive for deciding when to use a <fig> element; others depend more on whether the image ought to be listed in a List of Figures. Usually the two criteria match up, but there may be exceptions where numbered figures do not appear in the list, or vice versa.
Like tables, figures typically contain titles and captions. In this Tag Set, the <title> element is included inside the <caption> element. A <caption> may contain many kinds of text associated with its figure, typically a <title> (which acts as a heading for the figure), one or more descriptive paragraphs (<p>), or a legend (tagged, for example, as a list within a <p>).
Figures do not always contain pictures. While many <fig> elements contain graphic objects (<graphic> or <media>), a <fig> element may also contain a variety of display and textual objects, such as formulas, chemical structures, poetry, tables, bulleted or numbered lists, simple paragraphs, definition lists, or a mixture of any of these items as well as one or more graphic objects.
A Figure Group element (<fig-group>) contains one or more Figure elements (<fig>), placed in one container for editorial or production convenience. Specifically, a <fig-group> contains two or more labeled, possibly captioned <fig> elements that form a logical group, perhaps with an overall <label>, <caption>, or other information on the <fig-group> element that applies to all of the figures inside it.
Multi-language Figures
JATS provides several ways to tag figures in multiple languages. The element <block-alternatives> element can be used to hold two or more versions of the figure, each in a different language. It is also possible to place multiple <label> and <caption> elements inside a single figure, one label and caption for each language, differentiated, for example, by @xml:lang attributes.
One Figure for Each Language
The element <block-alternatives> can be used to hold two or more versions of the same figure, each in a different language. The figure content (graphic, list, diagram, whatever) may be the same, differing only in external structures such as labels, captions, footnotes, etc. Or the entire narrative or graphic content of the figure may be in a different language. The appropriate figure can be chosen at display or production time, based on language attributes or other criteria.
<block-alternatives>
<fig xml:lang="a">...</fig>
<fig xml:lang="b">...</fig>
<fig xml:lang="c">...</fig>
</block-alternatives>Usage: The major use case for <block-alternatives> is multiple versions, probably multiple language versions, of a figure. For example, a typical use case is an article in a printed journal which contains a figure in Portuguese and the same article when presented online with that figure in English (identical figures). Another typical use case is a figure provided two or three times as alternatives in a single output format, one figure for each language.
Comparison to Figure Group: A group of identical figures is not a figure group. The element <fig-group> is defined as a collection of related figures, rather than multiples of the same figure. A figure group containing 6 figures counts as 6 figures; a <block-alternatives> element containing 6 figures would count as a single figure, with 6 processing alternatives.
Comparison to Alternatives: A group of processing alternatives inside a single figure does not use <block-alternatives>. The element <alternatives> holds different processing versions of the contents of a figure (like three graphics in different resolutions), inside a single <fig> element. The element <block-alternatives> holds multiple processing versions of a complete figure (multiple <fig> elements), each different in some aspect.
Multiple Labels and Captions inside One Figure
Multiple <label> and <caption> elements in different languages can be placed within a single figure. Typically, there is one label and caption for each language, differentiated by @xml:lang attributes:
<fig> <label xml:lang="pt">...</label> <label xml:lang="en">...</label> <caption xml:lang="pt"><title>...</title></caption> <caption xml:lang="en"><title>...</title></caption> <graphic id="graphicid" xlink:href="..."/> </fig>
Processing Implications: To associate the related language caption and label more closely, for example, to place them on the same line for display, a processing system can match on the @xml:lang attributes (or other selectors as needed).
Positioning Graphic Objects
In common with other block-level display objects, figures, graphics, and media objects may take the @position attribute, which is used to indicate where the object should be displayed. The values for this attribute are slightly overloaded, as two values indicate the position of the object (such as a graphic) in relation to the text:
and two indicate the relationship between the object (such as a graphic) and the page:
anchor | Object should appear exactly where it is found in the narrative flow. |
|---|---|
float | Object should appear near its position in the narrative flow, but it may float to the top of a page or column, or into another window. |
background | Object, typically a decorative graphic, should appear behind the narrative. This does not displace the narrative; ideally, both the graphic and the narrative are visible, and the narrative is legible through the graphic. Accessibility: Best practice is to mark all purely decorative graphics with an empty @alt attribute, so that screen readers and other accessibility devices know that they may be ignored. |
|---|---|
margin | Object should appear beside the text that contains it in the narrative flow, as though it were in the margin of a printed page. Accessibility: Best practice is to mark all purely decorative graphics with an empty @alt attribute, so that screen readers and other accessibility devices know that they may be ignored. |
Figure and Graphic Examples
Here is a typical figure with a label, caption, and graphic inside. As is usually the case, the <graphic> element is empty, only used to point to the external file.
... <fig id="fg-012"> <label>Figure 12.</label> <caption> <title>My Dog</title> <p>He is so sweet! This is his best pose.</p> </caption> <graphic xlink:href="frontView.png"/> </fig> ...
Here is a figure that contains no graphics at all, but encloses some bulleted items in a <list>. Note: The prefix word attribute has been used in the example below to generate a more complicated label; each label will have the prefix “Pet” (“Pet 1. Poodle”, “Pet 2. Persian Cat”, etc.).
<fig id="fg-012"> <label>Figure 3.</label> <caption><title>Pet Show and Tell Order</title></caption> <list list-type="order" prefix-word="Pet "> <list-item><label>1.</label><p>Poodle</p></list-item> <list-item><label>2.</label><p>Persian Cat</p></list-item> <list-item><label>3.</label><p>Weaver Finches</p></list-item> <list-item><label>4.</label><p>Gecko</p></list-item> </list> </fig>
Here is a figure with three graphics inside. The <fig> element also contains a <label> and <title> that apply to all the graphics. In this example, the <graphic> elements are not empty; each <graphic> has its own <label> and <caption>.
...
<fig id="fg-012">
<label>Figure 12.</label>
<caption><title>Three Perspectives on My Dog</title></caption>
<graphic xlink:href="frontView.png">
<label>a.</label>
<caption><p>View A: From the Front, Laughing</p></caption>
</graphic>
<graphic xlink:href="sideView.png">
<label>b.</label>
<caption><p>View B: From the Side, Best Profile</p></caption>
</graphic>
<graphic xlink:href="motionView.png">
<label>c.</label>
<caption><p>View C: In Motion, A Blur on Feet</p></caption>
</graphic>
</fig>
...
Here is a figure group, with three figures inside, each of which contains a graphic. The <fig-group> element also contains a <label> and a <title> that apply to all the <fig> elements in the group. Each figure also has its own <label> and <title>.
... <fig-group id="dogpix4"> <label>Figures 12-14 Bonnie Lassie</label> <caption><title>Three perspectives on My Dog</title></caption> <fig id="fg-12"> <label>a.</label> <caption><p>View A: From the Front, Laughing</p></caption> <graphic xlink:href="frontView.png"/> </fig> <fig id="fg-13"> <label>b.</label> <caption><p>View B: From the Side, Best Profile</p></caption> <graphic xlink:href="sideView.png"/> </fig> <fig id="fg-14"> <label>c.</label> <caption><p>View C: In Motion, A Blur on Feet</p></caption> <graphic xlink:href="motionView.png"/> </fig> </fig-group> ...
Other Block-level Display Objects
Several other block-level elements may also contain graphic objects, for example, see <boxed-text> and <disp-formula>. For specifics, see the Context Table for where the specific graphic/media objects (<graphic>, <inline-graphic>, <media>, and <inline-media>) may be used.
Additional (Non-integral) Display Objects
The <supplementary-material> and <inline-supplementary-material> elements describe supplemental material that is associated with an article, but not part of the article. Neither the <supplementary-material> nor the <inline-supplementary-material> contains a supplementary object; both elements contain descriptions and possibly pointers to such objects. These descriptions may incorporate graphics or media elements (<graphic> or <media>) as part of the description of the additional material, but those graphics and media are not themselves the supplementary object.