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

Links to vocabularies in <controlAccess> sub-elements (and others) #13

Closed
2 of 9 tasks
kerstarno opened this issue Jul 30, 2020 · 5 comments
Closed
2 of 9 tasks
Assignees
Labels
Attributes This issue relates to the attributes module EAD major revision (EAD 4.0) This issue is part of the EAD major revision towards EAD 4.0 EAD Schema (general) This relates to a change in the general schema for EAD ead-archDesc This issue relates to the ead-archDesc module ead-findAidDesc This issue relates to the ead-findAidDesc module (currently still named ead-fileDesc) Implemented in draft version This has been implemented in draft version Models and shared elements This issue relates to the models-and-shared-elements module

Comments

@kerstarno
Copy link

kerstarno commented Jul 30, 2020

Creator of issue

  1. Kerstin Arnold
  2. TS-EAS EAD team lead
  3. @kerstarno

The issue relates to

  • EAC-CPF schema issue
  • EAC-CPF Tag Library issue
  • EAD schema issue
  • EAD Tag Library issue
  • Schema issue
  • Tag Library issue
  • Suggestions for all schemas
  • Suggestions for all Tag Libraries
  • Other

Wanted change/feature

  • Text: A new set of attributes dedicated to referencing vocabularies and specific entries from vocabularies should be added. These would focus on encoding URI-s, for the vocabulary source in general and for the specific entry, as well as allowing for a vocabulary source to be provided as a literal. These attributes would be made available with all elements that might contain terms from vocabularies, ontologies, thesauri, etc. - either themselves or their sub-elements.

Suggested Solution

  • Text: Rename attribute @identifier to @valueURI. Rename attribute @source to @vocabularySource. Add new attribute @vocabularySourceURI. Enable these attributes with appropriate elements.
@kerstarno kerstarno changed the title Placeholder preparing for the next major revision - Rename @identifier to @valueuri and @source to @vocabularysource Placeholder preparing for the next major revision - Rename @identifier to @valueURI and @source to @vocabularySource Mar 19, 2021
@fordmadox fordmadox transferred this issue from SAA-SDT/EAD3 Oct 28, 2022
@kerstarno kerstarno changed the title Placeholder preparing for the next major revision - Rename @identifier to @valueURI and @source to @vocabularySource Links to vocabularies in <controlAccess> sub-elements Jul 16, 2023
@kerstarno kerstarno changed the title Links to vocabularies in <controlAccess> sub-elements Links to vocabularies in <controlAccess> sub-elements (and others) Jul 19, 2023
@kerstarno kerstarno changed the title Links to vocabularies in <controlAccess> sub-elements (and others) Links to vocabularies in <controlAccess> sub-elements Jul 19, 2023
@kerstarno kerstarno changed the title Links to vocabularies in <controlAccess> sub-elements Links to vocabularies in <controlAccess> sub-elements (and others) Jul 19, 2023
@kerstarno kerstarno added EAD Schema (general) This relates to a change in the general schema for EAD Implement This has been decided to be implemented Attributes This issue relates to the attributes module ead-archDesc This issue relates to the ead-archDesc module ead-findAidDesc This issue relates to the ead-findAidDesc module (currently still named ead-fileDesc) Models and shared elements This issue relates to the models-and-shared-elements module EAD major revision (EAD 4.0) This issue is part of the EAD major revision towards EAD 4.0 labels Jul 22, 2023
@kerstarno
Copy link
Author

kerstarno commented Jul 22, 2023

Update (4 January 2024):
Following the EAD team's meeting on 15 December and in relation to the change suggested with #67, the details of this issue have been updated (see the comment after the next one). The current development version of the schema still represents what is outlined in this comment, though further changes are necessary, which might require another round of testing.

