metanorma / metanorma-ogc

Metanorma processor for OGC documents
https://www.metanorma.com
BSD 2-Clause "Simplified" License
2 stars 3 forks source link

Officially support "Glossary" and smart terms within Glossary #245

Closed ronaldtse closed 3 years ago

ronaldtse commented 3 years ago

OGC documents have been confirmed to have both a "Terms and definitions" clause and a "Glossary" that is an annex.

The "Terms and definitions" clause will follow ISO practice, which allows:

With their internal subdivisions according to ISO practice.

The Glossary is an "informative" section for terms, which will contain informative terms, encoded in the same way as with the "Terms and definitions" clause. It is not confirmed whether it can contain symbols or abbreviated terms.

ronaldtse commented 3 years ago

Failure to reference a term:

[appendix]
[heading='terms and definitions']
== Glossary

=== Standardization Target

An entity to which some requirements of a standard apply

[.source]
<<ogc08-131,clause=4.23>>
== Conformance

This Standard defines a {{Conceptual Model}} which is independent of any encoding or 
formatting techniques. The {{Standardization Target,Standardization Targets}} for this 
Standard are:

Error:

AsciiDoc Input: (XML Line 000417): Error: Term reference in `term[standardization-target]` missing:                 "standardization-target" is not defined in document
opoudjis commented 3 years ago

Yes, term:[] references are currently restricted to real Terms & Definitions sections, so this OGC glossary annex will need to also be an explicit terms section.

ronaldtse commented 3 years ago

this OGC glossary annex will need to also be an explicit terms section.

But this doesn't work?

[appendix]
[heading='terms and definitions']
== Glossary
opoudjis commented 3 years ago

Because appendixes override headings.

ronaldtse commented 3 years ago

Got it, then there is further work needed to actually support the "Glossary".

opoudjis commented 3 years ago

In particular, as with NIST, glossaries within annexes need to be marked up as <annex><terms>, and the <terms> needs not to be treated as a separate subclause. This involves bringing across the relevant code from NIST.

opoudjis commented 3 years ago

So:

If an annex has the title "Glossary", or a [heading='glossary'] attribute, it is treated as a glossary, and is encoded the same as a Terms & Definitions section.