Creating links between Archives Hub descriptions

 

** PLEASE NOTE Our identifiers were changed in November 2012, so the way you make <archref> parent/child links has changed slightly, butyour old links will redirect to the new URIs.

 

The Archives Hub uses the <archref> EAD tag to enable linking between EAD descriptions. This has been implemented so that logical links can be made to parent/child descriptions, descendant/ancestor descriptions and also related/separated descriptions.

The <archref> tag can also be used to link WITHIN descriptions. According to the EAD specification the <ref> tag is more appropriate for this, but within the Archives Hub a <ref> link cannot be resolved when moving from one component record to another in the summary display, as they may be on separate pages within the description. However, <ref> links will work when linking from the collection level to lower-levels and when linking between lower-levels when in the full record.

Please note that <extref> is used to link to external locations (not EAD descriptions).

We have implemented <archref> in such a way that the relationship between the two descriptions is identified, so that the different interfaces (central Hub web interface, Spoke web interface, SRU interface and OAI-PMH) can construct the appropriate link before presenting the record to the user.

If you want to create links between descriptions, you just need to look at the options for the type of link and use the syntax provided, i.e. the <archref> tag with associated information. If you have a large file which we you would like to split up and link with <archref>, we have guidance available on how to do this. Please contact us.

For more information on the <archref> tag see the EAD Tag Library: <archref>

For an explanation of terminology used, see the Hub glossary.

Tag Content

The <archref> tag should contain the href attribute and the role attribute:

  • The href attribute should contain the persistent identifier of the target material. This is the countrycode, archon code and local reference code that are used in the unitid tag, with a hyphen separating the codes from the reference, e.g. GB 100 MSS would be gb100-mss.
  • The role attribute provides information that explains what type of relationship is being described. You just need to ensure that you include the correct role value for the type of link.

The relationships specified here utilise the idea of a hierarchical tree structure where there are parent/child relationships

Summary of Relationships

Relation

Description

Example

Relationship as defined in the role attribute

Parent

The higher-level description immediately above the current context

Collection > Series > Item

Collection description is the parent of a series description; series description is the parent of an item description

role="http://www.archiveshub.ac.uk/apps/linkroles/parent

Child

The level immediately below the current context

Item > Series > Description

An item description is the child of a series description; a series description is the child of a collection description

role="http://www.archiveshub.ac.uk/apps/linkroles/child

Descendent

A lower-level description that may not be immediately below the current context

Collection ...>... Item
Subfonds ...> Item

An item description is a descendant of a collection description; an item description is the descendant of a subfonds description

role="http://www.archiveshub.ac.uk/apps/linkroles/descendant

Ancestor

A higher-level description that may not be immediately above the current context

Item ...>...Collection
Item ...>...Subfonds

A collection description is the ancester of an item description; a subfonds description is the ancestor of an item description

role="http://www.archiveshub.ac.uk/apps/linkroles/ancestor

Extended

A description that is linked to from within the lower-level descriptions

Brief series description within a collection description > Extended series description outside of the collection description

An extended series description is in a separate file

role="http://www.archiveshub.ac.uk/apps/linkroles/extended

Related

A description that does not refer to the same archive collection

Collection > Collection
Collection > Series
Collection > Item

A collection description is linked to another collection description because the subject matter is related in some way

role="http://www.archiveshub.ac.uk/apps/linkroles/related

 

(1) Linking to related/separated material

Definition: A description that is related, but not part of the same collection. This option should be used to create links to related material that is not a child/parent of the current description. The link from one description to another can be to any level of hierarchy.

Example: A link from a collection about John Ruskin and his involvement in arts and crafts to a collection about the Arts and Crafts movement.

Role: The role attribute identifies the material as related: http://www.archiveshub.ac.uk/apps/linkroles/related

<relatedmaterial><p>Related material that may be of interest.</p>
<archref role="http://www.archiveshub.ac.uk/apps/linkroles/related" href="gb141-ms1">Link to related material</archref>
</relatedmaterial>

<relatedmaterial> <p>Relics collected by Dr. Jones's are the property of the School of Archaeology and are listed under <archref role="http://www/archiveshub.ac.uk/apps/linkroles/related" href="gb141-soa/ar/ij"> School of Archaeology Collection - Ancient Relics - Findings of Dr. Jones </p></archref>. </relatedmaterial>

 

(2) Linking to a fuller description of a component (lower-level) description

Definition: A component description provided in a separate record and linked to from within the parent description at the sub-fonds level. This option should be used to link from a component (lower-level) to a separate file, so the <archref> link is within the <dsc>. You might want to use this when you have very large lower-level descriptions that you want to put into separate files.

Example: A series description for a collection of photographs has a brief entry within the main description and a detailed description, maybe with a list of all items, is provided within a separate EAD description.

Role: The role attribute identifies the material as part of the same description: http://www.archiveshub.ac.uk/apps/linkroles/extended

<c01>
<did><unitid>gb999-ms1/1</unitid> <unittitle>Series Title</unittitle></did>
<otherfindaid> <p>Due to the the amount of material, this section is described fully in a separate description:</p>
<archref role="http://www.archiveshub.ac.uk/apps/linkroles/extended" href="gb141-ms2">Link to further description </archref>
</otherfindaid>
</c01>

