metanorma / mn-samples-ieee

Metanorma samples for IEEE
0 stars 0 forks source link

Standard template: IEEE draft standard not fetchable #5

Open ronaldtse opened 2 years ago

ronaldtse commented 2 years ago
[relaton] (IEEE P802.21/D14) not found.

Encoding:

* [[[IEEE_P802,IEEE P802.21/D14]]], IEEE P802.21^(TM)^ (Draft 14, November
2003), Draft Standard for Local and Metropolitan Area Networks --
Media Independent Handover Services.footnote:[Numbers preceded by
P are IEEE authorized standards projects that were not approved by
The IEEE SA Standards Board at the time this publication went to Sponsor
ballot/press. For information about obtaining drafts, contact the
IEEE.]

Relaton should be able to fetch "IEEE P802.21/D14", which is located here: https://ieeexplore.ieee.org/document/4629448

BrendaBraitling commented 11 months ago

@ronaldtse @andrew2net

I volunteer with IEEE LTSC and heard about the ISO/IEC SMART project from our ISO Liaison.

Your link is an abstract citation for a standard superseded several years ago, not a document.

Generally, IEEE Standards are behind a pay wall. Draft standards are generally not shared.

It might be helpful to your project - for development and testing purposes - to access the current 2021 IEEE Style Guide. It can be accessed as a PDF and includes an Annex with sample standards. 2021 IEEE SA Standards Style Guide.

opoudjis commented 11 months ago

Thank you for getting in touch. We are using the IEEE style guide, and welcome any feedback you might have on how we are applying it. (We've been doing some debugging recently in collaboration with @reeseplews .)

The specific issue here is that we do encode both current and past standards, and if a standard we are encoding contains a link to a draft or a now superseded document, we still need to replicate that citation. We can indicate that citing drafts is not recommended, but it is not up to us as a document generation tool to reject the citation.

That aside, hyperlinks to documents in our bibliographic system are not necessarily direct links to standards, because paywalls are so prevalent, but hyperlinks pointing to how to access the document, and providing metadata about standards, are still too useful not to use. This is no different to how DOI urls operate.

The bibliographic tool is meant to be used for all SDOs that we support, and not exclusively IEEE. In the case of IEEE, as with ISO, we do not provide any URIs of standards in the bibliography, so IEEE practice around standards URIs in bibliographies is not being compromised. BIPM on the other hand does expect such URIs where available.

andrew2net commented 11 months ago

@ronaldtse it seems in the source dataset the document has ID "IEEE Unapproved P802.21/D-14-2008-Sept" https://github.com/ietf-tools/relaton-data-ieee/blob/main/data/IEEE_UNAPPROVED_P802.21_D-14-2008-SEPT.yaml

ronaldtse commented 11 months ago

@BrendaBraitling thank you for your comment on this issue.

The Metanorma team has been working with the IEEE SA publication team, including Patrick Gibbons, on IEEE SA needs. Metanorma current already generates output compliant to the IEEE Style Guide and the "IEEE master standards" (that are shared by IEEE SA in private that utilizes a proprietary XML format).

This particular issue refers to a citation from an IEEE SA standard to a draft standard, which happens to be provided in the official IEEE bibliographic database. While not always available to the public, draft standards can be cited.

We'd be very interested to hear about your needs and experience with regards to IEEE SA. Thanks!

ronaldtse commented 11 months ago

@ronaldtse it seems in the source dataset the document has ID "IEEE Unapproved P802.21/D-14-2008-Sept" https://github.com/ietf-tools/relaton-data-ieee/blob/main/data/IEEE_UNAPPROVED_P802.21_D-14-2008-SEPT.yaml

@andrew2net does this mean the pubid-ieee or relaton-ieee need to recognize "IEEE Unapproved P802.21/D-14-2008-Sept" as "IEEE P802.21/D14"?

andrew2net commented 11 months ago

@ronaldtse if the "IEEE P802.21/D14" is valid reference then yes, we need to map it to the "IEEE Unapproved P802.21/D-14-2008-Sept" document somehow. I think It's a good idea if the pubid-ieee recognizes these IDs as equal.

> Pubid:Ieee::Identifier.parse("IEEE P802.21/D14") == Pubid:Ieee::Identifier.parse("IEEE Unapproved P802.21/D-14-2008-Sept")
=> true
ronaldtse commented 11 months ago

@andrew2net agree -- can you help file an issue for pubid-ieee? Thanks.