Skip to content
This repository has been archived by the owner. It is now read-only.

Expand IDL acronym in 1st use #883

Closed
agcolom opened this issue Apr 19, 2017 · 8 comments
Closed

Expand IDL acronym in 1st use #883

agcolom opened this issue Apr 19, 2017 · 8 comments
Assignees
Labels

Comments

@agcolom
Copy link
Member

@agcolom agcolom commented Apr 19, 2017

In https://www.w3.org/TR/2017/WD-html52-20170406/infrastructure.html#reflecting-content-attributes-in-idl-attributes the spec use the IDL for the first time. We should specify what IDL stands for. For example, we could change the first sentence:
Some IDL attributes are defined to reflect a particular content attribute.

to

Some Interface Definition Language (IDL) attributes are defined to reflect a particular content attribute.

Does this look ok to you? I can make the change immediately once I get thumbs up to go ahead.

@agcolom

This comment has been minimized.

Copy link
Member Author

@agcolom agcolom commented Apr 19, 2017

Actually, It looks like IDL is used earlier, here: https://www.w3.org/TR/2017/WD-html52-20170406/introduction.html#audience

Does this look like to right place to expand? Otherwise, we could also do it here: https://www.w3.org/TR/2017/WD-html52-20170406/infrastructure.html#idl-attribute

@chaals chaals added the editorial label Apr 19, 2017
@chaals

This comment has been minimized.

Copy link
Collaborator

@chaals chaals commented Apr 19, 2017

I'm not sure whether we should expand those abbreviations, because I believe the common term is in fact the abbreviation not the expansion; much like laser and radar are known terms, but their expansions are not recognisable to most people...

Feel free to be convinced by my argument, or equally free to find that people aren't, and so make the change you propose...

This is not a strongly held opinion and I suspect it boils down to personal preference. Hence the poor level of guidance :S

@agcolom

This comment has been minimized.

Copy link
Member Author

@agcolom agcolom commented Apr 20, 2017

@chaals Leonie and I had a chat about this today, and we thought we could maybe add a link to the WebIDL Sepc (https://www.w3.org/TR/WebIDL-1/) either as well as or instead of expanding the acronym... I'm still thinking about how to best do this (i.e. where and what). Any views welcome :-)

@agcolom agcolom self-assigned this Apr 20, 2017
@chaals

This comment has been minimized.

Copy link
Collaborator

@chaals chaals commented Apr 20, 2017

@agcolom my view is that linking a lot is a good idea, but I wouldn't worry about expanding the acronym. As I said earlier, feel free to disagree and propose whatever edits make sense to you…

@patrickdark

This comment has been minimized.

Copy link

@patrickdark patrickdark commented Apr 24, 2017

Seems appropriate to expand it. Though I think abbreviation clarity issues are generally avoided by liberal use of abbr elements with title attributes.

Also, I find it weird that an HTML specification doesn't use abbr elements (with/without title attributes).

@siusin

This comment has been minimized.

Copy link
Contributor

@siusin siusin commented Sep 18, 2017

According to the WebIDL spec,

This section describes a language, Web IDL, which can be used to define interfaces for APIs in the Web platform.

WebIDL is the name of this specific language, so I don't think it's necessary to use abbr or expand the acronym. Does it help to add the definition of WebIDL to the 2.2.2 Dependencies section?

@LJWatson

This comment has been minimized.

Copy link
Collaborator

@LJWatson LJWatson commented Sep 19, 2017

@siusin
thanks for clarifying that WebIDL is the name of the specification. Agree we should not expand the acronym.

+1 to adding WebIDL as a dependency though.

@chaals

This comment has been minimized.

Copy link
Collaborator

@chaals chaals commented Oct 10, 2017

WebIDL is in there.

@chaals chaals closed this Oct 10, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
5 participants
You can’t perform that action at this time.