External links to other OUP content

Capture a cross-reference to an element in a different XML document using an extRef element.

//xrefGrp/extRef

Wrap the extRef element inside a parent xrefGrp element and in the extRef element add:

A docRef attribute set to the value of the id of the root element of the target document (ie. in the format productID-documentID)
A ref attribute set to the value of the id of the target element.
A sysId attribute set with the value of the filename (and extension) of the target document.

If you do not know the ref, docRef, or sysId values yet, but you do know that the target document forms part of the OUP service, give the attributes the value "0".

Only use this if instructed by OUP and the current document and target document are sent separately.

If the external reference is to a page number, useuse a child pageNum element as well as the ref attribute .

For ORR content, capture a cross-reference to another article in the same book using the xref element even if the articles are captured in different XML documents.

Examples of external references

Using extRef in an index

Use extRef in multi-volume works where each volume's index includes references to the other volume(s).


      <indexItem1 id="oso-9780199263905-indexItem1-1">
        <iHeadword>Arabic (Palestinian)</iHeadword>
        <indexItem2 id="oso-9780199263905-indexItem2-1"><xrefGrp>
                     <pageNum pageId="349">
   <extRef docRef="oso-9780199263929" ref="oso-9780199263929-part-2" sysId="oso-9780199263929.xml">
                             <b>Vol II 349</b>
                         </extRef>
 </pageNum></xrefGrp>
        </indexItem2>
      </indexItem1>

Using extRef in a contents list

Similarly, each volume in a multi-volume work may contain a table of contents for all the volumes. Compare this example with the example here.


      <item3 id="actrade-9780199546567-chapter-3-item1-1">
        <p>
                 <xrefGrp>
 <extRef ref="actrade-9780199546640-chapter-79" docRef="actrade-9780199546640" sysId="actrade-9780199546640.xml">Convention of 1969 (Philippe Sands)</extRef>
 <pageNum pageId="963">
                         <extRef ref="actrade-9780199546640-chapter-79-milestone-963" docRef="actrade-9780199546640" sysId="actrade-9780199546640.xml">963</extRef>
                     </pageNum></xrefGrp>
             </p>
      </item3>

External References captured before Target Document captured


      <item3 id="actrade-9780199546567-chapter-3-item1-1">
        <p>
                 <xrefGrp>
 <extRef ref="0" docRef="0" sysId="0">Convention of 1969 (Philippe Sands)</extRef>
 <pageNum pageId="963">
                         <extRef ref="0" docRef="0" sysId="0">963</extRef>
                     </pageNum></xrefGrp>
             </p>
      </item3>