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.

Sign up for GitHub

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

Jump to bottom

cleanup: mark & structure biblio references consistently #872

Closed
equalsJeffH opened this issue Apr 17, 2018 · 1 comment · Fixed by #1241
Closed

cleanup: mark & structure biblio references consistently #872

equalsJeffH opened this issue Apr 17, 2018 · 1 comment · Fixed by #1241
Assignees
@equalsJeffH
Labels
stat:pr-open type:editorial
Milestone
L2-WD-02

Comments

@equalsJeffH
Copy link
Contributor

Presently, we've (myself included) become somewhat sloppy with our biblio references and auto-link entries. There's at least two broad categories:

The first, for example, is that we are not consistent in marking citations as (non-)normative, e.g.:

[...]
        <td>
            The ...
            as defined in Section 7 of [[RFC8152]] ...
[...]
    1. Convert the COSE_KEY ... (see Section 7 of [[!RFC8152]]) to CTAP1/U2F user public key ...
[...]

...note the inconsistency in using the normative exclamation mark citation signal ! in the above cites of RFC8152. There are similar inconsistencies with cites of other specs.

It appears that if a referenced spec is marked normative (at least once?) then it is placed in the "Normative" biblio section, thus cleaning up is not high priority, but probably something we ought to do.

The second cleanup aspect of this is we are creating cross-spec links that are syntactically inconsistent. E.g.:

<pre class="anchors">
[...]
spec: TokenBinding; urlPrefix: https://tools.ietf.org/html/draft-ietf-tokbind-protocol#
    type: dfn
        text: Token Binding
        text: Token Binding ID; url: section-3.2                   [A]
[...]
spec: FIDO-CTAP; urlPrefix: https://fidoalliance.org/specs/fido-v2.0-ps-20170927/fido-client-to-authenticator-protocol-v2.0-ps-20170927.html
    type: dfn
        text: CTAP2 canonical CBOR encoding form; 
           url: ctap2-canonical-cbor-encoding-form                [B]
[...]
</pre> <!-- class=anchors -->

[...]
[[RFC8152]] [Section 7](https://tools.ietf.org/html/rfc8152#section-7)      [C]
...
(see [[RFC8152]]
[Section 13.1](https://tools.ietf.org/html/rfc8152#section-13.1))          [D]
[...]

IIUC, we ought to be able to craft link anchors in the same fashion as [A] and [B], for the cases of [C] and [D] such that we are using a consistent cross-spec linking approach.
@equalsJeffH equalsJeffH mentioned this issue Apr 17, 2018
Merged
@equalsJeffH equalsJeffH added this to the REC milestone Apr 19, 2018
@emlun emlun mentioned this issue Apr 25, 2018
Merged
@selfissued
Copy link
Contributor

Alll that this is missing is an owner willing to do the work...

@akshayku akshayku modified the milestones: REC, L2-WD-00 Feb 6, 2019
@nadalin nadalin modified the milestones: L2-WD-01, L2-WD-02 May 7, 2019
@equalsJeffH equalsJeffH mentioned this issue Jun 21, 2019
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@equalsJeffH equalsJeffH

Labels
stat:pr-open type:editorial
Projects
None yet
Milestone
L2-WD-02
Development

Successfully merging a pull request may close this issue.

bikeshed cleanup: refs w3c/webauthn
4 participants
@equalsJeffH @selfissued @nadalin @akshayku