Home > Topics > Issue Metadata

Issue Metadata

Both article and issue XML contain information about the journal issue. This issue information may include the volume number, issue number (or issue range), issue title, supplement, publication date, and cover date.

<issue>

The <issue> element will generally be tagged as an integer or a range for current content, but non-numeric issue values may be included in legacy/acquired content. The word “issue” should not appear in the tag – only the value or range should be included. If the article has not yet been assigned to an issue, the volume number and issue number elements should be written as “0” (zero).

Issue ranges should be captured as follows: <issue>1-2</issue>

<issue-title>

When a title is assigned to an issue, the issue title should be tagged in the <issue-title> element in both article and issue XML. This element can contain text, numbers, and special characters.

The emphasis elements <bold> and <italic> can be used within <issue-title>. Baseline change elements like <sub> and <sup> can also be used within <issue-title>.

<volume>

The <volume> element identifies the number of a volume within a series. Only the number value should be tagged in the <volume> element; the word “volume” should not be tagged in the element. Additionally, if ordinals are used for a volume number inside references, they must be placed inside the <volume> element.

A few journals use one incrementing number to identify each issue (instead of using separate volume and issue numbers). In these cases, the number should be tagged in <volume>, and <issue> should be set to 1 for all issues. Occasionally there have been issues published as volume-only with a combined-volume range. A volume range should be captured the same way a an issue range is captured.

For example, volume 207-208 would be captured: <volume>207-208</volume>

Note on Supplements

Supplement issues should be captured using the <issue> element and reflect the presence of a supplement with the use of ‘S’ combined with the number of the supplement.

For example, if the journal RAIJ published a supplement issue, in volume 175, the package would be titled: RAIJ_I_175_S1_J.zip

And this would be captured in the XML as:

For more details on Supplement Issues, see the File and id naming conventions section.

Examples

Example 1: An example of volume and issue information identified in article XML

<article-meta> 
… 
<volume>38</volume> 
<issue>4</issue> 
… 
</article-meta>

Issue zip naming convention: ABCD_I_38_4_J.zip

Note: for articles that are not yet assigned to an issue, the volume and issue number elements should be captured as ‘0’ (zero):

<volume>0</volume> 

<issue>0</issue>

Example 2: An example of volume and issue range information identified in article XML

For volume 38 issue 3-4 (a combined-issue range), the <issue> element contains start issue dash end issue (with no spacing between the dash)

<volume>38</volume> 
<issue>3-4</issue>

Issue zip naming convention: ABCD_I_38_3-4_J.zip

Example 3: An example of issue and volume identification in issue XML

<issue-meta> 

… 

<volume>38</volume> 
<issue>4</issue> 

… 
</issue-meta>

Example 4: An example of the <issue-title> in issue XML

Within the <issue-meta> element:

<volume>38</volume> 
<issue>4</issue> 
<issue-title>Human Rights and Reproductive Governance in Transnational Perspective</issue-title>

Example 5: Multipart issue

For an issue with sub-parts or multi-parts, the part value(s) should be captured in the <issue> element.

For example, Volume 12, Issue 3, Part A would be captured as follows:

<volume>12</volume> 
<issue>3PA</issue>

Issue zip naming convention: ABCD_I_12_3PA_J.zip

Volume 12, Issue 3, Part 1 would be captured as follows:

<volume>12</volume> 
<issue>3P1</issue>

Issue zip naming convention: ABCD_I_12_3P1_J.zip

And so on, depending on how the ‘parts’ are structured.

Example 6: Volume number only

For volume-only issues, the volume number should be captured in <volume> and the <issue> element should contain 1. A 1 should also be used for the issue number in the file names.

<volume>500</volume> 

<issue>1</issue>

Issue zip naming convention: ABCD_I_500_1_J.zip

Counter Examples

Incorrect examples of volume and issue information:

<volume>volume 38</volume>

<issue>issue 4