metanorma / stepmod-utils

Tools for working on the STEPmod repository.
1 stars 0 forks source link

Offer mechanism to "group" and "re-order" the terms #14

Open ronaldtse opened 4 years ago

ronaldtse commented 4 years ago

e.g. a YAML map like:

- category: "General concepts"
  terms: 
    - chain
    - agreement of common understanding
    - management information
- category: "EXPRESS concepts"
  terms:
    - annotated EXPRESS schema
    - type_of_product

And the output becomes:

=== General concepts

==== chain
...
==== agreement of common understanding
...

=== EXPRESS concepts

==== annotated EXPRESS schema
...

==== type_of_product
...
ronaldtse commented 4 years ago

Ping @skalee we may not need it immediately but the a Ruby concept/term gem can already be useful here. All these terms adhere to the same structure we have in Geolexica/Glossarist. If we have that gem it is easy to re-order them.

skalee commented 4 years ago

If it is just about rendering AsciiDoc from some YAML data, then I'd simply go with Liquid or ERB…

ronaldtse commented 4 years ago

some YAML data

And we'll need a gem to store and create/read that YAML data.

ronaldtse commented 3 years ago

@skalee we need a Ruby gem to deal with the https://github.com/glossarist/concept-model model.

@opoudjis will soon implement support for this model in Metanorma, it's much better for him to directly use this work.

ronaldtse commented 3 years ago

@w00lf we need to update this gem to achieve this list in data extraction:

https://github.com/metanorma/iso-10303-2/issues/10#issuecomment-827691615

This list provides the clause titles for the terms defined in those parts, e.g.:

=== Geometric and topological representation

==== some term from part 42

...definition...
ronaldtse commented 3 years ago

Please follow the domains here: https://github.com/metanorma/iso-10303-2/issues/10#issuecomment-827691615

ronaldtse commented 3 years ago

This task can be done post-CD stage (way after 2021-05-21).

ronaldtse commented 3 years ago

This will be easy once #113 is completed. This is for https://github.com/metanorma/iso-10303-2/issues/42