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

Introduce a new <formattingExtension> element as a choice next to <p> to group current formatting elements #62

Closed
kerstarno opened this issue Nov 24, 2023 · 16 comments
Closed

Introduce a new <formattingExtension> element as a choice next to <p> to group current formatting elements #62

kerstarno opened this issue Nov 24, 2023 · 16 comments
Assignees
@kerstarno
Labels
EAC major revision (EAC-CPF 3.0) This issue is part of a future EAC major revision towards EAC-CPF 3.0 eac-description This issue relates to the eac-description 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
Milestone
First draft of EA...

Comments

@kerstarno
Copy link

kerstarno commented Nov 24, 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 27 October 2023, the EAD sub-team of TS-EAS confirmed the introduction of a new element called <formattingExtension> to enable any formatting of text that goes beyond a simple <p> tag. The idea is to add a choice between using just <p> and using <formattingExtension>, which would have a similar function as the element <objectXMLWrap>, but would come with the XHTML namespace predefined and be recommended for use with elements that allow the creation of lists, tables, etc.
  • <formattingExtension> would thereby "incorporate" those elements that the EAS initially adapted/borrowed from HTML and bring them back into their original namespace.
  • In detail, this means that the EAS' focus would be returned to encoding information rather than encoding how this information is formatted by removing any formatting elements other than <p> and <head> (when used with the numbered and unnumbered <c> elements or <did>) from the EAS schemas.

Note for working on and testing this issue: When the schema changes are done in development branch, please mark this by ticking the box for the higher level in the list (printed in bold); once the changes have been tested successfully please mark this by ticking the box on the lower and intermediate (printed in italics) levels.

For changes to <legalStatus> see #5.
For changes regarding <footnote> see #63.
This was referenced Dec 1, 2023
Closed
Open
Open
@fordmadox
Copy link
Member

Just a note that I still need to work on this. I'm unclear if we're going to try to validate a subset of XHTML, or just treat this element like objectXMLWrap in a specific namespace?

@fordmadox fordmadox added the Implement This has been decided to be implemented label Dec 15, 2023
This was referenced Dec 20, 2023
Closed
Closed
This was referenced Jan 4, 2024
Closed
Closed
Closed
Closed
@kerstarno kerstarno changed the title (draft) Introduce a new <formattingExtension> element as a choice next to <p> to group current formatting elements Introduce a new <formattingExtension> element as a choice next to <p> to group current formatting elements Jan 5, 2024
@kerstarno kerstarno added 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) Models and shared elements This issue relates to the models-and-shared-elements module eac-description This issue relates to the eac-description module EAD major revision (EAD 4.0) This issue is part of the EAD major revision towards EAD 4.0 EAC major revision (EAC-CPF 3.0) This issue is part of a future EAC major revision towards EAC-CPF 3.0 labels Jan 5, 2024
@kerstarno
Copy link
Author

Just a note that I still need to work on this. I'm unclear if we're going to try to validate a subset of XHTML, or just treat this element like objectXMLWrap in a specific namespace?

Ideally, we would want to validate a subset of XHTML included in <formattingExtension>, i.e. the element should require a reference to the XHTML namespace as e.g. <dao> used to in EAD 2002 when used with XLink attributes.

@kerstarno
Copy link
Author

For a high-level conversion route (details will follow at a later stage) of the current block elements in EAD3:

  • <blockquote>, <p>, and <table> would become their equivalents in XHTML
  • <list> would become
    • <dl> when used with the @listtype="deflist" and/or with the sub-element <defitem>
    • <ol> when used with the @listtype="ordered" and/or with the attribute @numeration
    • <ul> when used with the @listtype="unordered" and/or with the attribute @mark
    • <ul> when used without any indicating attributes or sub-elements
  • <chronlist> would be transformed into
    • <dl> when used only with <chronitem>, one of the date elements and <event>
    • a <table> with three columns when used only with <chronitem>, one of the date elements, <event>, and <geogname>
    • a <table> with four or more columns when used with <chronitem> including <chronitemset>(with one or more <event> and possibly one or more <geogname> elements) plus one of the date elements

@kerstarno
Copy link
Author

@marieelia - Adding you for information at the moment as this change might then also be applied to EAC-CPF at a later stage. I've currently categorised this as a major revision item.

This was referenced Jan 8, 2024
Closed
Closed
Closed
Closed
@kerstarno
Copy link
Author

With regard to XHTML in <formattingExtension>, I can confirm that I can use any elements in <formattingExtension> and that the XHTML namespace declaration is currently not forced. In testing I created the following example using the selection of elements mentioned above:

<biogHist>
   <formattingExtension xmlns:xhtml="http://www.w3.org/1999/xhtml">
      <xhtml:h1></xhtml:h1>
      <xhtml:h2></xhtml:h2>
      <xhtml:h3></xhtml:h3>
      <xhtml:dl></xhtml:dl>
      <xhtml:ul></xhtml:ul>
      <xhtml:ol></xhtml:ol>
      <xhtml:table></xhtml:table>
      <xhtml:p></xhtml:p>
      <xhtml:blockquote></xhtml:blockquote>
      <xhtml:div></xhtml:div>
   </formattingExtension>
