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

Refactor Presentation XML for terms #630

Open
opoudjis opened this issue Dec 25, 2024 · 7 comments
Open

Refactor Presentation XML for terms #630

opoudjis opened this issue Dec 25, 2024 · 7 comments
Assignees
Labels
enhancement New feature or request

Comments

@opoudjis
Copy link
Contributor

opoudjis commented Dec 25, 2024

Continuing #610

The refactor needed most urgently for the preservation of Semantic XML under Presentation XML is the refactor of how terms are handled. This is a precondition for us to remove the duplication of Semantic XML under Presentation XML, since it was terms Semantic XML that @Intelligent2013 needed to access, that led to him requesting it for Presentation XML.

Terms render Semantic XML in a multitude of ways depending on flavour, each of them currently implemented destructively wrt Semantic XML. The constants across flavours for rendering are:

  • Content may be rendered as a standalone block, or as part of another block. In Presentation XML, we will realise fmt- blocks for the required blocks, and we will use inline semx to relate content rendered inline in a block, back to its source Semantic XML.
    • For example, in some flavours, the designation is rendered as a separate header paragraph. In others, it is rendered inside the same block as the definition.
  • The following is the maximum possible of rendered blocks; any of them (but one) can instead be inline in another block.
    • There is a term name, the number of the term.
    • There is a term primary designation.
    • There are secondary designations, alternative and deprecated.
    • There is term metadata, such as grammatical information, term cross-references or domain. (This is usually rendered inline with either the designation or the definition.)
    • There is the definition.
    • There are term examples and term notes.
    • There is a term source.

Of these, only the definition, term examples, and term notes are universal across flavours as a rendering block. Even the definition can be severely manipulated: ITU conflates multiple definitions inline into the one paragraph.

Term examples and term notes are the only block from Semantic XML which (as far as I can tell) is not rearranged when rendered as Presentation XML.

Implementation will therefor involve leaving untouched all Semantic XML content, as this refactor intends, and rendering the term example and term notes as read from the Semantic XML. All other Semantic XML term elements are to be ignored, and rendering will involve at least one of the following Presentation XML fmt- elements, which replicate, rearrange, and link back to Semantic XML content:

  • fmt-name (already done)
  • fmt-preferred
  • fmt-alternative
  • fmt-deprecated
  • fmt-related
  • fmt-term-metadata (may refine, I'm not sure it appears as a standalone paragraph anywhere)
  • fmt-definition
  • fmt-termsource
@opoudjis opoudjis added the enhancement New feature or request label Dec 25, 2024
@opoudjis opoudjis self-assigned this Dec 25, 2024
@github-project-automation github-project-automation bot moved this to 🆕 New in Metanorma Dec 25, 2024
@opoudjis opoudjis moved this from 🆕 New to 🏗 In progress in Metanorma Dec 25, 2024
opoudjis added a commit that referenced this issue Dec 29, 2024
@opoudjis
Copy link
Contributor Author

opoudjis commented Dec 29, 2024

Done base terms refactor, just isodoc, although have not yet done concept markup; that is not urgent.

opoudjis added a commit to metanorma/metanorma-iso that referenced this issue Dec 29, 2024
opoudjis added a commit to metanorma/metanorma-generic that referenced this issue Jan 1, 2025
opoudjis added a commit to metanorma/metanorma-ietf that referenced this issue Jan 1, 2025
@opoudjis
Copy link
Contributor Author

opoudjis commented Jan 1, 2025

In IEEE now. This is the hardest term flavour, as everything is reduced into a single paragraph, so it will take time.

opoudjis added a commit that referenced this issue Jan 1, 2025
@opoudjis
Copy link
Contributor Author

opoudjis commented Jan 1, 2025

I will not move termsource outside of and next to preferred any more, that is causing conceptual confusion.

opoudjis added a commit to metanorma/metanorma-ieee that referenced this issue Jan 1, 2025
@opoudjis
Copy link
Contributor Author

opoudjis commented Jan 1, 2025

IEEE not finished, but the basics are now done.

@opoudjis
Copy link
Contributor Author

opoudjis commented Jan 3, 2025

Was deleting xrefs from related entries in IEEE. I don't see the need to, if they are inserted, they should be preserved.

@opoudjis
Copy link
Contributor Author

opoudjis commented Jan 3, 2025

Fix IEEE: put brackets around termsource in non-verbal as well as verbal definition, it looks confusing otherwise

opoudjis added a commit that referenced this issue Jan 3, 2025
@opoudjis
Copy link
Contributor Author

opoudjis commented Jan 3, 2025

Semantically annotate fmt-designation-field for field of designation (and IEEE domains) inserted after term designations in rendering. Used to try and prevent repetitions in IEEE after code refactoring between preferred and secondary designations.

opoudjis added a commit that referenced this issue Jan 3, 2025
opoudjis added a commit to metanorma/metanorma-ieee that referenced this issue Jan 3, 2025
opoudjis added a commit that referenced this issue Jan 5, 2025
opoudjis added a commit to metanorma/metanorma-ieee that referenced this issue Jan 5, 2025
opoudjis added a commit to metanorma/metanorma-itu that referenced this issue Jan 5, 2025
opoudjis added a commit to metanorma/metanorma-ogc that referenced this issue Jan 7, 2025
opoudjis added a commit to metanorma/metanorma-csa that referenced this issue Jan 7, 2025
opoudjis added a commit to metanorma/metanorma-cc that referenced this issue Jan 7, 2025
opoudjis added a commit to metanorma/metanorma-iho that referenced this issue Jan 8, 2025
opoudjis added a commit to metanorma/metanorma-iso that referenced this issue Jan 8, 2025
opoudjis added a commit that referenced this issue Jan 8, 2025
opoudjis added a commit that referenced this issue Jan 8, 2025
opoudjis added a commit that referenced this issue Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🏗 In progress
Development

No branches or pull requests

1 participant