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

<control> #81

Open
SJagodzinski opened this issue Jan 13, 2020 · 7 comments
Open

<control> #81

SJagodzinski opened this issue Jan 13, 2020 · 7 comments
Assignees
Labels

Comments

@SJagodzinski
Copy link
Contributor

SJagodzinski commented Jan 13, 2020

Control

  • improve the description of <control> in the Tag Library based on EAD's description
  • more detailed examples of usage in best practice guidelines
  • add new optional element <representation>
  • add new required attribute:
    @maintenanceStatus
  • add new optional attributes:
    @audience
    @base
    @countryEncoding
    @dateEncoding
    @languageEncoding
    @languageOfElement
    @publicationStatus
    @repositoryEncoding
    @scriptEncoding
    @scriptOfElement

Creator of issue

  1. Silke Jagodzinski
  2. TS-EAS: EAC-CPF subgroup
  3. [email protected]

Related issues / documents

<control>: add child element #9
<control>: express more adequately #23
@countryencoding #120

EAD3 Reconciliation

Additional EAD 3 attributes
@altrender - Optional
@audience - Optional (values limited to: external, internal)
@countryencoding - Optional (values limited to: iso3166-1, othercountryencoding)
@dateencoding - Optional (values limited to: iso8601, otherdateencoding)
@encodinganalog - Optional
@langencoding - Optional (values limited to: iso639-1, iso639-2b, iso639-3, otherlangencoding)
@relatedencoding - Optional
@repositoryencoding - Optional (values limited to: iso15511, otherrepositoryencoding)
@script - Optional
@scriptencoding - Optional (values limited to: iso15924, otherscriptencoding)

Additional EAD 3 element
<representation>: for recording a link to a transformed and deliverable version of the EAD instance.
<filedesc>: binds together bibliographic information about an EAD instance

Decision from EAC-EAD-Schema joint meeting, 28 Jan 2020: do not include @altrender in EAC-CPF

Context

The element of the instance that contains control information about its identity, creation, maintenance, status, and the rules and authorities used in the composition of the description.

May contain: <conventionDeclaration>, <languageDeclaration>, <localControl>, <localTypeDeclaration>, <maintenanceAgency>, <maintenanceHistory>, <maintenanceStatus>, <otherRecordId>, <publicationStatus>, <recordId>, <rightsDeclaration>, <sources>
May occur within: <eac-cpf>
Attributes: @xml:base, @xml:id, @xml:lang
Availability: Mandatory, Non-repeatable

Solution documentation

Rephrasing Summary, Description and Usage and Attribute usage needed?

May contain: <conventionDeclaration>, <languageDeclaration>, <localControl>, <localTypeDeclaration>, <maintenanceAgency>, <maintenanceHistory>, <maintenanceStatus>, <otherRecordId>, <publicationStatus>, <recordId>, <rightsDeclaration>, <representation>, <sources>
May occur within: <eac-cpf>
Attributes:
@audience - optional (values limited to: external, internal)
@base - optional
@countryEncoding - optional
@dateEncoding - optional
@id - optional
@languageEncoding - optional
@languageOfElement - optional
@maintenanceStatus - required (values limited to: cancelled, deleted, deletedMerged, deletedReplaced, deletedSplit, derived, new, revised)
@publicationStatus - optional (values limited to: approved, inProcess, published)
@repositoryEncoding - optional
@scriptEncoding - optional
@scriptOfElement - optional

Availability: Required, not repeatable

  • New or other example needed?
  • Topic for Best Practise Guide

Example encoding

<eac>
<control audience="external" countryEncoding="iso3166-1" dateEncoding="iso8601" id="control1" languageEncoding="iso639-1" languageOfElement="en" maintanceStatus="new" publicationStatus="inProcess" repositoryEncoding="iso15511" scriptEncoding="iso15924" scriptOfElement="lat">
  <recordId>records identifier</recordId>
  <maintenanceStatus value="new"/>
  <maintenanceAgency>[...]</maintenanceAgency>
  <maintenanceHistory>[...] >/maintenanceHistory>
 </control>
</eac>
@fordmadox

This comment has been minimized.

@kerstarno

This comment has been minimized.

@fordmadox

This comment has been minimized.

@kerstarno

This comment has been minimized.

@ailie-s
Copy link

ailie-s commented Aug 31, 2020

DRAFT Tag Library text:

