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

<conventionDeclaration> #100

Open
SJagodzinski opened this issue Jan 20, 2020 · 5 comments
Open

<conventionDeclaration> #100

SJagodzinski opened this issue Jan 20, 2020 · 5 comments
Assignees
Labels

Comments

@SJagodzinski
Copy link
Contributor

SJagodzinski commented Jan 20, 2020

Convention Declaration

  • add attributes:
    @audience
    @scriptOfElement
    @valueURI
    @vocabularySource
    @vocabularySourceURI
  • review attributes:
    a) remove xml namespace
  • keep element definition

Creator of issue

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

Related issues / documents

<conventionDeclaration>: add sub-elements #67

EAD3 Reconciliation

Additional EAD 3 attributes
@altrender - Optional
@audience - Optional (values limited to: external, internal)
@encodinganalog - Optional
@localype - Optional
@script - Optional

Context

A declaration of the rules or conventions, including authorized controlled vocabularies and thesauri, applied in creating the EAC-CPF instance.

May contain: <abbreviation>, <citation>, <descriptiveNote>
May occur within: <control>
Attributes: @xml:id, @xml:lang - all optional
Availability: Optional, Repeatable

Solution documentation

May contain: <shortCode>, <reference>, <descriptiveNote>
May occur within: <control>
Attributes:
@audience - optional (values limited to: external, internal)
@id - optional
@languageOfElement - optional
@scriptOfElement - optional
@valueURI - optional
@vocabularySource - optional
@vocabularySourceURI - optional
Availability: Optional, repeatable

  • New or other example needed
  • Topic for Best Practise Guide:
    Recommend to use <descriptiveNote> to enter an institution responsible for this convention.
    Recomment to declare transliteration rules/standards within <conventionDeclaration> and refer to this element for this kind of information.

Example encoding

<control>
 <recordId>record identifier</recordId>
 <maintenanceStatus value="new"/>
 <publicationStatus value="inprocess"/>
 <maintenanceAgency> [...] </maintenanceAgency>
 <conventionDeclaration audience="external" id="conventiondeclaration1" languageOfElement="en" scriptOfElement="lat" valueURI="conventionURI" vocabularySource="source" vocabularySourceURI="sourceURI">
  <shortCode>acronym, abbreviation or short code of the convention</shortCode>
  <reference>externe reference to the convention</reference>
  <descriptiveNote>
    <p>decriptive note for convention declaration</p>
  </descriptiveNote>
 </conventionDeclaration>
 <maintenanceHistory>   [...]  </maintenanceHistory>
</control>
@SJagodzinski

This comment has been minimized.

@SJagodzinski SJagodzinski added this to the Schema milestone Sep 30, 2020
@ailie-s
Copy link

ailie-s commented Oct 2, 2020

Draft Tag Library Text:

Summary: An optional child element of <control>, used to declare the rules or conventions, including authorized controlled vocabularies and thesauri, applied in creating the EAC-CPF instance.
May contain: <descriptiveNote> (0..1), <reference> (1..1), <shortCode> (0..1)
May occur within: <control>
Attributes:
@audience - optional (values limited to: external, internal)
@id - optional
@languageOfElement - optional
@scriptOfElement - optional
@valueURI - optional
@vocabularySource - optional
@vocabularySourceURI - optional
Description and Usage:
<conventionDeclaration> is used for declaring references to any rules and conventions, including authorized controlled vocabularies or thesauri, applied in the construction of the description. The element binds together the required <reference> element with optional <shortCode> and <descriptiveNote> elements that identify rules or conventions applied in compiling the EAC-CPF instance.
Each additional rule or set of rules, controlled vocabulary, or standard should be contained in a separate <conventionDeclaration>.
<shortCode> may be used to identify the standard or controlled vocabulary in a coded structure. Any notes relating to how these rules or conventions have been used may be given within <descriptiveNote>.
It may not be necessary to include <conventionDeclaration> in such cases where the above scenarios are addressed in local documentation.
Availability: Optional, repeatable

@kerstarno kerstarno self-assigned this Jan 14, 2021
@kerstarno
Copy link
Contributor

Tested as part of Schema Team's schema testing:

  • <conventionDeclaration> is an optional sub-element of <control>
  • <conventionDeclaration> can be repeated
  • <conventionDeclaration> requires the sub-element <reference> to be present
  • <conventionDeclaration> furthermore allows for the optional sub-elements <shortCode> and <descriptiveNote>
  • None of the sub-element of <conventionDeclaration> can be repeated
  • <conventionDeclaration> also allows for the optional attributes @audience, @id, @target, @languageOfElement, @scriptOfElement, @valueURI, @vocabularySource, and @vocabularySourceURI
  • Lastly, <conventionDeclaration> allows for optional attributes from other namespaces (tested with XLink)

The above applies to RNG and XSD schemas.

The element is ready.

@ailie-s - the draft TL above is currently missing @target.

@kerstarno kerstarno added the Tested by Schema Team Passed both the RNG and XSD schemas. label Jan 14, 2021
@kerstarno kerstarno modified the milestones: Schema, Tag Library Jan 14, 2021
@fordmadox

This comment has been minimized.

@kerstarno

This comment has been minimized.

@SJagodzinski SJagodzinski assigned SJagodzinski and unassigned ailie-s Mar 27, 2021
@SJagodzinski SJagodzinski removed this from the Tag Library milestone Feb 20, 2022
@SJagodzinski SJagodzinski added this to the Best Practise Guide milestone Feb 20, 2022
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