Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove docid with scope=anchor #87

Open
strogonoff opened this issue May 25, 2022 · 12 comments
Open

Remove docid with scope=anchor #87

strogonoff opened this issue May 25, 2022 · 12 comments
Assignees
Labels
enhancement New feature or request

Comments

@strogonoff
Copy link

Example: https://github.com/ietf-ribose/relaton-data-ids/blob/99b3eadf8840bd841a0044effa87faa4d4e65fce/data/draft-3k1n-6tisch-alice0-00.yaml#L18-L20

  • We consider these anchors a detail only relevant for legacy xml2rfc API support, and they are not document identifiers.
  • We will maintain anchors separately as part of mapping metadata (or generate them dynamically), and not keep them in source data.

Just in case, I think we should first check what Robert further replies in this thread: https://github.com/ietf-ribose/bibxml-service/issues/206#issuecomment-1136058412

cc @ronaldtse

@andrew2net
Copy link
Contributor

@strogonoff @ronaldtse
Should we still have anchor in BibXML output?
If yes, can we use primary docid as anchor as it is (without replacing spaces and slashes)?
If no, where should we render primary docid in BibXML output?

@ronaldtse
Copy link
Contributor

How does "primary docid" look like right now? Why does it have spaces and slashes?

@strogonoff
Copy link
Author

strogonoff commented May 30, 2022

@andrew2net I believe we were discussing this question with Robert; i.e. ”do we need to maintain all old anchors as is, or can we generate them from docid even if this means they will sometimes differ a bit?” (see https://github.com/ietf-ribose/bibxml-service/issues/206).

If yes, can we use primary docid as anchor as it is (without replacing spaces and slashes)?

Some replacement may be needed, but this can be done by the app that generates XML.

How does "primary docid" look like right now? Why does it have spaces and slashes?

@ronaldtse, primary IDs for RFCs and RFC subseries have spaces (example 1, example 2).

Apart from that, I suspect primary (citeable) identifiers of non-IETF documents in misc often should have spaces (but don’t): for example, I feel like ISO 10646-1-AD2.1996 should actually be ISO/IEC 10646-1:1993/AMD 2:1996. (I think we are going to do something with such documents, e.g. replace them with documents from authoritative datasets.)

And, non-IETF documents in non-IETF Relaton sources often contain slashes (example).

@andrew2net
Copy link
Contributor

@strogonoff @ronaldtse @opoudjis in the Relaton model we have a docnumber attribute. If I'm right, the attribute is used by Metanorma for sorting purpose. What do you think if we save anchor as the docnumber attribute?
Note: for Internet-drafts anchor isn't unique, all versions of a document have same anchor

@strogonoff
Copy link
Author

strogonoff commented Aug 2, 2022

  1. Should we introduce an IETF RFC-specific property that contains the anchor? Similar to how 3GPP has special release.project_end and similar keys, we could have a special bibxml.anchor key or similar. (After that, it’d be safe to drop docid with type=anchor, because no data would be lost.) cc @ronaldtse
  2. Currently, docid with type=anchor seems incorrect. For example, it’s RFC4 here, but it should be RFC0004 (see xml2rfc tools output as an example). Did we change it unintentionally?🤔 cc @andrew2net

@strogonoff
Copy link
Author

What do you think if we save anchor as the docnumber attribute?

I feel like we could put anchors in docnumber, but I suspect there’s a semantic difference between a docnumber and anchor… I’m not sure.

@andrew2net
Copy link
Contributor

  1. @strogonoff since we started fetching documents from the https://www.rfc-editor.org/rfc-index.xml dataset, which isn't in a BibXML forma and doesn't contain anchors, we can remove anchors from the relaton-data-rfcs without any problem.
  2. We still have a BibXML parser. I don't know who uses it, and does it need to reproduce the anchors in the Relaton's BibXML output? cc @ronaldtse

@strogonoff
Copy link
Author

@andrew2net Interesting:

we started fetching documents from the https://www.rfc-editor.org/rfc-index.xml dataset

Maybe this is why the anchor has changed?

andrew2net added a commit that referenced this issue Aug 3, 2022
andrew2net added a commit that referenced this issue Aug 3, 2022
@andrew2net
Copy link
Contributor

Maybe this is why the anchor has changed?

@strogonoff yes, it's definitely so.
BTW we still parse BibXML to create documents for relaton-data-ids, so the IDs still have anchors.

@ronaldtse
Copy link
Contributor

I think the answers have all been answered here.

As for:

BibXML to create documents for relaton-data-ids, so the IDs still have anchors

@strogonoff we can strip off the original anchors on the bibitems sourced from the datatracker -- these are the only ones that provide anchors.

@andrew2net
Copy link
Contributor

@strogonoff @ronaldtse can we close this issue?

@ronaldtse
Copy link
Contributor

@andrew2net I'm still hoping we can get rid of the anchors in the Relaton data. @strogonoff can we?

@ronaldtse ronaldtse added the enhancement New feature or request label Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants