metanorma / metanorma-iso

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

ModSpec instances: the "statement" should just be called `statement::` instead of `description::` #842

Closed ronaldtse closed 1 year ago

ronaldtse commented 1 year ago

Right now we use an encoding as follows:

[requirement]
.Persistent identifiers do not change throughout the life of the register
====
[%metadata]
identifier:: /req/identifiers/ri-identifier-persistence
subject:: persistent identifier
description:: A persistent identifier within the register shall not change
throughout the lifetime of the register.
guidance:: While the register item pointed to by a persistent identifier may change,
the identifier always points to the same register item.
Even after the decommission of a register, the persistent identifiers for
register items within that register remain.
====

However, this is very confusing because in rendering, the description:: field gets rendered as "Statement":

Screen Shot 2022-11-05 at 3 16 23 PM

We should support the label of statement:: instead of description:: (keep description as an alias for compatibility purposes).

Document: https://github.com/metanorma/iso-19135/

opoudjis commented 1 year ago

If you want no differentiation between markup and rendering, you might prefer to use Word. And description is used already instead of statement as a label in classes, by your request. Which means you have already introduced the synonymy.

ronaldtse commented 1 year ago

Thanks @opoudjis for implementing this.