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

"Symbol and abbreviated terms" is used as clause header even when both clauses are separate #222

Closed
ronaldtse opened this issue Oct 4, 2018 · 5 comments
Assignees
Labels

Comments

@ronaldtse
Copy link
Contributor

Under a structure like this:

== Terms, definitions, symbols and abbreviated terms

=== Terms and definitions

=== Symbols       => This renders as "Symbols and abbreviated terms"

=== Abbreviated terms   => This also renders as "Symbols and abbreviated terms"

The last two should not have the same heading.

@ronaldtse
Copy link
Contributor Author

This occurs in 8601-1.

@opoudjis
Copy link
Contributor

opoudjis commented Oct 5, 2018

The separation of Symbols and Abbreviated Terms into two clauses is not foreseen in ISO/IEC DIR 2, Clause 16.4. What should be happening is a separate Symbols and Abbreviated Terms section, possibly with a Symbols and an Abbreviated Terms subsection. Merging Terms & Definitions with Symbols & Abbreviated Terms, but splitting Symbols & Abbreviated Terms before the merger, is in my opinion an abuse of the convention.

I've been trying to enforce canonical titles for Terms & Definitions throughout. There have been too many exceptions for this; I will change the code to include a title for Terms & Definitions and Symbols & Abbreviated Terms sections, with a default value put into ISO XML if it matches the given wording. Currently isodoc is enforcing the title, and it can't keep doing so with exceptions such as this.

@ronaldtse
Copy link
Contributor Author

All I can say is that this structure is accepted by ISO/CS; I don't know if it's an abuse or not.

@ronaldtse
Copy link
Contributor Author

I wonder if it's better to convert this "strict" title into a warning; if even I being so tightly familiar with the toolchain, runs into this issue, other definitely will.

@opoudjis
Copy link
Contributor

Respecting title of Definitions sections, whatever it might be. (Note that unless the "heading" attribute is used, only Symbols, Abbreviated Terms, and Symbols & Abbreviated Terms will be recognised.) Propagating title to definitions section in grammar. Modifying metanorma-standoc and isodoc to respect title of Definitions section.

opoudjis added a commit to metanorma/metanorma-standoc that referenced this issue Jan 22, 2019
opoudjis added a commit to metanorma/isodoc that referenced this issue Jan 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants