ArchivesPortalEuropeFoundation / EAG2012

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

[Major revision] Updates to <conventionDeclaration>, <localTypeDeclaration>, and <rightsDeclaration> #119

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: <conventionDeclaration>, <localTypeDeclaration>, <rightsDeclaration> and their sub-elements

Change in content model (elements)

List all sub-elements and attributes that should be removed from or added to the element's content model.

kerstarno commented 1 year ago

For conversion, if <conventionDeclaration> includes references to ISO 8601, ISO 3166-1, ISO 639-2b, ISO 15924, or ISO 15511 within <abbreviation>, these are transferred to the new attributes within <control> for (in this order) @dateEncoding, @countryEncoding, @languageEncoding, @scriptEncoding, and @repositoryEncoding and will be forming the values "iso8601", "iso3166-1", "iso639-2b", "iso15924", and "iso15511" appropriately. Any other information provided with such <conventionDeclaration> elements will be removed without replacement.

If a <conventionDeclaration> has several <citation>-s, for each <citation> (then <reference>) a separate <conventionDeclaration> needs to be created during conversion. Any potentially existing <abbreviation> (then <shortCode>) and <descriptiveNote> elements will be copied repeatedly in each new <conventionDeclaration> element.

More generally, the current encoding

 <conventionDeclaration>
  <abbreviation source="source of abbreviation 1">abbreviation 1</abbreviation>
  <citation xml:lang="language of citation 1" href="link to citation 1" lastDateTimeVerified="YYYY-MM-DDTHH:MM:SS" source="source of citation 1">citation 1</citation>
  <citation xml:lang="language of citation 2" href="link to citation 2" lastDateTimeVerified="YYYY-MM-DDTHH:MM:SS" source="source of citation 2">citation 2</citation>
  <descriptiveNote>
    <p>p1</p>
    <p>p2</p>
  </descriptiveNote>
</conventionDeclaration>
<conventionDeclaration>
  <abbreviation source="source of abbreviation 2">abbreviation 2</abbreviation>
  <citation xml:lang="language of citation 3" href="link to citation 3" lastDateTimeVerified="YYYY-MM-DDTHH:MM:SS" source="source of citation 3">citation 3</citation>
  <citation xml:lang="language of citation 4" href="link to citation 4" lastDateTimeVerified="YYYY-MM-DDTHH:MM:SS" source="source of citation 4">citation 4</citation>
  <descriptiveNote>
    <p>p3</p>
    <p>p4</p>
  </descriptiveNote>
</conventionDeclaration>
<localTypeDeclaration>
  <abbreviation source="source of abbreviation 3">abbreviation 3</abbreviation>
  <citation xml:lang="language of citation 5" href="link to citation 5" lastDateTimeVerified="YYYY-MM-DDTHH:MM:SS" source="source of citation 5">citation 5</citation>
  <descriptiveNote>
    <p>p5</p>
    <p>p6</p>
  </descriptiveNote>
</localTypeDeclaration>
<localTypeDeclaration>
  <abbreviation source="source of abbreviation 4">abbreviation 4</abbreviation>
  <citation xml:lang="language of citation 6" href="link to citation 6" lastDateTimeVerified="YYYY-MM-DDTHH:MM:SS" source="source of citation 6">citation 6</citation>
  <descriptiveNote>
    <p>p7</p>
    <p>p8</p>
  </descriptiveNote>
</localTypeDeclaration>
<rightsDeclaration xml:lang="language of rightsDeclaration 1" localType="localType of rightsDeclaration 1">
  <abbreviation source="source of abbreviation 5">abbreviation 5</abbreviation>
  <citation xml:lang="language of citation 7" href="link to citation 7" lastDateTimeVerified="YYYY-MM-DDTHH:MM:SS" source="source of citation 7">citation 7</citation>
  <descriptiveNote>
    <p>p9</p>
    <p>p10</p>
  </descriptiveNote>
</rightsDeclaration>
<rightsDeclaration xml:lang="language of rightsDeclaration 2" localType="localType of rightsDeclaration 2">
  <abbreviation source="source of abbreviation 6">abbreviation 6</abbreviation>
  <citation xml:lang="language of citation 8" href="link to citation 8" lastDateTimeVerified="YYYY-MM-DDTHH:MM:SS" source="source of citation 8">citation 8</citation>
  <descriptiveNote>
    <p>p11</p>
    <p>p12</p>
  </descriptiveNote>
