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

ISO Rice: Different order of the %key, notes and footnotes in the table #96

Closed
anermina opened this issue Apr 4, 2024 · 8 comments
Closed
Assignees
Labels
enhancement New feature or request question Further information is requested

Comments

@anermina
Copy link
Contributor

anermina commented Apr 4, 2024

Table 1 includes the following elements:

  • notes
  • footnotes
  • abbreviations

They are ordered as above in the original document.
image

However, they cannot be properly generated if the abbreviation is put last
image

using the following markup (same result without [%key]; footnotes are added inline):

NOTE: Ce tableau est basé sur l'<<ISO7301,table=1>>.

NOTE: Certains contrats commerciaux peuvent exiger des complémentaires à celles fournies dans le présent tableau.

NOTE: Seul le riz (cargo) rouge entièrement décortiqué est pris en considération dans le présent tableau.

[%key]
N/A:: N'est pas applicable.

I believe it is not intended to use [%key] after the notes. Therefore, these elements are encoded in the following order:

  • abbreviations
  • notes
  • footnotes

and generated like this:
image

Is it fine to keep the current encoding, or we need to address this issue as a request for enhancement/a bug?

@anermina anermina added enhancement New feature or request question Further information is requested labels Apr 4, 2024
@ronaldtse
Copy link
Contributor

ISO DIR 2 says this.

IMG_4572

  1. It says Footnotes always at the bottom
  2. The abbreviations are part of Key. So using Key to encode is correct.
  3. NOTEs and other text can appear but the order is undetermined. This still means before Footnotes.

look at 29.6:

IMG_4573

From this table, we can see that the order is:

  • text
  • NOTEs
  • Footnotes

It doesn’t say where the Key/Abbreviations is located, but Footnotes must be at the bottom.

Let us enquire ISO about this.

@ronaldtse
Copy link
Contributor

Email sent to ISO.

@ronaldtse
Copy link
Contributor

Official answer from ISO's Yvonne Chen:

1 Is the component order: Text > Note > Footnote > Key?

Personally I try to follow the order of Key > Text > Note > Footnote.

  1. Should the “Key” section have the “Key” in bold as a header, like ISO DIR 2 Table 11?

Yes, “Key” should be in bold.

@anermina
Copy link
Contributor Author

Thank you, @ronaldtse !

@opoudjis , could you please help with the second requirement to generate the boldfaced "Key" title in the table footnotes when the key element is used?

@ronaldtse
Copy link
Contributor

@anermina could you please help file that issue under metanorma-iso? Thanks!

@anermina
Copy link
Contributor Author

@ronaldtse @opoudjis the issue is now addressed in metanorma/metanorma-iso#1162.

@ronaldtse
Copy link
Contributor

Thanks @anermina

@github-project-automation github-project-automation bot moved this from 🏗 In progress to ✅ Done in Metanorma Apr 25, 2024
@opoudjis
Copy link
Contributor

How the fragment now renders:

Archive 6.zip

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request question Further information is requested
Projects
Archived in project
Development

No branches or pull requests

3 participants