search

metanorma / metanorma-ogc

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

Terms and definitions: allow authors to import a term from a glossary #34

Open ronaldtse opened 5 years ago

ronaldtse commented 5 years ago

Very often a standards author needs to import a term from the OGC glossary.

It is however an annoyance to copy/paste/re-type/re-format the term, definition, source, notes and examples.

This ticket is to:

  1. Establish a Metanorma AsciiDoc syntax to automate this process

  2. Allow Metanorma to import a term into a document (TBX, RDF/SKOS, Metanorma Term...)

  3. Allow the author to override a term from the glossary while maintaining a reference to the unmodified source.

  4. The glossary can be “cited” and used as an authoritative source, i.e. “[SOURCE: OGC Glossary x.y version z]” (something like that)

  5. If a term exists in the OGC glossary, and is being used in the document, but does not provide a reference to the term, Metanorma can produce a warning to that effect.

ronaldtse commented 4 years ago

This issue now relates to this: https://github.com/metanorma/metanorma-standoc/issues/154

rob-metalinkage commented 2 years ago

OGC Glossary maintenance needs to be factored into this - the Glossary should be collated automatically from normative content managed through the OGC Naming Authority, which assigns identifiers to concepts. There are a range of abstract concepts that emerge from more informal processes.

The OGC Glossary is available at http://www.opengis.net/def/glossary and can potentially be delivered in any format required.

for example in TTL http://www.opengis.net/def/glossary?_profile=conceptscheme&_mediatype=text/turtle

or as JSON (as JSON-LD semantically annotated using SKOS model)

https://www.opengis.net/def/glossary?_profile=conceptscheme&_mediatype=application/ld%2Bjson

Note if python code to convert one of these to an XML format can be supplied we can arrange to generate that format in addition and advertise it as an available format. (best for someone familar with and abl;e to validate the XML format undertake this)

ghobona commented 1 year ago

The issue also relates to https://github.com/metanorma/metanorma/issues/75

OGC Staff briefed on 2023-09-04.

ronaldtse commented 1 year ago

There is also a role to play by the glossarist-ruby gem.

ronaldtse commented 5 months ago

https://github.com/metanorma/metanorma-plugin-glossarist

opoudjis commented 4 months ago

Pending debugging of metanorma-plugin-glossarist: see https://github.com/metanorma/metanorma/issues/75