</rightsDeclaration>

becomes

<sources>
  <source id="source1">
    <reference>source of citation 1</reference>
  </source>
  <source id="source2">
    <reference>source of citation 2</reference>
  </source>
  <source id="source3">
    <reference>source of citation 3</reference>
  </source>
  <source id="source4">
    <reference>source of citation 4</reference>
  </source>
  <source id="source5">
    <reference>source of citation 5</reference>
  </source>
  <source id="source6">
    <reference>source of citation 6</reference>
  </source>
  <source id="source7">
    <reference>source of citation 7</reference>
  </source>
  <source id="source8">
    <reference>source of citation 8</reference>
  </source>
</sources>
<conventionDeclaration vocabularySource="source of abbreviation 1">
  <reference languageOfElement="language of citation 1" href="link to citation 1" sourceReference="#source1">citation 1</reference>
  <shortCode>abbreviation 1</shortCode>
  <descriptiveNote>
    <p>p1</p>
    <p>p2</p>
  </descriptiveNote>
</conventionDeclaration>
<conventionDeclaration vocabularySource="source of abbreviation 1">
  <reference languageOfElement="language of citation 2" href="link to citation 2" sourceReference="#source2">citation 2</reference>
  <shortCode>abbreviation 1</shortCode>
  <descriptiveNote>
    <p>p1</p>
    <p>p2</p>
  </descriptiveNote>
</conventionDeclaration>
<conventionDeclaration vocabularySource="source of abbreviation 2">
  <reference languageOfElement="language of citation 3" href="link to citation 3" sourceReference="#source3">citation 3</reference>
  <shortCode>abbreviation 2</shortCode>
  <descriptiveNote>
    <p>p3</p>
    <p>p4</p>
  </descriptiveNote>
</conventionDeclaration>
<conventionDeclaration vocabularySource="source of abbreviation 2">
  <reference languageOfElement="language of citation 4" href="link to citation 4" sourceReference="#source4">citation 4</reference>
  <shortCode>abbreviation 2</shortCode>
  <descriptiveNote>
    <p>p3</p>
    <p>p4</p>
  </descriptiveNote>
</conventionDeclaration>
<localTypeDeclaration vocabularySource="source of abbreviation 3">
  <reference languageOfElement="language of citation 5" href="link to citation 5" sourceReference="#source5">citation 5</reference>
  <shortCode>abbreviation 3</shortCode>
  <descriptiveNote>
    <p>p5</p>
    <p>p6</p>
  </descriptiveNote>
</localTypeDeclaration>
<localTypeDeclaration vocabularySource="source of abbreviation 4">
  <reference languageOfElement="language of citation 6" href="link to citation 6" sourceReference="#source6">citation 6</reference>
  <shortCode>abbreviation 4</shortCode>
  <descriptiveNote>
    <p>p7</p>
    <p>p8</p>
  </descriptiveNote>
</localTypeDeclaration>
<rightsDeclaration languageOfElement="language of rightsDeclaration 1" localType="localType of rightsDeclaration 1" vocabularySource="source of abbreviation 5">
  <reference languageOfElement="language of citation 7" href="link to citation 7" sourceReference="#source7">citation 7</reference>
  <shortCode>abbreviation 5</shortCode>
  <descriptiveNote>
    <p>p9</p>
    <p>p10</p>
  </descriptiveNote>
</rightsDeclaration>
<rightsDeclaration languageOfElement="language of rightsDeclaration 2" localType="localType of rightsDeclaration 2" vocabularySource="source of abbreviation 6">
  <reference languageOfElement="language of citation 8" href="link to citation 8" sourceReference="#source8">citation 8</reference>
  <shortCode>abbreviation 6</shortCode>
  <descriptiveNote>
    <p>p11</p>
    <p>p12</p>
  </descriptiveNote>
</rightsDeclaration>

For the detailed conversion of <descriptiveNote> see other use cases, where <descriptiveNote> continues being used, e.g. #116. For @lastDateTimeVerified see #120.