metanorma / metanorma-iso

Metanorma processor for ISO standards
BSD 2-Clause "Simplified" License
14 stars 5 forks source link

Editorial check: all tables/figures/equations/annexes need to be referenced at least once #1211

Closed ronaldtse closed 2 months ago

ronaldtse commented 2 months ago

From @stuartgalt

ISO style checks should make sure that all tables, figures, equations are referenced somewhere in the document.

@ronaldtse

This is an ISO DIR or House Style requirement. All these items and the Annexes need to be referenced at least once.

opoudjis commented 2 months ago

That is not how I read the ISO House Style at all, but I will implement this: all numbered tables, figures, formulae, annexes (top level: Annex A). Presumably not examples, notes, admonitions, lists.

ronaldtse commented 2 months ago

Providing references as requested by @opoudjis :

https://www.iso.org/sites/directives/current/part2/index.xhtml#_idTextAnchor432

ISO DIR 2:

Annexes

Screenshot 2024-09-08 at 4 29 22 PM

Formulas

Screenshot 2024-09-08 at 4 34 19 PM

Figures

Screenshot 2024-09-08 at 4 00 13 PM

Tables

Screenshot 2024-09-08 at 3 59 58 PM

I am seeking clarification from ISO on whether:

opoudjis commented 2 months ago

I continue not to interpret ISO/IEC DIR 2 that way (the examples are more about making sure the examples are not implicitly referenced, e.g. as "see the following example") In any case, done.

ronaldtse commented 2 months ago

We received the following clarification from ISO:

  1. the current wording that says “xxx shall be explicitly referred to within the text” means “xxx must be referred within the text at least once” (this is my understanding).

=> Yes. “shall” expresses a requirement.

  1. a formula can unnumbered, and in this case it does not need to be referenced inside the text? According to Directives, Part 2, 27.4, a formula should be referenced if it is numbered.

=> “Should” expresses a recommendation, so it’s not required to reference a formula, but it’s good practice to do so.

  1. a subfigure must have an internal reference from the text? The requirement to reference figures only applies to top-level figures.

=> Subfigures can be referenced in the text but this is not obligatory.

opoudjis commented 2 months ago

2 would mean that the warning about formulas not being referenced is downgraded, from 1 to 2.