Oxford University Press Text Capture Instructions

 

Attributes of bibItem

Bibliographic references may refer to a very wide variety of works, from books and academic journals to international treaties and legal case reports. References to each type of work requires different attributes. If content for a non-required attribute is present in the reference, it is expected that it will be captured.

ref_org Collaborative author
ref_volume Volume number
ref_placeofPub Place of publication
ref_issueNumber Issue number
ref_trGivenName Translator surname
ref_trSurName Translator given name
ref_eicGivenName Editor-in-Chief given name
ref_eicSurName Editor-in-Chief surname
ref_subsidiaryName Subsidiary name
ref_foreTitle Fore title
ref_compoundName Compound name
ref_edition Edition number
ref_eventName Name of the event
ref_institution Name of the institution
ref_dateAccessed Accessed date
ref_nonrefElement Nonref element in note section
ref_class Type of bibItem
ref_abrref abbreviated reference

For a particular type of reference some attributes are required and others are optional. You can discover which by navigating to the appropriate class of bibItem. In many cases the information required in the markup is not present in the reference. For example, a reference may contain an abbreviated title, but a full title is required.

Where components of a reference are enclosed in quotation marks (e.g. the title of a chapter or journal article), do not capture the quotation marks in the attribute.

OUP use the attributes that you assign to the references to create links in the following ways:

  • DOIs: OUP sends the components of a reference to an external service to try and locate a DOI for it, which ensures persistent linking to an online target
  • OpenURL: our product web sites generate from the components of a reference an OpenURL, which is effectively a search of those components in the user's library catalogue in order to try and link to the library's holdings
  • Authority File: OUP has a system that turns legal references into a network of linked information about legislation, cases, commentaries, etc. Accurate reference markup enables a greater proportion of references to be linked automatically when data is loaded to this system, and makes it easier to manually link the remainder.
  • List of active bitItem attributes

    Name

    Type

    author

    The author of the referenced work.

    class

    The class and subClass attributes denoting the type of work for core classes or legal classes.

    country

    The ISO 3166 country code.

    court

    A code or abbreviation used to identify legal codes (normally in case report references).

    date

    The date.

    dateEnd

    The end date in a range.

    display

    Display only in the print or online versions.

    doiTarget

    DOI of the work

    editor

    The editor of the referenced work.

    edition

    Text indicating the edition of the referenced work.

    eventName

    Name of an event such as a conference.

    id

    unique identifier for the bibItem element.

    idnumber

    A list of any reference identifiers and/or citation codes, separated by the pipe ‘|’ character.

    isbn

    A valid ISBN code.

    issn

    A valid ISSN code.

    eissn

    A valid eISSN code.

    journalIssue

    The issue number of a journal. May also consist of 'Suppl.' or 'S' followed by a number to indicate a numbered supplement to a journal volume.

    journalName

    The name (or abbreviated name) of a journal.

    legisNum

    A document identifier for legislation (normally numeric).

    linkType

    The link type. A keyword describing the role of the reference. Only required for law content.

    page

    A page reference, or the start of a page range.

    pageLast

    The last page of a page range.

    partAuthor

    The name or names of the author of a chapter or other part of a referenced work (e.g. the author of a chapter in a collaboratively written textbook).

    partTitle

    The title of a chapter or other part of a referenced work (e.g. a chapter title).

    party1

    The first party name or set of names in a reference to a decision, award or case report. Capture multiple names using a pipe ‘|’ separator.

    party2

    The second name or set of names in a reference to a decision, award or case report (often after a v. or vs.).

    sameTarget

    Used for repeated references in law content.

    sameTargetRoot

    Used for repeated references in law content.

    sectRef

    Used for references to a specific provision of a legislative document in law content.

    subClass

    The class and subClass attributes denoting the type of work.

    title

    The title of the text being cited.

    vol

    The volume number of a journal or book (usually a digital, but sometimes a roman numeral).

    url

    Used for URLs in case report headnotes, and to correspond to <url> elements inside <bibItem>s; a URL for a web page or resource.

    Release ID:
    20260304
    ID:
    OUP_Bibliographic_Reference_TCI_topic_4
    Author:
    dunnm
    Last changed:
    Wed, 04 Jun 2025
    Modified by:
    buckmasm
    Revision#:
    4400