Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Integrate <archref> and <bibref> with <reference> #46

Closed
12 of 19 tasks
kerstarno opened this issue Jul 16, 2023 · 10 comments
Closed
12 of 19 tasks

Integrate <archref> and <bibref> with <reference> #46

kerstarno opened this issue Jul 16, 2023 · 10 comments
Assignees
Labels
EAD major revision (EAD 4.0) This issue is part of the EAD major revision towards EAD 4.0 EAD Schema (general) This relates to a change in the general schema for EAD ead-archDesc This issue relates to the ead-archDesc module Implemented in draft version This has been implemented in draft version

Comments

@kerstarno
Copy link

kerstarno commented Jul 16, 2023

Creator of issue

  1. Kerstin Arnold
  2. EAD team lead, TS-EAS
  3. @kerstarno
  4. [email protected]

The issue relates to

  • EAC-CPF schema issue
  • EAC-CPF Tag Library issue
  • EAD schema issue
  • EAD Tag Library issue
  • Schema issue
  • Tag Library issue
  • Suggestions for all schemas
  • Suggestions for all Tag Libraries
  • Other

Wanted change/feature

  • Text: Remove <archref> and <bibref> from EAD. There is currently no difference between <archref>, <bibref>, and <ref> apart from the circumstance that the latter cannot include itself. On the other hand, <ref> includes linking attributes, which <archref> and <bibref> don't allow for. <archref> and <bibref> are currently available as direct sub-elements of <bibliography> (where archival references might not be used that often, but the context indicates references to be of a bibliographic type) and <otherfindaid>, <relatedmaterial>, and <separatedmaterial> (where bibliographic references might not be used that often, but the context indicates references to be of a archival type). In all four of these parent elements, <ref> (now <reference>, see Replace <ref> with <reference> and adapt content model #40) would be available within <p>, <item>, <entry>, and <event> as an alternative.

Note for working on and testing this issue: When the schema changes are done in development branch, please mark this by ticking the box for the higher level in the list (printed in bold); once the changes have been tested successfully please mark this by ticking the box on the lower and intermediate (printed in italics) levels.

  • Remove <archref> from
    • <bibliography> renamed to <publicationNote>
    • <otherFindAid>
    • <relatedMaterial>
    • <separatedMaterial>
  • Remove <bibref> from
    • <bibliography> renamed to <publicationNote>
    • <otherFindAid>
    • <relatedMaterial>
    • <separatedMaterial>
@kerstarno kerstarno added Review This is being reviewed in order to decide whether it will be implemented EAD Schema (core) This relates to a change in the core schema for EAD ead-archDesc This issue relates to the ead-archDesc module EAD major revision (EAD 4.0) This issue is part of the EAD major revision towards EAD 4.0 labels Jul 16, 2023
@MicheleCombs
Copy link

MicheleCombs commented Jul 17, 2023

Not sure where this request came from, but archref is really useful to us. We use it to reference other of our archival collections within relatedmaterial. This allows us to use an abbreviated URL (i.e. just the file name) and then, based on the fact that it's an archref, automatically generate the correct prefix. This is super helpful since sometimes our finding aids get moved en masse, and we have to alter the path to them, which we can easily do globally just by changing our XSL, This would be much harder to do with just extref (which technically isn't the correct element anyway, since these are not external references, they are references within our repository/institution). So, it would be nice if we could keep archref.

@kerstarno
Copy link
Author

Thanks for the feedback, Michele. It's always good to have real-world examples. I'd think it would be possible to do what you described also with <reference> as the context of <relatedMaterial> would already indicate that these are archival references, but for now this issue is only up for review (see labelling) and not decided yet. :-)

@MicheleCombs
Copy link

Not necessarily -- we also sometimes include, in relatedmaterial, links to resources that are not our own archival collections. It might be an archival collection at another repository, or a website, or a digital collection, and so on. Thus we would not be able to assume that all references within relatedmaterial would be archrefs.

@kerstarno
Copy link
Author

Thanks again, Michele. Would you maybe have an encoding example that you could add here? Just an example for <relatedMaterial> that includes links to your own archival resources and archival resources from other institutions and maybe also some generic resources as well.

@MicheleCombs
Copy link

MicheleCombs commented Jul 17, 2023

Sure! Take a look at the Related Materials section of our Grove Press finding aid. That one has a little bit of everything :)

@kerstarno
Copy link
Author

Thanks, Michele. Would you have the EAD XML encoding for this example as well by any chance? If it's not online somewhere, please feel free to send it to me via email ([email protected]). Would be great to have this for the EAD team meeting next week.

@MicheleCombs
Copy link

MicheleCombs commented Jul 17, 2023

