Discussion:
ReSpec: auto-linking to WebIDL stypes
Marcos Caceres
2017-02-22 04:39:41 UTC
Permalink
Hi ReSpec users,

If you use WebIDL in your specs,  ReSpec now "non-normatively"
auto-links well-known types to the WebIDL Spec (REC 2016) for you.
Examples include Promise, DOMString, etc. It also auto links some
known HTML5.1 types (e.g., EventHandler).

If you want to make your spec normatively reference WebIDL, then just
cite "[[!WebIDL]]" somewhere (same for HTML51).

For example:

```
This specification depends on [[!WebIDL]] and [[!HTML51]].
```

And WebIDL and HTML51 will magically appear in the Normative References.

An example (click on DOMString, for instance):
https://w3c.github.io/browser-payment-api/#paymentrequest-interface

Happy spec'ing!
Marcos Caceres
2017-02-22 04:53:06 UTC
Permalink
Post by Marcos Caceres
If you want to make your spec normatively reference WebIDL, then just
cite "[[!WebIDL]]" somewhere (same for HTML51).
should be [[!WEBIDL]]
Post by Marcos Caceres
```
This specification depends on [[!WebIDL]] and [[!HTML51]].
```
As above, should be [[!WEBIDL]]. Case matters.

Kind regards,
Marcos
Tobie Langel
2017-02-22 07:18:49 UTC
Permalink
Post by Marcos Caceres
```
This specification depends on [[!WebIDL]] and [[!HTML51]].
```
As above, should be [[!WEBIDL]]. Case matters.
Specref is case insensitive, fwiw.



--tobie
Marcos Caceres
2017-02-22 07:22:15 UTC
Permalink
Post by Tobie Langel
Post by Marcos Caceres
```
This specification depends on [[!WebIDL]] and [[!HTML51]].
```
As above, should be [[!WEBIDL]]. Case matters.
Specref is case insensitive, fwiw.
I'll see if I can fix ReSpec to match (or at least normalize how
things are referenced).
Tab Atkins Jr.
2017-02-22 21:57:30 UTC
Permalink
Post by Marcos Caceres
Post by Tobie Langel
Post by Marcos Caceres
```
This specification depends on [[!WebIDL]] and [[!HTML51]].
```
As above, should be [[!WEBIDL]]. Case matters.
Specref is case insensitive, fwiw.
I'll see if I can fix ReSpec to match (or at least normalize how
things are referenced).
If you want to match behavior, Bikeshed preserves the case used in the
reference when displaying the index, and complains at you if you refer
to the same spec in more than one way with several biblio refs.

~TJ

Loading...