[Major revision] Rename `<sourceEntry>` to `<reference>` and update content model

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: <sourceEntry> - Source entry

Change in name

Indicate any changes in name. New name: <reference> - Reference (as in EAC-CPF and EAD)

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): Rename to <reference> within <source>

Add to

Parent element(s): n/a (see also #96)

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: <source> (1..n); <reference> within <source> will be required and can be repeated

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): @transliteration; replace @xml:lang with @languageOfElement; replace @scriptCode with @scriptOfElement; replace @source with @sourceReference

Add

Sub-element(s): <span>(0..n) Attributes (with default values, if applicable): @audience with values "external", "internal" (0), @id (0), @target (0); @href (0), @linkRole (0), @linkTitle (0); @conventionDeclarationReference (0), @maintenanceEventReference (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:

<sources>
  <source>
   <reference scriptOfElement="Latn" languageOfElement="eng">Webpage of the Central State Archives, viewed 6 February 2015</reference>
  </source>
 </sources>

Detailed conversion changes

Rename <sourceEntry> to <reference> when used within <source>
Keep element's content as is
If <source> does not have a <sourceEntry>, create an empty <reference/> for reasons of validation
If attribute @transliteration is used with <sourceEntry>, add the attribute's value to a new <conventionDeclaration> element within its subelement <reference>, create an @id attribute for the <conventionDeclaration> element and add a @conventionDeclarationReference attribute to <reference> (within the existing <source>) to point to that @id
If attribute @xml:lang is used with <sourceEntry>, move value to @languageOfElement with <reference>
If attribute @scriptCode is used with <sourceEntry>, move value to @scriptOfElement with <reference>
If attribute @source is used with <sourceEntry>, add the attribute's value to another, new <source> element within its subelement <reference>, create an @id attribute for the new <source> element and add a @sourceReference attribute to <reference> (within the existing <source>) to point to that @id

Example

Current encoding

<source>
  <sourceEntry xml:lang="[value of @xml:lang]" scriptCode="[value of @scriptCode]" transliteration="[value of @transliteration]" source="[value of @source]">content of sourceEntry</sourceEntry>
</source>

Expected new encoding

<source>
  <reference languageOfElement="[value of @xml:lang]" scriptOfElement="[value of @scriptCode]" conventionDeclarationReference="[IDREF pointing to the identifier of conventionDeclaration]" source="[IDREF pointing to the identifier of the new source]">content of sourceEntry</reference>
</source> 
<source id="[xs:ID valid identifier for the new source element]">
   <reference>[value of former @source]</reference>
</source>
[...]
<conventionDeclaration id="[xs:ID valid identifier for the conventionDeclaration element]">
   <reference>[value of former @transliteration]</reference>
</conventionDeclaration>

ArchivesPortalEuropeFoundation / EAG2012