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

Ruby Markup Coordination #14

Merged
merged 17 commits into from
Feb 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

* [Memorandum of Understanding Between W3C and WHATWG](https://www.w3.org/2019/04/WHATWG-W3C-MOU.html)
* [Update, 30 June 2021](https://www.w3.org/2021/06/WHATWG-W3C-MOU_2021_update.html)
* [Agreement on HTML Ruby Markup](https://www.w3.org/2022/02/ruby-agreement)
5 changes: 5 additions & 0 deletions ruby/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Agreement on HTML Ruby Markup

This directory contains:

* an exact copy of the Agreement on HTML Ruby Markup
38 changes: 38 additions & 0 deletions ruby/ruby-agreement.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<!doctype html>
<html lang="en">
<meta charset="utf-8">
<meta name="viewport" content="width=device-width">
<title>Agreement on HTML Ruby Markup</title>
<style>
body {
max-width: 50em;
margin: auto;
font-family: sans-serif;
}
</style>

<h1>Agreement on HTML Ruby Markup</h1>

<p>
The W3C will specify extended HTML Ruby markup
Copy link
Member

Choose a reason for hiding this comment

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

This should read:

The W3C has the option to specify extended HTML Ruby markup

since we can't commit to do this without proper AC Review of the charter and HTML Working Group approval.

Choose a reason for hiding this comment

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

@plehegar Can we just switch “will” to “may” here rather than complicating the phrasing?

Copy link
Member

Choose a reason for hiding this comment

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

sure

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See #15

(based on <a href="https://github.com/whatwg/html/pull/6478">PR#6478</a>)
under the <a href="https://www.w3.org/Consortium/Process/#rec-track">REC track</a>.
This will be a derived document with some textual copying from <a href="https://html.spec.whatwg.org/multipage/">WHATWG HTML</a>
and <a href="https://www.w3.org/TR/2014/NOTE-html-ruby-extensions-20140204/">W3C HTML Ruby Markup Extensions</a>,
but the W3C and WHATWG mutually agree that publishing it is within the bounds of our <a href="https://www.w3.org/2019/04/WHATWG-W3C-MOU">MoU</a>.

<p>
W3C editors may offer pull requests to keep the HTML spec in sync,
both technically and editorially,
for the subset of features defined in both specs,
so that readers of both specs can benefit from any improvements.
Once the <a href="https://whatwg.org/working-mode#additions">criteria for addition</a> to WHATWG Living Standards are met,
W3C editors may also offer pull requests to fully integrate the extended ruby markup definitions
into WHATWG HTML.
WHATWG HTML editors will review these contributions in good faith,
and merge those they deem acceptable
under the WHATWG <a href="https://whatwg.org/working-mode">working mode</a>.
Comment on lines +29 to +34
Copy link
Member

Choose a reason for hiding this comment

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

We'd like to propose a rewording:

In the event that W3C editors offer pull requests to fully integrate the extended ruby markup definitions into WHATWG HTML, once the <a href="https://whatwg.org/working-mode#additions">criteria for addition</a> to WHATWG Living Standards are met, WHATWG HTML editors will review these contributions in good faith, and merge those they deem acceptable under the WHATWG working mode.

Copy link

@fantasai fantasai Feb 16, 2022

Choose a reason for hiding this comment

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

@plehegar I can't tell what this rewording is accomplishing, and I think it's harder to read. Can you explain what the problem is you're trying to solve?

If it's only aesthetic, can we please just keep the current wording?

Copy link
Member

Choose a reason for hiding this comment

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

Linking the two clauses avoids the implication that W3C editors couldn't offer PRs without the agreement.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks @fantasai for reaching out to discuss further. We found we were reading an ambiguity into "may" that could be resolved by indicating the RFC 2119 terminology, that MAY specifically means optionality rather than permission.

I would support a global substitution of "MAY" for "may".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

See #15


<p>
The <abbr title="Status Of This Document">SOTD</abbr> section of the W3C Ruby Extension spec
will link to this agreement.