search

SAA-SDT / EAS-TagLibraries

Tag Libraries for Encoded Archival Description Version 3 and Encoded Archival Context: Corporate Bodies, Persons, and Families
7 stars 5 forks source link

Create and update TEI XML files (group 5) as part of creating a draft EAD 4.0 Tag Library #139

Closed kerstarno closed 1 month ago

kerstarno commented 3 months ago

Creator of issue

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

The issue relates to

Wanted change/feature

kerstarno commented 3 months ago

Couldn't find Venkat as a member of the SAA-SDT workspace and there's more than one on GitHub, so just mentioning here that this is a shared assignment.

cartivist commented 3 months ago

I have become rather confused about </a>. It sounds like it now does what <code><titleproper></code> did in EAD3 and does not do what <code><title></code> did in EAD3. I have struggled to explain in 'See also' what to do about other kinds of titles.</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/kerstarno"><img src="https://avatars.githubusercontent.com/u/39343300?v=4" />kerstarno</a> commented <strong> 3 months ago</strong> </div> <div class="markdown-body"> <p>Hi @cartivist - thanks for the question re <code><title></code>. </p> <p>Its foreseen usage in EAD 4.0 is indeed focussing in on the context of <code><findAidDesc></code> only, i.e. on titles identifying different instantiations of the finding aid as a resource. </p> <p>Looking at the draft for <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/elem-title.xml"><title></a>, it might be an option to already make this clearer in the summary, e.g. by saying "formal name of a finding aid" rather than the more general "formal name of a work". </p> <p>In the description, it could then be an option to give some more examples for the usage of <code><title></code> within <code><findAidDesc></code>, e.g. something like:</p> <ul> <li>Use <code>@localType</code> with <code><title></code> to differentiate between the general title and a subtitle or the title of an overarching series. </li> <li>Use the sub-element <code><part></code> to break a title down into aspects such as an edition statement ("2nd edition").</li> <li>Use repeated <code><title></code> elements distinguished by their <code>@localType</code>-s when describing e.g. a .pdf or a .docx instantiation of a finding aid to give the publication title for display on the one hand and the file title of the .pdf or the .docx file on the other hand.</li> </ul> <p>With regard to the "See also" section, I think you've actually described these alternatives fine. The only thing that I'd do differently is that I'd not mention <code><referringString></code> here. While the note you have included isn't incorrect, it's more a note that is relevant in the context of moving from an EAD3 to an EAD 4.0 XML document. I would, however, not include it in the tag library when describing what <code><title></code> is used for in EAD 4.0. </p> <p>Hope that makes sense. </p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/cartivist"><img src="https://avatars.githubusercontent.com/u/30256365?v=4" />cartivist</a> commented <strong> 3 months ago</strong> </div> <div class="markdown-body"> <p>Thank you - now amended.</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/vns2"><img src="https://avatars.githubusercontent.com/u/4581081?v=4" />vns2</a> commented <strong> 3 months ago</strong> </div> <div class="markdown-body"> <p>I am a little confused about <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/shared/en/attr-status.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/shared/en/attr-status.xml</a>. Tried to incorporate the procedure outlined in the tutorial (thanks, all!), but would be grateful if this can be glanced at once - is this grammar consistent with the rest of the edits, @cartivist ?</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/vns2"><img src="https://avatars.githubusercontent.com/u/4581081?v=4" />vns2</a> commented <strong> 3 months ago</strong> </div> <div class="markdown-body"> <p>For attributes like <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/shared/en/attr-calendar.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/shared/en/attr-calendar.xml</a>, <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/shared/en/attr-certainty.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/shared/en/attr-certainty.xml</a>, <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/shared/en/attr-era.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/shared/en/attr-era.xml</a> @kerstarno : How are we incorporating 'potential future change in EAC-CPF (using data type token instead of NMTOKEN)' in the datatype? Hope the way I have done it is appropriate?</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/vns2"><img src="https://avatars.githubusercontent.com/u/4581081?v=4" />vns2</a> commented <strong> 3 months ago</strong> </div> <div class="markdown-body"> <p>For attributes like <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-descriptionOfComponentsType.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-descriptionOfComponentsType.xml</a>, <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-level.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-level.xml</a> @kerstarno @cartivist Slightly confused about reading the EAD4 schema. Do I have it right that the datatype is token as per EAD4 schema? And do we retain any predefined values from previous schema? Thanks.</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/kerstarno"><img src="https://avatars.githubusercontent.com/u/39343300?v=4" />kerstarno</a> commented <strong> 3 months ago</strong> </div> <div class="markdown-body"> <p>Hi @vns2 - thanks for your questions. </p> <p>As for <code>@calendar</code>, <code>@certainty</code>, and <code>@era</code> your edits are correct, i.e. having two <code><p></code> within <code><div type="datatype"></code> and using one <code><p></code> with <code>@type="eac"</code> and the other with <code>@type="ead"</code> to cater for the currently different data types.</p> <p>For <code>@status</code> I added one further sentence in the <code><p type="ead"></code> of the description in order to refer to the new attribute <code>@statusEncoding</code> in <code><control></code>. With this attribute, one can indicate if the "EASList" of values (essentially those values that were previously defined in the schema) are used or if an "otherStatusEncoding" approach is applied. </p> <p>The same is true for <code>@descriptionOfComponentsType</code> and <code>@level</code>. <code>@descriptionOfComponentsTypeEncoding</code> and <code>@levelEncoding</code> in <code><control></code> are meant to detail whether the EAS lists of values are used or if there are other value lists applied. With this, attributes like <code>@otherlevel</code> from EAD3 are obsolete. </p> <p>I have just updated <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-status.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-status.xml</a>, <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-descriptionOfComponentsType.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-descriptionOfComponentsType.xml</a>, and <a href="https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-level.xml">https://github.com/SAA-SDT/EAS-TagLibraries/blob/ead4/tei/ead4/en/attr-level.xml</a>, if you'd want to have another look. Hope it makes sense. Please feel free to adapt the phrasing if necessary.</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/vns2"><img src="https://avatars.githubusercontent.com/u/4581081?v=4" />vns2</a> commented <strong> 3 months ago</strong> </div> <div class="markdown-body"> <p>Thanks, @kerstarno Sorry about missing that earlier. I have made some small changes to the sentence. Should be okay, I think?</p> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/kerstarno"><img src="https://avatars.githubusercontent.com/u/39343300?v=4" />kerstarno</a> commented <strong> 2 months ago</strong> </div> <div class="markdown-body"> <p>TEI XML files listed in this issue are considered ready for implementation in a first draft EAD 4.0 Tag Library (pending the fixing of potential encoding issues which might be found during the process of creating the Tag Library PDF).</p> </div> </div> <div class="page-bar-simple"> </div> <div class="footer"> <ul class="body"> <li>© <script> document.write(new Date().getFullYear()) </script> Githubissues.</li> <li>Githubissues is a development platform for aggregating issues.</li> </ul> </div> <script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script> <script src="/githubissues/assets/js.js"></script> <script src="/githubissues/assets/markdown.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script> <script> hljs.highlightAll(); </script> </body> </html>