ArchivesPortalEuropeFoundation / EAG2012

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

[Major revision] Rename `<abbreviation>` to `<shortCode>` and update content model #48

Closed kerstarno closed 1 year ago

kerstarno commented 2 years ago

Provide a general summary of the issue in the Title above.

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: <abbreviation> - Rules and/or conventions used

Change in name

Indicate any changes in name. New name: <shortCode>

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): n/a

Add to

Parent element(s): n/a

Change in availability

For elements, give an indication of their changed availability within each affected 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 added attributes, indicate their changed availability with "1" for required or "0" for optional within each affected parent element. Changed availability: n/a

Change in content model (elements)

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

Remove

Sub-element(s): n/a Attributes (with default values, if applicable): @source

Add

Sub-element(s): n/a Attributes (with default values, if applicable): @audience with values "external", "internal" (0), @id (0), @languageOfElement (0), @scriptOfElement (0), @target (0); option to include attributes from any other namespace

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:

<conventionDeclaration audience="external" id="cD1">
  <reference languageOfElement="eng" href="https://www.ica.org/sites/default/files/CBPS_2008_Guidelines_ISDIAH_First-edition_EN.pdf" linkTitle="See ISDIAH (in English)">International Standard for Describing Institutions with Archival Holdings</reference>
  <shortCode languageOfElement="eng">ISDIAH</shortCode>
</conventionDeclaration>
kerstarno commented 1 year ago

Included in one issue for <...Declaration> elements and all their sub-elements (#119). This issue here can hence be closed.