relaton / relaton-bipm

MIT License
2 stars 0 forks source link

(URGENT) Fix retrieval syntax for "Recommendation" CIPM references (allow `CIPM Recommendation 1 (1969)` instead of `CIPM Resolution 1 (1969)`) #19

Closed manuelfuenmayor closed 2 years ago

manuelfuenmayor commented 2 years ago

References like (PV, 37, 30) should fetch with CIPM Recommendation 01 (1969), not CIPM Resolution 01 (1969). As they are recommendations. Like indicated in https://github.com/metanorma/bipm-data-outcomes/blob/576929b1ab359bfe4397b40865e1cb65cf575a76/cipm/meetings-en/meeting-58.yml#L9-L12.

ronaldtse commented 2 years ago

To paraphrase the bug here:

CIPM outcomes can be a "Recommendation" or a "Resolution".

The link provided here: https://github.com/metanorma/bipm-data-outcomes/blob/576929b1ab359bfe4397b40865e1cb65cf575a76/cipm/meetings-en/meeting-58.yml#L9-L12

Is clear a type: recommendation.

Therefore, in accordance with the official pattern provided by BIPM here: https://github.com/metanorma/metanorma-bipm/issues/164

[BODY] [Type] {number} (YEAR)

It should be retrieved using the syntax:

CIPM Recommendation 1 (1969)

And also allowed to be retrieved using this syntax:

CIPM Recommendation 1969-01
andrew2net commented 2 years ago

CIPM outcomes can be a "Recommendation" or a "Resolution".

@ronaldtse some CIPM outcomes have type "decision". Does it mean CIPM outcome should be "Recommendation" if it has type: recommendation and "Resolution" if it has any other type?

andrew2net commented 2 years ago

@ronaldtse @manuel489 we create document from metadata and from resolutions. Metadata doesn't have type attribute. I supposed that it possible to use for documents created from metadata same type as resolutions have but 2 documents have different resolution types:

So the question is: what type should be documents created from metadata?

ronaldtse commented 2 years ago

Metadata doesn't have type attribute

Are we mixing things here?

There are 4 types of BIPM data (see https://github.com/metanorma/bipm-data-importer):

Does it mean CIPM outcome should be "Recommendation" if it has type: recommendation and "Resolution" if it has any other type?

There are only four outcome types:

These outcome types are all specified in the data. There should not be an instance without type.

So the question is: what type should be documents created from metadata?

I'd like to clarify the terminology here. Relaton does not create "documents" as data, it creates bibliographic items that allow reference.

These are the things that can be referred to in Relaton-BIPM:

In order for these things to be referenced, we need to create them in relaton-data-bipm.

This also means that every outcome should have its own file in relaton-data-bipm.

andrew2net commented 2 years ago

Metadata doesn't have type attribute

Are we mixing things here?

There are 4 types of BIPM data (see https://github.com/metanorma/bipm-data-importer):

  • CGPM outcomes
  • CIPM outcomes
  • CIPM decisions
  • CCTF recommendations

Saying metadata I meant section metadata in the bipm-data-outcomes. For example we create the document from the metadata section. Which type the document should be? Meeting?

There are only four outcome types:

These outcome types are all specified in the data. There should not be an instance without type.

I see the new attribute type in the resolutions collection. I was confused by your phrase:

CIPM outcomes can be a "Recommendation" or a "Resolution".

In the bipm-data-outcomes I found only recommendation and decision for CIPM body. So we just use specified type, correct?

ronaldtse commented 2 years ago

I see the new attribute type in the resolutions collection.

Yes, as mentioned in those tickets above, the type is somewhat new, but not that new (April 13).

In the bipm-data-outcomes I found only recommendation and decision for CIPM body. So we just use specified type, correct

Yes. Just use specified type.

ronaldtse commented 2 years ago

Saying metadata I meant section metadata in the bipm-data-outcomes. For example we create the document from the metadata section. Which type the document should be? Meeting?

As mentioned earlier, we need these types:

CIPM outcomes

https://github.com/metanorma/bipm-data-outcomes/tree/main/cipm provides these objects:

CGPM outcomes

https://github.com/metanorma/bipm-data-outcomes/tree/main/cgpm

CCTF outcomes

https://github.com/metanorma/bipm-data-outcomes/tree/main/cctf

ronaldtse commented 2 years ago

Confirm fixed. Thanks @andrew2net !