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

Allow Bikeshed specs to more easily autolink to HTML #998

Closed
domenic opened this issue Apr 5, 2016 · 6 comments
Closed

Allow Bikeshed specs to more easily autolink to HTML #998

domenic opened this issue Apr 5, 2016 · 6 comments

Comments

@domenic
Copy link
Member

domenic commented Apr 5, 2016

We've been trying to honor Bikeshed's rules on an ad-hoc basis, but I'd like to take a better crack at it.

One obvious thing is to stop using noexport on our <dfn>s since it's not necessary. But otherwise, I'd like to just get started by canvasing specs that reference HTML a lot and finding their Bikeshed link defaults sections and seeing how we can help them eliminate those in favor of more automatic autolinking.

@tabatkins
Copy link
Contributor

👍

Here's the list from Service Worker:

spec: html; type: dfn
    text: about:blank
    text: active document
    text: allowed to show a popup
    text: api base url
    text: api url character encoding
    text: application cache
    text: auxiliary browsing context
    text: browsing context
    text: discard a document
    text: effective script origin
    text: entry settings object
    text: environment settings object
    text: event handler
    text: event handler event type
    text: event handler idl attributes
    text: event loop
    text: exceptions enabled
    text: focusing steps
    text: global object
    text: incumbent settings object
    text: in parallel
    text: kill a worker
    text: list of active timers
    text: navigate
    text: nested browsing context
    text: neutered
    text: parent browsing context
    text: queue a task
    text: replacement enabled
    text: responsible browsing context
    text: responsible document
    text: responsible event loop
    text: same origin
    text: script
    text: settings object
    text: source browsing context
    text: structured clone
    text: task sources
    text: tasks
    text: the worker's documents
    text: top-level browsing context
    text: transfer a transferable object
    text: trusted event
    text: unicode serialisation of an origin
    text: unload a document
    text: user interaction task source
    text: utf-8 decode

Here's DOM:

urlPrefix: https://html.spec.whatwg.org/multipage/
    type: dfn
        urlPrefix: webappapis.html
            text: report the exception
            text: queue a microtask
            text: compound microtask
            text: execute a compound microtask subtask
        urlPrefix: syntax.html
            text: html parser
            text: html parsing; url: #html-parser
        urlPrefix: browsers.html
            text: concept-document-bc
            text: concept-document-window
            text: unit of related similar-origin browsing contexts
            text: origin
            text: effective script origin
            text: origin alias; url: #concept-origin-alias
            text: Unicode serialization of an origin; url: #unicode-serialisation-of-an-origin
        urlPrefix: infrastructure.html
            text: in parallel

Here's FileAPI:

urlPrefix: https://html.spec.whatwg.org/multipage/
    urlPrefix: webappapis.html
        type: dfn
            text: event loop
            text: event handler content attribute
            text: event handler event type
            text: incumbent settings object
            text: task; url: #concept-task
            text: task source
            text: global script clean-up jobs list
            text: queue a task
    urlPrefix: infrastructure.html
        type: dfn
            text: structured clone
            text: collect a sequence of characters
            text: converting a string to ASCII lowercase; url: #converted-to-ascii-lowercase
    urlPrefix: browsers.html
        type: dfn
            text: unloading document cleanup steps
            text: effective script origin
            text: origin
            text: same origin
    urlPrefix: dom.html
        type: dfn
            text: document; url: #dom

I'm sure @mikewest and @jyasskin probably have some lists of HTML anchors they've used in their specs, too.

@jyasskin
Copy link
Member

jyasskin commented Apr 5, 2016

Web Bluetooth:

spec: html
    type: dfn
        text: allowed to show a popup
        text: browsing context
        text: environment settings object
        text: event handler idl attribute
        text: global object
        text: in parallel
        text: incumbent settings object
        text: perform a microtask checkpoint
        text: queue a task
        text: relevant settings object
        text: responsible event loop

@annevk
Copy link
Member

annevk commented Apr 6, 2016

So I guess one way to address the problem with "origin" is to mark HTML's definition of "origin" as for="origin" and do something similar for the associated terms. Perhaps even give them data-lt="" attributes with shorter names.

@tabatkins
Copy link
Contributor

HTML's "origin" is actually probably not for anything at all; all the other terms are. (They're for url, request, and http.) HTML's origin is just... an origin. Maybe for a document or a window or something?

@jyasskin
Copy link
Member

jyasskin commented Apr 6, 2016

I wouldn't mark https://html.spec.whatwg.org/multipage/browsers.html#origin "for" anything. That's just what an origin is. If there's a definition of "the origin of a document", then that would be <dfn for="document">origin</dfn>.

domenic pushed a commit that referenced this issue May 2, 2016
This adds the appropriate data attributes, per
https://github.com/tabatkins/bikeshed/blob/master/docs/dfn-contract.md,
to worker-related <dfn>s. This will allow specs using that contract,
such as those written in Bikeshed, to automatically link to these terms.

Part of #998.
@domenic
Copy link
Member Author

domenic commented Oct 21, 2016

We've done pretty well so far; many of the above are unnecessary, although we should probably check. https://github.com/w3c/IndexedDB/blob/gh-pages/index.bs is also good.

domenic added a commit that referenced this issue Oct 21, 2016
This exports all the terms used by Service Worker, DOM, File API, and
IndexedDB. Closes #998.
domenic added a commit that referenced this issue Oct 21, 2016
This exports all the terms used by Service Worker, DOM, File API, and
IndexedDB. Closes #998.
annevk pushed a commit that referenced this issue Oct 22, 2016
This exports all the terms used by Service Worker, DOM, File API, and
IndexedDB. Closes #998.
domenic added a commit that referenced this issue Nov 1, 2016
This includes those used by Fetch, Fullscreen, and some for Service
Workers that were not previously taken care of. It also includes all
events in the event index.

Closes #1997 by including its contents. Part of #998.
alice pushed a commit to alice/html that referenced this issue Jan 8, 2019
This exports all the terms used by Service Worker, DOM, File API, and
IndexedDB. Closes whatwg#998.
alice pushed a commit to alice/html that referenced this issue Jan 8, 2019
This includes those used by Fetch, Fullscreen, and some for Service
Workers that were not previously taken care of. It also includes all
events in the event index.

Closes whatwg#1997 by including its contents. Part of whatwg#998.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

4 participants