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.

Sign up for GitHub

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

Jump to bottom

Add a new element <referringString> #63

Closed
58 of 65 tasks
kerstarno opened this issue Dec 1, 2023 · 7 comments
Closed
58 of 65 tasks

Add a new element <referringString> #63

kerstarno opened this issue Dec 1, 2023 · 7 comments
Assignees
@kerstarno
Labels
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 Implemented in draft version This has been implemented in draft version
Milestone
First draft of EA...

Comments

@kerstarno
Copy link

kerstarno commented Dec 1, 2023 •
edited
Loading

Creator of issue

  1. Kerstin Arnold
  2. TS-EAS EAD team lead
  3. @kerstarno
  4. [email protected]

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: During their meeting on 24 November 2023, the EAD subteam of TS-EAS suggested to introduce a new element called <referringString> to allow for the tagging of named entities within textual descriptions using one dedicated element instead of having a long list of mixed content elements to take into account. This would also allow for <span> to be more specifically used for formatting and highlighting aspects by using @style (as it has been in EAC-CPF all along).
  • <referringString> should hence be added in all contexts that allow for <span>. (status of this needs to be reviewed in the current (1 December 2023) draft schema for EAD 4.0)
  • <referringString>
    • Can contain text
    • Is optional and repeatable in all contexts
    • Allows for the optional attributes @audience, @id, @target, @languageOfElement, @scriptOfElement, @conventionDeclarationReference, @maintenanceEventReference, @sourceReference, @localType, and @localTypeDeclarationReference
    • Allows for the optional attributes @valueURI, @vocabularySource, and @vocabularySourceURI
    • Allows for the inclusion of attributes from any other namespaces

Update (5 January 2024):
Following the EAD team's meeting on 15 December, the details of this issue have been updated to the latest status with the additions below this paragraph. The current development version of the schema might still represent what was outlined initially, while further changes might be necessary and require another round of testing.

