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

Omit unnecessary elements in the dev edition #52

Merged
merged 1 commit into from
Jun 20, 2017
Merged

Omit unnecessary elements in the dev edition #52

merged 1 commit into from
Jun 20, 2017

Conversation

domenic
Copy link
Member

@domenic domenic commented Jun 15, 2017

Omits the small TOC, fingerprint markers, and <pre class=idl> blocks.

Part of #27.

Omits the small TOC, fingerprint markers, and <pre class=idl> blocks.

Part of #27.
@domenic
Copy link
Member Author

domenic commented Jun 15, 2017

Right now CSS is still hiding the TOC elements below level 2; that's probably fixable too...

@zcorpan
Copy link
Member

zcorpan commented Jun 19, 2017

Do web developers really not want to see IDL blocks?

It seems to me there would be weird stuff surrounding the missing IDL blocks; those should be handled with w-nodev if we actually want to hide them, instead of just yanking the pre element, I think.

@domenic
Copy link
Member Author

domenic commented Jun 19, 2017

IDL blocks are certainly omitted in developers.whatwg.org. I think they do not; they are pretty meaningless, using terms like interface, attribute, readonly, [CEReactions], etc. which are very unhelpful for developers. Instead developers are meant to get an idea of the API from the domintro boxes.

The main IDL blocks that get hidden by this are the ones in the element intro boxes. Most others are already hidden with w-nodev.

@zcorpan
Copy link
Member

zcorpan commented Jun 20, 2017

OK. So maybe we should instead add w-nodev to the dt/dd in the element boxes? Having a stray "DOM interface:" and then nothing or sometimes "Uses HTMLElement" is weird.

Possibly the element boxes in dev edition should say "DOM interface: Uses HTMLPictureElement" instead of the full IDL block?

@zcorpan
Copy link
Member

zcorpan commented Jun 20, 2017

Upon closer inspection, I think it's in many cases OK to remove IDL blocks, so this change is OK. But there are some tweaks we should do to source here and there. I can take a stab at that.

Copy link
Member

@sideshowbarker sideshowbarker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given the main point of the developer edition as far as its content goes is to reduce the amount of information that developers have to wade through that’s not essential to their information needs, I agree it makes sense to omit the IDL. Developers who want to the see the IDL can always read the full spec.

@domenic domenic merged commit 514a98b into master Jun 20, 2017
@domenic domenic deleted the omit-stuff branch June 20, 2017 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants