ArchivesPortalEuropeFoundation / EAG2012

Maintenance of EAG2012, the Encoded Archival Guide for describing institutions with archival holdings
5 stars 1 forks source link

[Major revision] Replace <repositorhist> with <biogHist> #126

Open kerstarno opened 1 year ago

kerstarno commented 1 year ago

Provide a general summary of the issue in the Title above. Delete the part of the issue template that does not apply depending on whether you describe a change to an existing element / attribute or the addition of a new one.

Creator of issue

State your name, organisation and ways to reach you. Name: Kerstin Arnold Organisation: Archives Portal Europe Foundation, Working Group on Standards Email: standards@archivesportaleurope.net GitHub username (if applicable): @kerstarno

Changes to existing element / attribute

Give the current name of the element / attribute. Include the tag name and the full name. Name: <repositorhist>

Change in context

List all parent elements to which the element / attribute should be added. Furthermore, list all parent elements from which the element / attribute should be removed.

Remove from

Parent element(s): <repository>

New element / attribute

Give the name of the new element / attribute. Include the tag name and the full name. Name: <biogHist>

Context and availability

List all parent elements to which the element / attribute should be added. For elements, give an indication of their availability within each parent element ("1..1" for required but not repeatable, "1 (or another number)..n" for required and repeatable, "0..1" for optional but not repeatable", "0..n" for optional and repeatable). For attributes, indicate their availability with "1" for required or "0" for optional within each parent element. Parent element(s): <description>

Content model (elements)

List all sub-elements and attributes of the new element. For sub-elements, give an indication of their availability ("1..1" for required but not repeatable, "1 (or another number)..n" for required and repeatable, "0..1" for optional but not repeatable", "0..n" for optional and repeatable). For attributes, indicate their availability with "1" for required or "0" for optional. Sub-element(s): <head> (0..1), <abstract> (0..1) - if used, <head> and <abstract> have to appear first and in this order; <chronList> (0..n), <p> (0..n), <list> (0..n) Attributes (with default values, if applicable): @audience with the values "external" and "internal" (0), @id (0), @languageOfElement (0), @scriptOfElement (0), @target(0), @conventionDeclarationReference (0), @maintenanceEventReference (0), @sourceReference (0), @localType (0), @localTypeDeclarationReference (0), and an option to include attributes from any other namespace.

For the sub-elements of <biogHist>:

Example of XML code

Provide a sample encoding in XML of the new / changed element (with potential attributes). Write your text after the "Example:" below. Example: As this has been adopted from EAC-CPF, see https://eac.staatsbibliothek-berlin.de/schema/v2/eac.html#elem-biogHist, https://eac.staatsbibliothek-berlin.de/schema/v2/eac.html#elem-chronItem, and https://eac.staatsbibliothek-berlin.de/schema/v2/eac.html#elem-chronItemSet for encoding examples as well as https://saa-sdt.github.io/EAS-Best-Practices/docs/chronlist/group-events.html, https://saa-sdt.github.io/EAS-Best-Practices/docs/lists/simple-lists.html, and https://saa-sdt.github.io/EAS-Best-Practices/docs/lists/multi-level-lists.html.

kerstarno commented 1 year ago

As <repositorhist> has a less complex content model, the conversion from EAG 2012 to EAG 3.0 is relatively straight forward. The current encoding:

<repositorhist>
  <descriptiveNote>

    <p xml:lang="[language of p1]" source="[source of p1]">p1</p>
    <p xml:lang="[language of p2]" source="[source of p2]">p2</p>
    <p xml:lang="[language of p3]" source="[source of p3]">p3</p>
  </descriptiveNote>
</repositorhist>

becomes

<control>
  [...]
  <sources>
    <source id="source1">
      <reference>source of p1</reference>
    </source>
    <source id="source2">
      <reference>source of p2</reference>
    </source>
   <source id="source3">
      <reference>source of p3</reference>
    </source>
  </sources>
  [...]
</control>
[...]
<biogHist>
  <p languageOfElement="[language of p1]" sourceReference="#source1">p1</p>
  <p languageOfElement="[language of p2]" sourceReference="#source2">p2</p>
  <p languageOfElement="[language of p3]" sourceReference="#source3">p3</p>
</biogHist>