Ultimately, the introduction of <span> (which replaces <emph>, see #71) and <referringString> along with the use of <reference> will lead to a minimal mixed content model in the EAD 4.0 general schema, which might be further reduced in the core schema.

  • Replace <abbr(eviation)>, <expan(sion)>, and <foreign> with <referringString> in
    • <container>
    • <dimensions>
    • <head>
    • <materialSpec>
    • <num>
    • <physDesc>
    • <physFacet>
    • <physLoc>
    • <unitDate>
    • <unitId>
    • <unitTitle>
  • Combine <ptr> with <reference> in
    • <container>
    • <dimensions>
    • <head>
    • <materialSpec>
    • <num>
    • <physDesc>
    • <physFacet>
    • <physLoc>
    • <unitDate>
    • <unitId>
    • <unitTitle>
  • Replace <corpname>, <date>, <famname>, <function>, <genreform>, <geogname>, <name>, <num>, <occupation>, <persname>, <subject>, and <title> with <referringString> in
    • <physFacet>
    • <unitTitle>
  • Replace <footnote> and <quote> with <span> in
    • <physFacet>
    • <unitTitle>
  • Remove <lb> from

For <identificationDataNote> (was: <didNote>), which currently also includes the above mentioned sub-elements, a different approach is taken:

  • Align the content model of <identificationDataNote> with the one of <descriptiveNote>
    • Remove <abbr(eviation)>, <expan(sion)>, <foreign>, <ptr>, <ref>, <emph> and <lb> from <didNote>
    • Add <p> as required and repeatable sub-element instead
    • Adapt @audience
    • Add @target as an optional attribute
    • Rename @lang to @languageOfElement and @script to @scriptOfElement
    • Add the optional attributes @conventionDeclarationReference, @maintenanceEventReference, and @sourceReference
    • Add the option to include attributes from any other namespace
    • Remove @altrender, @localtype, @label, and @encodinganalog

For the alignment of the descriptive, shared elements <abstract>,<reference> (replacing <ref>, see #40), and <p> see #47.
For the alignment of data-centric, shared elements such as <addressLine> or the single date elements in terms of mixed content see #70.
@kerstarno kerstarno mentioned this issue Dec 1, 2023
Closed
14 tasks
@fordmadox
Copy link
Member

fordmadox commented Dec 15, 2023 •
edited
Loading

Available for testing in the development branch.

Note: currently, "reference/span" is allowed in EAC-CPF / EAD4, so "reference/referringString" is also permitted in the above branch.

@fordmadox fordmadox added the Ready for testing This is ready for testing label Dec 15, 2023
@fordmadox fordmadox removed their assignment Dec 22, 2023
This was referenced Jan 4, 2024
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@kerstarno
Copy link
Author

Tested with the XSD and the RNG.

Most of the above has been implemented as expected, apart from:

  • <head> should still kept in EAD 4.0 for use within <did> and the numbered and unnumbered <c> elements, but has currently been removed; hence the changes here cannot be checked
  • <num> should have been removed (apologies for the mixed messages in the original post)
  • @localType is still included in <identificationDataNote>, but should be removed (same for @localTypeDeclaration)

I created a pull request for the above pending changes (#80). Once the pull request has been merged, this issue will need retesting.

@kerstarno kerstarno assigned fordmadox and unassigned kerstarno Jan 17, 2024
@kerstarno kerstarno added EAD Schema (general) This relates to a change in the general schema for EAD Needs more work This has been tested unsuccessfully and needs more work ead-archDesc This issue relates to the ead-archDesc module EAD major revision (EAD 4.0) This issue is part of the EAD major revision towards EAD 4.0 and removed Ready for testing This is ready for testing labels Jan 17, 2024
This was referenced Jan 17, 2024
Closed
Closed
Closed
@fordmadox
Copy link
Member

Sorry, I had thought that head was going away with a suggestion for folks to use h1-h6 in its place, so thanks for adding that back in. Should be ready for testing again now.

@fordmadox fordmadox added Ready for testing This is ready for testing and removed Needs more work This has been tested unsuccessfully and needs more work labels Jan 18, 2024
@fordmadox fordmadox removed their assignment Jan 18, 2024
@kerstarno
Copy link
Author

Sorry, I had thought that head was going away with a suggestion for folks to use h1-h6 in its place, so thanks for adding that back in. Should be ready for testing again now.

Thanks. And, yes, it's a bit confusing. <head> is only kept in those contexts where it wasn't used alongside the block formatting elements. In those contexts, where <head> went side-by-side with <p>, <list>, etc. it's been removed as it would be taken care of by using <h1> etc. within <formattingExtension>.

@kerstarno kerstarno moved this to Ready for testing in Major EAD revision Jan 18, 2024
@kerstarno
Copy link
Author

Re-tested with the XSD and RNG and can confirm that the remaining changes have now been implemented as expected.

@kerstarno kerstarno removed the Ready for testing This is ready for testing label Jan 18, 2024
@kerstarno kerstarno moved this from Ready for testing to Merged in Major EAD revision Jan 18, 2024
@kerstarno kerstarno added the Implemented in draft version This has been implemented in draft version label 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
@florenceclavaud
Copy link
Member

Hi everybody, what about adding to the new referringString element an attribute to specify the kind of relation that exists between the records described and the entity that is referred to (just as we have the relationType element elsewhere)? This would be great for some users at least, otherwise they may be compelled to encode, out of the textual element, a minimal description of the agent, place, function or subject referred to, in addition to using referrinString, which would be somewhat redundant.
I hope I am clear.

@kerstarno
Copy link
Author

Hi everybody, what about adding to the new referringString element an attribute to specify the kind of relation that exists between the records described and the entity that is referred to (just as we have the relationType element elsewhere)? This would be great for some users at least, otherwise they may be compelled to encode, out of the textual element, a minimal description of the agent, place, function or subject referred to, in addition to using referrinString, which would be somewhat redundant. I hope I am clear.

I've added this suggestion as #111 for the next milestone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kerstarno kerstarno

Labels
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 Implemented in draft version This has been implemented in draft version
Projects
Major EAD revision
Archived in project
Milestone
First draft of EAD 4.0 for aggregator...
Development

No branches or pull requests
3 participants
@fordmadox @florenceclavaud @kerstarno