</biogHist>

In the test file validating against the XSD, Oxygen does not suggest any sub-elements, e.g. for the lists or the table element, neither from XHTML, nor EAD. In the test file validating against the RNG, however, Oxygen suggests EAD elements as possible sub-elements of the XHTML elements.

The latter case should definitely be avoided, so a stricter binding to the XHTML namespace might be required here.

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

kerstarno commented Jan 17, 2024 •
edited
Loading

Additionally, and apologies that I am only realising now that this was not specified before: <formattingExtension> should not be repeatable. I.e. there'd be the choice between either a single <formattingExtension> (within which all XHTML elements could then be repeated) or a repeatable <p> element. I added this to the pull request (#80).

@kerstarno kerstarno mentioned this issue Jan 17, 2024
Closed
@fordmadox
Copy link
Member

Regarding the above example, the "formattingExtension" element itself would still need to be in the EAD4 / EAS (if we converge to one namespace, which I think we can) namespace. Alternatively a custom element by that name could be defined for HTML, but I don't know how that would work with how we currently manage our tag library, etc.

Anyhow, I'm going to keep the "Needs More Work" label on this issue for the time being while we work out the validation process for this extension.

@kerstarno
Copy link
Author

Regarding the above example, the "formattingExtension" element itself would still need to be in the EAD4 / EAS (if we converge to one namespace, which I think we can) namespace. Alternatively a custom element by that name could be defined for HTML, but I don't know how that would work with how we currently manage our tag library, etc.

Anyhow, I'm going to keep the "Needs More Work" label on this issue for the time being while we work out the validation process for this extension.

Ah, yes, true. My mistake - misread and misadapted the encoding used for <objectXMLWrap> in the EAC-CPF 2.0 TL... Thanks for the clarification.

@kerstarno kerstarno moved this to In Progress in Major EAD revision Jan 18, 2024
@kerstarno
Copy link
Author

As an interim test report: the choice between <formattingExtension> and <p> is now also available in <descriptionOfComponents> in both, the XSD and the RNG.

However, there's now a difference between the two schema versions:

  • In the RNG, it is correct - <formattingExtension> is not repeatable, while <p> is and both are optional.
  • In the XSD, on the other hand, <formattingExtension> can still be repeated, which should only be possible within <findAidDesc>, but not when used next to <p>.

@fordmadox fordmadox moved this from In Progress to Ready for testing in Major EAD revision Mar 11, 2024
@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 Mar 11, 2024
@fordmadox fordmadox assigned kerstarno and unassigned fordmadox Mar 11, 2024
@fordmadox
Copy link
Member

Note: I've updated this as ready for testing due to updates for the XHTML embedding features being supported now, but I haven't yet the availability issue noted above. I'll keep this issue with labels of both 'ready for testing' and 'needs more work' to cover both features.

@fordmadox fordmadox self-assigned this Mar 11, 2024
@fordmadox fordmadox added the Needs more work This has been tested unsuccessfully and needs more work label Mar 11, 2024
@fordmadox fordmadox moved this from Ready for testing to In Progress in Major EAD revision Mar 11, 2024
@fordmadox fordmadox moved this from In Progress to Ready for testing in Major EAD revision Mar 17, 2024
@fordmadox fordmadox removed the Needs more work This has been tested unsuccessfully and needs more work label Mar 17, 2024
@fordmadox fordmadox removed their assignment Mar 17, 2024
@fordmadox
Copy link
Member

fordmadox commented Mar 17, 2024 •
edited by kerstarno
Loading

Note: I've pushed a quick fix of the RNG + XSD difference regarding the availability of this element within the former dsc and related elements. Should be good to test again.

Another note: See issue #100. I think there is another issue with the RNG / NVDL combo. Won't have time to investigate until after the call for comments goes out, so just an FYI (and why we'll continue to hit the XSD version of the schema in the NVDL file).

@kerstarno kerstarno moved this from Ready for testing to Merged in Major EAD revision Mar 18, 2024
@kerstarno kerstarno added Implemented in draft version This has been implemented in draft version and removed Ready for testing This is ready for testing labels Mar 18, 2024
@kerstarno
Copy link
Author

Retested with XSD and RNG and can confirm, that an choice between <formattingExtension> and <p> is now available with <descriptionOfComponents> and elements such as <scopeContent>, <biogHist> etc. Both elements are optional, <p> can be repeated, <formattingExtension> cannot be repeated.

The only context in which <formattingExtension> is (correctly) repeatable is <findAidDesc>.

For validation against the XHTML namespace see the NVDL file under https://github.com/SAA-SDT/eas-schemas/tree/development/xml-schemas/ead

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

@kerstarno kerstarno

Labels
EAC major revision (EAC-CPF 3.0) This issue is part of a future EAC major revision towards EAC-CPF 3.0 eac-description This issue relates to the eac-description 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
Major EAD revision
Archived in project
Milestone
First draft of EAD 4.0 for aggregator...
Development

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