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

Editorial: make domintro typography more uniform #6901

Merged
merged 12 commits into from
Jul 27, 2021
Merged

Editorial: make domintro typography more uniform #6901

merged 12 commits into from
Jul 27, 2021

Conversation

domenic
Copy link
Member

@domenic domenic commented Jul 26, 2021

This implements some of the changes described in whatwg/meta#190 (comment) for our "For web developers (non-normative)" boxes, i.e. "domintro" boxes. Although the first three domintros were rewritten by hand and thus reflect all of those changes, the rest were transformed in an automated fashion, with only the following transformations applied:

  • Wrap the entire line in <code> instead of just some property names.
  • Remove spaces around dots and parentheses.
  • Move ...s before the argument, like JavaScript, instead of after.

Additionally the nature of the automated process involved rewrapping all the <dd> contents, and unwrapping all <dt> contents. Some linebreaks were removed and inserted as well to give a consistent style.


Please remember to squash before merging!

I suggest reviewing the first commit and then optionally skimming some of the others at random.


/browsers.html ( diff )
/browsing-the-web.html ( diff )
/canvas.html ( diff )
/common-dom-interfaces.html ( diff )
/comms.html ( diff )
/custom-elements.html ( diff )
/dnd.html ( diff )
/dom.html ( diff )
/dynamic-markup-insertion.html ( diff )
/embedded-content-other.html ( diff )
/embedded-content.html ( diff )
/form-control-infrastructure.html ( diff )
/form-elements.html ( diff )
/forms.html ( diff )
/history.html ( diff )
/image-maps.html ( diff )
/imagebitmap-and-animations.html ( diff )
/input.html ( diff )
/interaction.html ( diff )
/interactive-elements.html ( diff )
/introduction.html ( diff )
/links.html ( diff )
/media.html ( diff )
/origin.html ( diff )
/scripting.html ( diff )
/semantics.html ( diff )
/server-sent-events.html ( diff )
/system-state.html ( diff )
/tables.html ( diff )
/text-level-semantics.html ( diff )
/timers-and-user-prompts.html ( diff )
/urls-and-fetching.html ( diff )
/web-messaging.html ( diff )
/web-sockets.html ( diff )
/webappapis.html ( diff )
/webstorage.html ( diff )
/window-object.html ( diff )
/workers.html ( diff )
/worklets.html ( diff )

source Show resolved Hide resolved
source Show resolved Hide resolved
source Show resolved Hide resolved
source Show resolved Hide resolved
data-x="dom-CanvasRenderingContext2DSettings-willReadFrequently">willReadFrequently</code>
member is true if the context is marked for <span
data-x="concept-canvas-will-read-frequently">readback optimization</span>.</li>
<li><code data-x="dom-CanvasRenderingContext2DSettings-willReadFrequently">willReadFrequently</code>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<li><code data-x="dom-CanvasRenderingContext2DSettings-willReadFrequently">willReadFrequently</code>
<li>The <code data-x="dom-CanvasRenderingContext2DSettings-willReadFrequently">willReadFrequently</code>

"Preparation" consists of uniformizing markup and fixing some bad tags so that an automated pass won't mess things up too much
Almost all wrapping changes.
If it's a single paragraph we don't wrap them
and convert inner <code>s into <span>s
They look especially weird with the code font
i.e. "( " -> "(") and " )" -> ")"
@domenic domenic merged commit 0d63ebc into main Jul 27, 2021
@domenic domenic deleted the domintro-pass branch July 27, 2021 16:45
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.

2 participants