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

Proposal to deprecate or remove <sourceEntry> and use <citation> instead #139

Closed
2 of 9 tasks
kerstarno opened this issue Apr 3, 2020 · 5 comments
Closed
2 of 9 tasks

Comments

@kerstarno
Copy link
Contributor

kerstarno commented Apr 3, 2020

Creator of issue

  1. EAC-CPF team
  2. TS-EAS
  3. @kerstarno @fordmadox

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

Reporting a bug

  • Text:

Suggested Solution

  • Text:

Steps to Reproduce (for bugs)

Context

  • Text:

Your Environment can be a clue to a bug

  • Version used:
  • Environment name and version (e.g. Chrome 39, node.js 5.4):
  • Operating System and version (desktop or mobile):
@kerstarno
Copy link
Contributor Author

<sourceEntry> is currently optional and only used in this very specific context, while <citation> seems to fulfil a similar purpose at least.

For reference

  • The EAC-CPF tag library summarise <sourceEntry> as "textual identification, such as a title, for a particular source of evidence" and describes the element as "identif[ying] a source directly rather than using other content in or " and as "generally contain[ing] free text".

  • The EAD3 tag library summarise <sourceEntry> as "identif[ying] a specific source" and describes the element as being "used for brief citation information" - so, maybe as a short version of what would be encoded in <citation>? - and states that "any additional information should be provided in <descriptivenote>".

  • With regard to <citation>, which is available in various contexts within EAC-CPF, the tag library summarises that the element "cites an external resource" and specifies that it "points to a resource that provides descriptive data which is not otherwise given" and "should not be confused with the element which is used to declare a particular resource used in the composition of the EAC-CPF instance".

  • In EAD3, <citation> is only used with the elements <conventiondeclaration>,<localtypedeclaration>, and <rightsdeclaration> and is hence summarised as "identif[ying] any rules and conventions" and described as "cit[ing] an external resource in human and/or machine-processable form".

    • For "provid[ing] a link to content that may be internal or external to the finding aid" in any other contexts, EAD3 uses <ref>.

Decisions in this issue need to be reflected in #108 as well.

@kerstarno
Copy link
Contributor Author

kerstarno commented Apr 3, 2020

Aspects to consider:

  • Based on the exmaples used in both tag libraries, <sourceEntry> seems to be meant to mainly capture the title/name of a source, while <citation> - especially in EAC-CPF - seems to aim ate to encoding more complete bibliographic information of a cited resource.
  • The content model for <sourceEntry> in both EAS is more closely related. In both EAS, <sourceEntry> can only have [text], while <citation> can have [text] and <span> in EAC-CPF, but <abbr>, <emph>, <expan>, <foreign>, <lb>, <ptr>, and <ref> in EAD3, which might have an impact with regard to reconciliation.
  • <citation> can be used with linking attributes, while <sourceEntry> does not provide this option. The parent element in this case, <source>, also comes with the same linking attributes. If we did replace <sourceEntry> with <citation>, where would we then expect users to include information for online resources?

@fordmadox
Copy link
Member

Agreed with all of the above points that need to be considered. Just a quick note for now, though, regarding an upcoming / related change in SNAC. See https://portal.snaccooperative.org/node/486.

The "Source Name" field is being removed in favor of the "Citation" field, and editors will be able to search and select Citations directly instead of needing to search by Source Names from the Cite button on specific SNAC elements.

@SJagodzinski
Copy link
Contributor

SJagodzinski commented Oct 8, 2020

The proposal to replace <sourceEntry> by <citation> in the topic paper on Assertion description was accepted during the Berlin meeting on 9 March 2020.

Later on, it was decided to change the elements name from <citation> into <reference>, cf #102

@kerstarno
Copy link
Contributor Author

Not that I'd argue for keeping <sourceEntry> at any costs, especially after the general question about this being an "entry" element discussed during the last EAC team meeting, but wasn't this still a pending question according to the Berlin minutes? Maybe good to reconfirm during the next EAC team meeting?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants