search

glossarist / iev-data

1 stars 1 forks source link

Reconcile formats of `related` items and authoritative sources as relationships #142

Open strogonoff opened 3 years ago

strogonoff commented 3 years ago

Regarding external relationships currently in related:, they look like:

related:
- ref:
    id: 702-05-17
    source: IEV
    version: 1992-03
  type: supersedes

Authoritative sources look like:

  authoritative_source:
  - ref: ISO 921:1997
    clause: definition 819
    link: https://www.iso.org/standard/5333.html
    relationship:
      type: modified
    original: ISO 921:1997, definition 819, modified

Can we use the same way of specifying relationship target for both? Perhaps something that complies with Relaton model?

cc @ronaldtse @yablokov

ronaldtse commented 3 years ago

Absolutely, there was already ticket sometime ago that talked about this, but I can't seem to find it right now.

The goal is to make authoritative source a type of relationship, but it needs to have an additional attribute that indicates that the "authoritative source" relationship is "normative" (it is part of the standard), the other relationships are "informative" (not being standardized, just there for information).

@strogonoff / @skalee can you propose a modelling mechanism to unify these?

ronaldtse commented 3 years ago

FYI this was originally proposed in https://github.com/glossarist/iev-data/issues/78 and https://github.com/glossarist/iev-data/issues/34#issuecomment-765908524 . Back then we didn't have time to act on but it's probably a good time to do so now.

strogonoff commented 3 years ago

@ronaldtse,

We’re prepared to consolidate authoritative source into the related block on our conversion stage (the one that transforms Glossarist structure to the new registry format) anyway, so that’s not an issue and maybe no need to duplicate that work. This script can keep them in separate fields like now, so that it doesn’t break Jekyll builds in meantime while we do the transition.

In this ticket I’m only asking if we can make authoritative source and related items settle on the same data structure for target specification, that seems more crucial. Currently one uses ref-clause-…, the other uses id-source-…. Could we consolidate and use the same system?

ronaldtse commented 3 years ago

Yes we can use the same structure. It will be a superset of both current structures (ref, clause, version, ref link, relationship-type with modification, and text [the “original” we had])

strogonoff commented 3 years ago

So related items will lose “id” and “source” and will express that as “ref” and “clause”, making them same as in authoritative source?

By the way, in Relaton model on BibliographicItem I’m not seeing “ref”, though I do see “formattedRef” (is that the same?).

strogonoff commented 3 years ago

Or to make things simpler, if all related items and authoritative sources will conform to a single item class from Relaton models, just let me know which… I’m assuming it will be BibliographicItem?

ronaldtse commented 3 years ago

Yes we can use the Relaton model as the interchange class. Relaton also supports relationships but this iev-data gem doesn’t support it yet.

strogonoff commented 3 years ago

OK. Which specific class from Relaton models can be used as the reference for auth. source and “related” items?

strogonoff commented 3 years ago

We’ll fill in relationship indicators during our registry format conversion stage, in a way that app and React-built websites will understand, so for now it’s fine on that front. Just wanted to unify relation/auth. source target specifications.