Sure - you can find the ead code for all our finding aids here https://library.syracuse.edu/ead/xml/ This one is grove_press.xml The links to our collections and to the archival collections at other repositories are encoded as part of relatedmaterial, The link to the catalog, to find books that were removed for cataloging, is encoded as part of separatedmaterial. Both are displayed in the HTML version in the section entitled "Related Material" in the interests of not confusing end users, who won't care about the arcane differences between related and separated :)

@kerstarno
Copy link
Author

As a note to be taken into account during the further review of this issue:

The example of the Syracuse University finding aid uses EAD 2002 (DTD). With regard to <archref> and <bibref> this highlights a main difference between EAD 2002 and EAD3, as in EAD3 neither of these two elements allows for linking attributes anymore. One would need to apply the following encoding to get to the same effect, which already requires the use of <ref> in order to include links. Same for <extref>, which doesn't exist in EAD3 anymore.

<relatedmaterial>
  <head>Related Material</head>
  <p>For additional material related to Grove Press, see also the following: 
    <list>
      <item>
        <!-- <arch --><ref href="wainhouse_a.htm">Austryn Wainhouse Papers<!-- </arch --></ref>
      </item>
      <item>
        <!-- <arch --><ref href="glass_int.htm">Loren Glass Interviews Relating to Grove Press<!-- </arch --></ref>
      </item>
      <item>
        <!-- <arch --><ref href="deardoff.htm">Kenneth Deardoff Collection Relating to Grove Press<!-- </arch --></ref>
      </item>
      <item>
        <!-- <arch --><ref href="prix.htm">Prix Formentor Collection<!-- </arch --></ref>, which contains materials about the Prix International and Prix Formentor literary prizes.
      </item>
      <item>
        <!-- <arch --><ref href="creative.htm">Creative Film Foundation Records<!-- </arch --></ref>
      </item>
    </list>
  </p>
  <p>
    <!-- <ext --><ref href="http://findingaids.cul.columbia.edu/ead/nnc-rb/ldpd_7953908/summary">Barney Rosset's personal papers<!-- </ext --></ref> are housed at the Columbia University Rare Book and Manuscript Library, which also has a small <!-- <arch --><ref href="http://findingaids.cul.columbia.edu/ead/nnc-rb/ldpd_10553502/summary">Grove Press Collection<!-- </arch --></ref>.
  </p>
</relatedmaterial>

@kerstarno kerstarno changed the title Remove <archref> and <bibref> from EAD Integrate <archref> and <bibref> with <reference> Jan 5, 2024
@kerstarno kerstarno added Implement This has been decided to be implemented EAD Schema (general) This relates to a change in the general schema for EAD and removed Review This is being reviewed in order to decide whether it will be implemented EAD Schema (core) This relates to a change in the core schema for EAD labels Jan 5, 2024
@kerstarno
Copy link
Author

During their meeting in Washington on 26 July 2023, the EAD sub-team decided to move forward with this change. In addition to <reference> opening up the option of linking again, which EAD3 had removed from <archref> and <bibref>, the content model of those elements currently including <archref> and <bibref> in EAD3 also will be extended (see #69) by enabling <relations> as a direct sub-element of <otherFindAid>, <publicationNote> (renamed from <bibliography>), <relatedMaterial>, and <separatedMaterial>. The respective sub-elements that become available with this will allow for a more explicit description as well as categorisation/typing of the related materials referenced than was possible so far.

@fordmadox fordmadox added Ready for testing This is ready for testing and removed Implement This has been decided to be implemented labels Jan 15, 2024
@kerstarno
Copy link
Author

Tested with the XSD and the RNG and can confirm that this has been implemented as expected. The four elements in question now also include the <relations> element, which would allow for detailing various types of related materials/resources that one might want to reference in these elements.

@kerstarno kerstarno added Tested successfully This is has been tested successfully and is considered done in the development branch and removed Ready for testing This is ready for testing labels Jan 17, 2024
@kerstarno kerstarno assigned kerstarno and unassigned fordmadox Jan 18, 2024
@kerstarno kerstarno added Implemented in draft version This has been implemented in draft version and removed Tested successfully This is has been tested successfully and is considered done in the development branch labels Jan 18, 2024
@kerstarno kerstarno moved this from Review to Merged in Major EAD revision Jan 18, 2024
@github-project-automation github-project-automation bot moved this from Merged to Ready for testing in Major EAD revision Jan 29, 2024
@kerstarno kerstarno moved this from Ready for testing to Merged in Major EAD revision Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
EAD major revision (EAD 4.0) This issue is part of the EAD major revision towards EAD 4.0 EAD Schema (general) This relates to a change in the general schema for EAD ead-archDesc This issue relates to the ead-archDesc module Implemented in draft version This has been implemented in draft version
Projects
Archived in project
Development

No branches or pull requests

3 participants