Summary: A required child element of <eac> that contains information about the creation, maintenance, status and the rules and authorities used in the composition of the EAC-CPF instance.
May contain: <conventionDeclaration> (0..n), <languageDeclaration> (0..n), <localControl> (0..n), <localTypeDeclaration> (0..n), <maintenanceAgency> (1..1), <maintenanceHistory> (1..1), <otherRecordId> (0..n), <recordId> (1..1), <rightsDeclaration> (0..n), <representation> (0..n), <sources> (0..1)
May occur within: <eac-cpf>
Attributes:
@audience - optional (values limited to: external, internal)
@base - optional
@countryEncoding - optional
@dateEncoding - optional
@id - optional
@languageEncoding - optional
@languageOfElement - optional
@maintenanceStatus - required (values limited to: cancelled, deleted, deletedMerged, deletedReplaced, deletedSplit, derived, new, revised)
@publicationStatus - optional (values limited to: approved, inProcess, published)
@repositoryEncoding - optional
@scriptEncoding - optional
@scriptOfElement - optional
Description:
This required wrapper element within <eac> contains the information necessary to manage the instance. This includes information about its creation, maintenance and status as well the languages, rules and authorities used in the composition of the description.

It must contain a unique identifier for the instance within the <recordId> element. Other associated identifiers may be given in <otherRecordId>. There must be a description of the agency responsible for its creation and maintenance in <maintenanceAgency> as well as statements about its current drafting status in @maintenanceStatus and the creation, maintenance, and disposition of the instance in <maintenanceHistory>.

There are optional elements available to declare languages, rules, conventions and sources used in the EAC-CPF instance. Other control elements considered necessary but not otherwise included may be given in the <localControl> element.

The available child elements (both required and optional) are:
<recordId> - Required. Contains the unique identifier for the EAC-CPF instance.
<otherRecordId> - Optional. An element that allows the recording of additional identifiers that may be associated with the EAC-CPF instance.
<maintenanceAgency> - Required. Contains the name and coded information about the institution or service responsible for the creation, maintenance, and/or dissemination of the EAC-CPF instance.
<languageDeclaration> - Optional. Contains coded and natural language information about the language or languages of the EAC-CPF instance.
<conventionDeclaration> - Optional. Contains information on the rules or conventions used to construct the EAC-CPF instance.
<rightsDeclaration> - Optional. Contains information about the usage rights of the EAC-CPF instance.
<localTypeDeclaration> - Optional. Contains information about local conventions used in the @localType attribute.
<localControl> - Optional. Contains any administrative metadata necessary due to local practice that are not represented by the other elements in .
<maintenanceHistory> - Required. Contains information about the date, type and events within the life cycle of an EAC-CPF instance.
<sources> - Optional. Contains information about the sources consulted in creating the description of the entity or entities in the EAC-CPF instance.
<representation> - Optional. Used for recording a link to a transformed and deliverable version of the EAC-CPF instance.

Attribute Usage:
@maintenanceStatus is a required attribute of <control> that is used to document the current version status of the EAC-CPF instance.
@publicationStatus is an optional attribute that can be used to record the editorial status of the EAC-CPF instance.

Availability: Required, not repeatable

@SJagodzinski

This comment has been minimized.

This was referenced Sep 22, 2020
@kerstarno kerstarno self-assigned this Oct 14, 2020
@kerstarno
Copy link
Contributor

kerstarno commented Oct 14, 2020

Schema team, schema tests:

I've tested the draft XSD and RNG schemas for EAC-CPF 2.0 with regard to "control" and can confirm the following:

  • <control> itself is required in order to have a valid EAC-CPF 2.0 file in both XSD and RNG
  • <control> itself cannot be repeated
  • <control> requires the sub-elements <recordId>, <maintenanceAgency> and <maintenanceHistory> in both XSD and RNG
  • <control> furthermore allows for the optional elements <otherRecordId>, <representation>, <languageDeclaration>, <conventionDeclaration>, <localControl>, <localTypeDeclaration>, <rightsDeclaration>, and <sources> as sub-elements in both XSD and RNG
  • <control> requires the attribute @maintenanceStatus
  • <control> also allows for the optional attributes @audience, @id, @base, @publicationStatus, @languageOfElement, @scriptOfElement, @countryEncoding, @dateEncoding, @languageEncoding, @repositoryEncoding, and @scriptEncoding
  • <control> also allows for the inclusion of attributes from other namespaces - I've tested with some XLink attributes, which validated fine in XSD and RNG

Schema test successful. Detailed tests for sub-elements and attributes to follow within the according element and attribute issues.

@kerstarno kerstarno added the Tested by Schema Team Passed both the RNG and XSD schemas. label Oct 27, 2020
@kerstarno kerstarno modified the milestones: Schema, Tag Library Nov 6, 2020
@kerstarno kerstarno mentioned this issue Jan 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants