metanorma / metanorma-iho

Metanorma for the International Hydrographic Organization
BSD 2-Clause "Simplified" License
4 stars 2 forks source link

IHO M-1 regulation: numbering styles/cross-referencing issue #21

Open anermina opened 4 years ago

anermina commented 4 years ago

It is hard to understand the pattern which was supposed to be followed in this document. Articles are numbered with both Roman and Arabic numerals. Multiple different numbering styles are applied to numbered paragraphs and sub-paragraphs as well.

Therefore, we have some issues in proper generation of paragraph/article number and cross-referencing:

  1. Currently, word "Clause" is automatically added to each cross-reference. Considering the examples from the document, I believe there should be no keyword here, since text refers to paragraphs, articles, categories, etc., but it would be good to have a confirmation.
  2. It is not clear which numbering style should be used for articles/rules, and which for paragraphs and sub-paragraphs.

Examples from the original text:

image image image image

opoudjis commented 2 weeks ago

IHO M-1 is different from all other standards documents, so its conventions do not reflect on the rest of IHO output. Need guidance on whether to proceed with encoding them.

Not urgent, but will need to be done.

opoudjis commented 2 weeks ago

Review whether existing encoding has hyperlinked text which satisfies rendering requirements, or whether there is a need to generate them programmatically.