This is an archived snapshot of W3C's public bugzilla bug tracker, decommissioned in April 2019. Please see the home page for more details.

Bug 24944 - Ensure references are consistent and correctly categorized
Summary: Ensure references are consistent and correctly categorized
Status: RESOLVED FIXED
Alias: None
Product: Web Cryptography
Classification: Unclassified
Component: Web Cryptography API Document (show other bugs)
Version: unspecified
Hardware: PC All
: P2 minor
Target Milestone: ---
Assignee: Mark Watson
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2014-03-05 20:49 UTC by Mark Watson
Modified: 2014-11-07 01:34 UTC (History)
2 users (show)

See Also:

Attachments

Description Mark Watson 2014-03-05 20:49:37 UTC 
References should be consistently written as [REF] in square brackets.

References need to be correctly categorized as normative or informative.
Comment 1 Ryan Sleevi 2014-03-05 22:00:18 UTC 
So, it needs to be clarified

The [REF] form is for referring to the short-hand identifier of a spec that appears within the references section. However, there are still times where we want to say the full part of the specification.

Something like

"Refer to Section 3 of PKCS #11 [PKCS11]"

Presumably
Comment 2 Mark Watson 2014-03-05 22:02:26 UTC 
(In reply to Ryan Sleevi from comment #1)
> So, it needs to be clarified
> 
> The [REF] form is for referring to the short-hand identifier of a spec that
> appears within the references section. However, there are still times where
> we want to say the full part of the specification.
> 
> Something like
> 
> "Refer to Section 3 of PKCS #11 [PKCS11]"
> 
> Presumably

I would say "Refer to Section 3 of [PKCS11]"
Comment 3 virginie.galindo 2014-10-14 09:01:51 UTC 
In order to progress towards exit to Last Call for the Web Crypto API, the chair suggests the following resolution for that bug. 

Resolution : Bug RESOLVED, editors will edit the specification to harmonize with consistent usage of specification references and/or section of specification reference. 

If none objects before the 20th of Oct @20:00 UTC, this resolution will be endorsed.