<c01>
<did> <unitid>uol/su/pho</unitid> <unittitle>Photographs</unittitle> </did>
<otherfindaid> Due to the the amount of material, this section is described fully in a separate EAD instance:
<archref role="http://www.archiveshub.ac.uk/apps/linkroles/extended" href="gb141-uol/su/pho">Archive of the University of Liverpool - Student Union - Photographs</archref>. </otherfindaid> </c01>

 

(3) Linking from a parent description to a child description (lower-level description)

Definition: Linking down to the level directly below the current level of the description - a hierarchical child/parent relationship. For this option, the component description you are linking to must be a direct child of the current context.

Example: A link from the collection level description of the John Ruskin papers to a series description of his papers on the Arts and Crafts movement.

Role: The role attribute identifies the material as a direct child of the current context:http://www.archiveshub.ac.uk/apps/linkroles/child

<arrangement> This series is split into X separate sub-series, each described in separate EAD instances: <list> <item><archref role="http://www.archiveshub.ac.uk/apps/linkroles/child" href="gb141-uol/su/pho/pn">Prints</archref></item> <item><archref role="http://www.archiveshub.ac.uk/apps/linkroles/child" href="gb141-uol/su/pho/ng">Negatives</archref></item> ... ... </list> </arrangement>

The example below is a bulleted list within the <arrangement> tag and shows links to both prints and negatives of a collection of photographs .

<arrangement><p>This series is split into n separate sub-series, each described in separate EAD instances:</p>
<list><item>
<archref role="http://www.archiveshub.ac.uk/apps/linkroles/child" href="gb141-ms3/prints">Prints</archref>
</item><item>
<archref role="http://www.archiveshub.ac.uk/apps/linkroles/child" href="gb141-ms3/negatives">Negatives</archref>
</item> </list> </arrangement>

The markup for the child would be something like:

<c01 level="series"><did><unitid>MS3/prints</unitid><unittitle>Prints</unittitle>


(4) Linking from a child description to a parent description (higher-level description)

Definition: Linking up to the level directly above the current level of the description - a hierarchical child/parent relationship. For this option the parent description you are linking to must be the direct parent of the current context. It can be used to link within the same file or between different files.

Example: A link from a series description of the papers of John Ruskin on the Arts and Crafts Movement up to a collection-level description on John Ruskin.

Role: The role attribute identifies the material as the parent of the current context: http://www.archiveshub.ac.uk/apps/linkroles/parent

<archdesc> <scopecontent> This file describes a large collection of photographs that are part of <archref role="http://www.archiveshub.ac.uk/apps/linkroles/parent" href="gb141-uol/su">Archive of the University of Liverpool, Student Union Papers</archref>. </scopecontent> </archref>

<archdesc> <scopecontent> <p>This file describes a large collection of photographs that are part of </p>
<archref role="http://www.archiveshub.ac.uk/apps/linkroles/parent" href="gb141-ms4">Title of a Parent Description</archref>
</scopecontent> </archref>

 

(5) Linking to a descendent description (lower-level description) that is not a direct child of the current context

Definition: A component description that is not a direct child within the hierarchy. It may be used to link from the collection description to an item description that is not immediately below it (collection-series-item). The link may also be from one sub-fonds description to a lower sub-fonds description. For this option, the descendent description you are linking to need not be a direct child of the current context, it may be descended several levels.

Example: A link from a collection-level description of the papers of John Ruskin to an item level description of a notebook

Role: The role attribute identifies the material as a descendant of the current context but not a direct child: http://www.archiveshub.ac.uk/apps/linkroles/descendant

<bioghist> ... Photographs from this period of Dr Jones' life may be found in the folder<archref role="http://www.archiveshub.ac.uk/apps/linkroles/descendant" href="gb141-staff/ij/pho/pn-2">"Photographs taken during the 1940s"</archref> ... </bioghist>

<bioghist><p>Photographs from this period may be found in the folder</p>
<p><archref role="http://www.archiveshub.ac.uk/apps/linkroles/descendant" href="gb141-ms5">Photographs from the 1940s</archref></p>
</bioghist>

 

(6) Linking up to the containing ancestor collection

Definition: A parent description that is not a direct parent within the hierarchy. It may be used to link from an item description to a collection description that is not immediately above it (item-series-collection). For this option, the ancestor description you are linking to need not be the direct parent of the current context. It can be used to link within the same file or between different files.

Example: A link from an item-level description of a John Ruskin notebook up to a collection-level description of the John Ruskin collection.

Role: The role attribute identifies linking back to a container collection, not necessarily the direct parent: http://www.archiveshub.ac.uk/apps/linkroles/ancestor

<archdesc> <scopecontent> This file describes a large collection of photographs that are part of <archref role="http://www.archiveshub.ac.uk/apps/linkroles/ancestor" href="gb141-uol">Archive of the University of Liverpool</archref>. </scopecontent> </archref>

<archdesc><scopecontent> <p>This file describes a large collection of photographs that are part of
<archref role="http://www.archiveshub.ac.uk/apps/linkroles/ancestor" href="gb141-ms6">Title of a Collection Level Description</archref>
</p></scopecontent></archref>