This issue looks at the use of vocabulary attributes that mainly appear within the sub-elements of <controlAccess>, but are also used in some other elements of EAD. Out of the ten sub-elements of <controlAccess>, <geogname> is excluded as it will be dealt with differently in the context of aligning the encoding of places and place names between EAD and EAC-CPF (see #42).

Note for working on and testing this issue: When the schema changes are done in development branch, please mark the tasks on the highest levels of the list (printed in bold) by ticking the box. When the changes have been tested successfully, please mark the tasks on the lowest level of the list.

  • Replace @identifier with @valueURI; change data type from token to anyURI (note: while anyURI is stricter than token, it still is rather generic; as long as values don't make inappropriate use of reserved characters, such as containing multiple # characters or having % characters that are not followed by two hexadecimal digits, values of @identifier should remain technically valid also in @valueURI when transformed from EAD3 to EAD 4.0)
    • In <corpName>
    • In <famName>
    • In <persName>
    • In <name>
    • In <function>
    • In <occupation>
    • In <subject>
    • In <genreForm>
    • In <title>
    • In <dao>
    • In <unitId>
    • In <unitType>
    • In <physFacet>
  • Replace @source with @vocabularySource
    • In <corpName>
    • In <famName>
    • In <persName>
    • In <name>
    • In <function>
    • In <occupation>
    • In <subject>
    • In <genreForm>
    • In <title>
    • In <unitType>
    • In <physFacet>
  • Add @vocabularySourceURI (data type: anyURI) to
    • <corpName>
    • <famName>
    • <persName>
    • <name>
    • <function>
    • <occupation>
    • <subject>
    • <genreForm>
    • <title>
    • <unitType>
    • <physFacet>
  • Remove @rules from (note: all of these will include @conventionDeclarationReference in EAD 4.0, which can be used to point to rules referenced and/or described in <conventionDeclaration>, see Add @conventionDeclarationReference, @maintenanceEventReference, and @sourceReference to EAD #11)
    • <corpName>
    • <famName>
    • <persName>
    • <name>
    • <function>
    • <occupation>
    • <subject>
    • <genreForm>
    • <title>
    • <unitType>
    • <physFacet>
  • Remove @normal from
    • <corpName>
    • <famName>
    • <persName>
    • <name>
    • <function>
    • <occupation>
    • <subject>
    • <genreForm>
    • <title>
  • Remove @relator from
    • <corpName>
    • <famName>
    • <persName>
    • <name>
    • <function>
    • <occupation>
    • <subject>
    • <genreForm>
    • <title>
  • Add <targetRole> as an optional and repeatable sub-element to
    • <corpName>
    • <famName>
    • <persName>
    • <name>
    • <function>
    • <occupation>
    • <subject>
    • <genreForm>
    • <title>

Additionally, for alignment with EAC-CPF with regard to shared elements:

  • Remove @identifier, @source, @rules from <term> without replacement (currently only in EAC-CPF, though, after the removal of <localControl>)
  • Remove @identifier, @source, @rules from <part> without replacement

@fordmadox
Copy link
Member

Ready for testing.

@kerstarno kerstarno added Ready for testing This is ready for testing and removed Implement This has been decided to be implemented labels Dec 20, 2023
@kerstarno
Copy link
Author

kerstarno commented Jan 4, 2024

Update (4 January 2024) to the original details from July 2023 (see comment before the previous one)

Building on the change suggested with #67, the remaining changes to take care of in this issue here are:

  • Replace @identifier with @valueURI; change data type from token to anyURI (note: while anyURI is stricter than token, it still is rather generic; as long as values don't make inappropriate use of reserved characters, such as containing multiple # characters or having % characters that are not followed by two hexadecimal digits, values of @identifier should remain technically valid also in @valueURI when transformed from EAD3 to EAD 4.0)
    • In <function>
    • In <subject>
    • In <title>
    • In <unitId>
    • In <unitType>
    • In <physFacet>
  • Replace @source with @vocabularySource
    • In <function>
    • In <subject>
    • In <title>
    • In <unitType>
    • In <physFacet>
  • Add @vocabularySourceURI (data type: anyURI) to
    • <function>
    • <subject>
    • <title>
    • <unitType>
    • <physFacet>
  • Remove @rules from (note: all of these will include @conventionDeclarationReference in EAD 4.0, which can be used to point to rules referenced and/or described in <conventionDeclaration>, see Add @conventionDeclarationReference, @maintenanceEventReference, and @sourceReference to EAD #11)
    • <function>
    • <subject>
    • <title>
    • <unitType>
    • <physFacet>
  • Remove @normal from
    • <function>
    • <subject>
    • <title>
  • Remove @relator from
    • <function>
    • <subject>
    • <title>
  • Add <targetRole> as an optional and repeatable sub-element to
    • <function>
    • <subject>

Additionally, for alignment with EAC-CPF with regard to shared elements:

  • Remove @identifier, @source, @rules from <term> without replacement
  • Remove @identifier, @source, @rules from <part> without replacement

New, as missed in the original comment:

  • Add @vocabularySource (data type: token) and @vocabularySourceURI (data type: anyURI) to <unitId> to ensure that the three vocabulary attributes are always used together

Explanation regarding the changes compared to the original comment: <corpname>, <famname>, <name> and <persname> as sub-elements of <controlaccess> will all become <agent> (#58); <occupation> and <genreform> as sub-elements of <controlaccess> will be incorporated as subject headings (#67); <title> as sub-element of <controlaccess> will be suggested to be moved to <bibliography>, now renamed <publicationNote>, but will still be used in <findAidDesc> (#27) ; all of these elements when used in mixed content contexts will be incorporated as <referringString> (#63); <dao> will become <formAvailable> (#65)

@karinbredenberg
Copy link
Member

All that are ready have been tested.

@karinbredenberg karinbredenberg added the Needs more work This has been tested unsuccessfully and needs more work label Jan 9, 2024
@kerstarno kerstarno removed the Ready for testing This is ready for testing label Jan 12, 2024
@fordmadox fordmadox removed the Needs more work This has been tested unsuccessfully and needs more work label Jan 16, 2024
@fordmadox fordmadox added the Ready for testing This is ready for testing label Jan 16, 2024
@kerstarno
Copy link
Author

Retested with XSD and RNG and can confirm that all the above changes are now in place.

There were some changes required to how <title> was defined in addition to the aspects mentioned above. I created a pull request (#75) for those. As these changes, however, do not affect this issue here, I will mark it as tested successfully.

@kerstarno kerstarno assigned fordmadox and unassigned kerstarno Jan 16, 2024
@kerstarno kerstarno added Tested successfully This is has been tested successfully and is considered done in the development branch and removed Ready for testing This is ready for testing labels Jan 16, 2024
@kerstarno kerstarno assigned kerstarno and unassigned fordmadox Jan 18, 2024
@kerstarno kerstarno added Implemented in draft version This has been implemented in draft version and removed Tested successfully This is has been tested successfully and is considered done in the development branch labels Jan 18, 2024
@kerstarno kerstarno moved this from Review to Merged in Major EAD revision Jan 18, 2024
@github-project-automation github-project-automation bot moved this from Merged to Ready for testing in Major EAD revision Jan 29, 2024
@kerstarno kerstarno moved this from Ready for testing to Merged in Major EAD revision Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Attributes This issue relates to the attributes module EAD major revision (EAD 4.0) This issue is part of the EAD major revision towards EAD 4.0 EAD Schema (general) This relates to a change in the general schema for EAD ead-archDesc This issue relates to the ead-archDesc module ead-findAidDesc This issue relates to the ead-findAidDesc module (currently still named ead-fileDesc) Implemented in draft version This has been implemented in draft version Models and shared elements This issue relates to the models-and-shared-elements module
Projects
Archived in project
Development

No branches or pull requests

3 participants