Update to a spec draft document #251

gked · 2020-05-07T21:38:30Z

Closes #176

The following tasks have been completed:

[Fix linking error in the spec for DOMTokenList in contenteditable-disabled doc #250 ] Confirmed there are no ReSpec/BikeShed errors or warnings.

This PR addresses current vision of the shape of contenteditable-disabled proposal.
In previous discussions, the group talked about

disabling UI that is not available in the editor (e.g. markdown scenarios for font commands)
controlling Undo/Redo UI
disabling some input UI that can show up on a page unexpectedly on user focus. e.g. voice typing UI that Windows team is experimenting with.

We've realized that a more efficient solution for 2 would be to take advantage of Undo API to to communicate to UA correct state of UI at all times.

Edge team has internally discussed 3rd use case and has a number of open questions around if it's the right fit for contenteditable-disabled. Resolution was to spend more time thinking about it.

As a result current draft is only about disabling UI (formatting UI only).

first change

…ue to github issue.

Minor fixes

johanneswilm · 2020-05-07T22:23:26Z

Active Documents/contenteditable-disabled.html

+    <section id="introduction">
+        <h2>Introduction</h2>
+        <p>
+            In contenteditable regions of documents, some user agents provide contextual user interface (UI) elements to help accelerate common editing operations.  The UI is meant to enhance the editing experience, but when authors create customized editors that aren’t compatible with user agent UI, it leads to confused users.


aren’t => aren't

@johanneswilm don't forget you can use GitHub's funky new suggestion button:

You can then suggest changes inline that can be merged straight in.

Active Documents/contenteditable-disabled.html

BoCupp-Microsoft · 2020-05-07T22:49:21Z

Active Documents/contenteditable-disabled.html

+                }
+            ],
+            github: "https://github.com/w3c/editing",
+            shortName: "contenteditable-interface",


Just noticed the short name doesn't match. Should this be contenteditable-disabled too?

I'd think so.

Forgot to push? 👀

hmm, let me check.

I've been pushing my changes through my coworker's fork and the changes are not flowing in, somehow, I am making an attempt to edit the file in the PR.

johanneswilm

Nice work @gked and @BoCupp-Microsoft ! I noticed you removed supported. This was something we had added after discussing whether to blacklist or to whitelist to kind of allow whitelisting anyway while giving a preference for blacklisting.

The reason this is important to JS editors is that it took several of the JS editor companies several months to discover that the Mac touch bar had been launched. During this time, their users would use the buttons of this bar and nothing would happen in the users editors or even worse - the editors were breaking. The same can happen again with new devices launches with new versions of browsers and operating systems that not every development team is aware of immediately. For that reason there was a demand for a way to query all the supported options that then can be disabled subsequently.

Maybe we need to open a ticket about this?

BoCupp-Microsoft · 2020-05-07T22:54:23Z

Active Documents/contenteditable-disabled.html

+        </p>
+        <p class="issue" title="missing fontSize and insertImage">
+            fontSize / insertImage is missing from beforeInput.  Why?  It seems that it should be listed to create a more complete set.
+            <a href="https://github.com/w3c/editing/issues/249">Issue 249</a>


I believe if you use data-number ReSpec will link the issue for you. I find these features by clicking the ReSpec button, then clicking about ReSpec, and then clicking the link that sounds most like what I want to do. In this case it took me here: https://github.com/w3c/respec/blob/develop/src/core/issues-notes.js

yep, please see also:
https://github.com/w3c/respec/wiki/data--number

BoCupp-Microsoft · 2020-05-07T22:55:22Z

Active Documents/contenteditable-disabled.html

+        <pre class="idl">
+            [Exposed=Window]
+            interface ElementContentEditable {
+                [SameObject, PutForwards=value] readonly attribute DOMTokenList contentEditableDisabled;


This readonly might be incorrect if we have a PutForwards. Need to check the webidl spec.

No actually that looks correct: https://heycam.github.io/webidl/#PutForwards

The JPG version of ios-editing-buttons looks unused and can be deleted.

fixed.

BoCupp-Microsoft · 2020-05-07T22:57:59Z

Active Documents/contenteditable-disabled.html

+            };
+        </pre>
+        <p>
+            The <code>contentEditableDisabled</code> WebIDL property reflects the contenteditable-disabled DOM content attribute.


There are some things in this spec that should be definitions and others that should be linking to those definitions. Need to determine how to make that happen in ReSpec. For example, contenteditable-disabled DOM content attribute should probably be linking back to the definition for that phrase.

yeah, I've created an issue to fix DOMTokenList linking, I can use it for all dfns related fixes.

Nice work @gked and @BoCupp-Microsoft ! I noticed you removed supported. This was something we had added after discussing whether to blacklist or to whitelist to kind of allow whitelisting anyway while giving a preference for blacklisting.

The reason this is important to JS editors is that it took several of the JS editor companies several months to discover that the Mac touch bar had been launched. During this time, their users would use the buttons of this bar and nothing would happen in the users editors or even worse - the editors were breaking. The same can happen again with new devices launches with new versions of browsers and operating systems that not every development team is aware of immediately. For that reason there was a demand for a way to query all the supported options that then can be disabled subsequently.

Maybe we need to open a ticket about this?

Sounds good, I created an issue and tagged with Agenda+ to be discussed tomorrow.

When xref option is enabled, DOMTokenList will link correctly :)

BoCupp-Microsoft · 2020-05-07T23:04:43Z

The JPG version of ios-editing-buttons looks unused and can be deleted.

marcoscaceres · 2020-05-08T04:47:09Z

Active Documents/contenteditable-disabled.html

+    <section id="introduction">
+        <h2>Introduction</h2>
+        <p>
+            In contenteditable regions of documents, some user agents provide contextual user interface (UI) elements to help accelerate common editing operations.  The UI is meant to enhance the editing experience, but when authors create customized editors that aren’t compatible with user agent UI, it leads to confused users.


Suggested change

In contenteditable regions of documents, some user agents provide contextual user interface (UI) elements to help accelerate common editing operations. The UI is meant to enhance the editing experience, but when authors create customized editors that aren’t compatible with user agent UI, it leads to confused users.

In contenteditable regions of documents, some user agents provide contextual user interface (UI) elements to help accelerate common editing operations. The UI is meant to enhance the editing experience, but when authors create customized editors that aren't compatible with user agent UI, it leads to confused users.

I pushed another commit. It caused github to disable Commit Suggestion button. I'll make a change on my and push it here.

marcoscaceres · 2020-05-08T04:50:01Z

Active Documents/contenteditable-disabled.html

+            license: "w3c-software-doc"
+        };
+    </script>
+    <script src='https://www.w3.org/Tools/respec/respec-w3c-common' class='remove'></script>


Nit: common profile is deprecated...

Suggested change

<script src='https://www.w3.org/Tools/respec/respec-w3c-common' class='remove'></script>

<script src='https://www.w3.org/Tools/respec/respec-w3c' class='remove'></script>

I pushed another commit. It caused github to disable Commit Suggestion button. I'll make a change on my and push it here.

marcoscaceres · 2020-05-08T04:51:35Z

Active Documents/contenteditable-disabled.html

+    <section id='abstract'>
+        <h2>Abstract</h2>
+        <p>
+            This specification defines an API that indicates to user agents which editing-related commands are applicable to contenteditable regions of a document.  User agents SHOULD take this information into account when presenting any editing-related UI to ensure its applicability.


Avoid RFC2119 keywords in non-normative sections.

Suggested change

This specification defines an API that indicates to user agents which editing-related commands are applicable to contenteditable regions of a document. User agents SHOULD take this information into account when presenting any editing-related UI to ensure its applicability.

This specification defines an API that indicate which editing-related commands are applicable to `contenteditable` regions of a document. User agents can take this information into account when presenting any editing-related UI to ensure its applicability.

"its applicability" is unclear... what is "its" there?

The 'its' is referring to editing-related UI in that sentence. The API provides hints as to what editing operations (and therefore what editing UI) are applicable in a given contenteditable element. We could change it to... "User agents can take this information into account when presenting any editing-related UI to ensure it is applicable to a given contenteditable region."

I pushed another commit. It caused github to disable Commit Suggestion button. I'll make a change on my and push it here.

marcoscaceres · 2020-05-08T04:54:14Z

Active Documents/contenteditable-disabled.html

+            This specification defines an API that indicates to user agents which editing-related commands are applicable to contenteditable regions of a document.  User agents SHOULD take this information into account when presenting any editing-related UI to ensure its applicability.
+        </p>
+        <p>
+            This specification purposefully does not prescribe the means by which a user agent will indicate to the user that some commands are not applicable in a given contenteditable region.


This sentence reads like a double negative.

Maybe... "This specification purposefully does not prescribe the means by which a user agent will indicate to the user the applicability of any editing command. The user agent could, for example, omit editing UI, disable it, or choose some other appropriate UI treatment."

I am taking Bo's suggestion and will push the changes in the next iteration.

marcoscaceres · 2020-05-08T05:28:57Z

Active Documents/contenteditable-disabled.html

+        <p class="issue" title="missing fontSize and insertImage">
+            fontSize / insertImage is missing from beforeInput.  Why?  It seems that it should be listed to create a more complete set.
+            <a href="https://github.com/w3c/editing/issues/249">Issue 249</a>
+        </p>


Suggested change

<p class="issue" title="missing fontSize and insertImage">

fontSize / insertImage is missing from beforeInput. Why? It seems that it should be listed to create a more complete set.

<a href="https://github.com/w3c/editing/issues/249">Issue 249</a>

</p>

<div class="issue" data-number="249">

</div>

marcoscaceres · 2020-05-08T05:32:01Z

Active Documents/contenteditable-disabled.html

+            };
+        </pre>
+        <p>
+            The <code>contentEditableDisabled</code> WebIDL property reflects the contenteditable-disabled DOM content attribute.


Suggested change

The <code>contentEditableDisabled</code> WebIDL property reflects the contenteditable-disabled DOM content attribute.

The {{ElementContentEditable/contentEditableDisabled}} IDL attribute reflects the contenteditable-disabled DOM content attribute.

marcoscaceres · 2020-05-08T05:39:07Z

Just a note for the editors... the following resource might help you with ReSpec usage:

https://github.com/w3c/respec/wiki/Shorthands-Guide

marcoscaceres

Couple of things we should sort out... let me know if we should split them into followup bugs or not.

@saschanaz, you wanna go through this also?

saschanaz · 2020-05-08T18:25:22Z

This is super hard to read diffs, could we restore the name and rename in a separate PR?

marcoscaceres · 2020-05-10T04:38:21Z

@saschanaz, might be ok to treat this as an entirely new spec and ignore the diff? The spec itself is pretty small and think we’ve identified some showstoppers already.

saschanaz · 2020-05-10T05:50:40Z

@saschanaz, might be ok to treat this as an entirely new spec and ignore the diff? The spec itself is pretty small and think we’ve identified some showstoppers already.

I think showstoppers don't force abandoning diffs, though.

marcoscaceres · 2020-05-10T09:37:37Z

I guess. Whatever is easiest.

first round of PR feedback

addressing some of the PR feedback

undoing title change

marcoscaceres · 2020-05-20T07:49:27Z

Stupid question... but y u no contenteditable=“disabled”? Is that because any truthy attribute value enables it? Even if so, maybe one can feature detect for it... like set it to “disabled”, if it becomes “”, then remove the attribute. Otherwise, it’s supported. Just a thought.

Active Documents/contentEditableDisabled.html

saschanaz · 2020-05-23T17:36:31Z

Active Documents/contentEditableDisabled.html

+        </p>
+        <p class="issue" title="missing fontSize and insertImage">
+            fontSize / insertImage is missing from beforeInput.  Why?  It seems that it should be listed to create a more complete set.
+            <a href="https://github.com/w3c/editing/issues/249">Issue 249</a>


This should reflect the discussion result. Maybe just a note that those are missing.

We discussed this at the meeting and agreed to remove them from both specs for now.

saschanaz · 2020-05-23T17:43:30Z

Active Documents/contentEditableDisabled.html

+            </ul>
+        </p>
+        <p class="note">
+            Note that this specification does not have a shortcut to disable all editing UI.  Authors should consider using a <code>textarea</code> or <code>contenteditable="plaintext-only"</code> for this purpose.


I think plaintext-only shouldn't be recommended as it's currently removed from the spec.

Active Documents/contentEditableDisabled.html

Co-authored-by: Kagami Sascha Rosylight <saschanaz@outlook.com>

gked · 2020-08-11T14:36:11Z

@marcoscaceres and @saschanaz: apologies for leaving this PR hanging. I just got back from a 2 month leave. This PR became really messy in terms of the changes. If you don't mind, I'll abandon it and re-create a new PR with all of the comments here addressed.

saschanaz · 2020-08-11T14:37:47Z

If you don't mind, I'll abandon it and re-create a new PR with all of the comments here addressed.

Sounds good 👍

johanneswilm · 2021-07-24T09:42:11Z

@gked @BoCupp-Microsoft What is the status here? Can we get these changes merged? The document has been moved since so we'll need to update the PR - or have it all be merged through an alternative PR as you mentioned earlier.

johanneswilm · 2021-08-05T19:08:09Z

@BoCupp-Microsoft @travisleithead I will put this on the agenda for the next call. If it can be resolved before then, we can remove it from the agenda again. Basically, the question is whether there is a new PR being developed somewhere that addresses the feedback that was collected in this PR or whether that is not the case. If it is not the case, should we put it on someone's todo list to create such a PR?

travisleithead · 2021-08-06T23:42:42Z

@johanneswilm yes, it looks like PR #265 is actually the "non-messy" version of this PR that @gked promised. I think it's safe to close this PR unmerged at this point and focus on the one. (I'll transfer your Agenda+ label to that PR so that it can be discussed next week too.

travisleithead · 2021-08-06T23:44:18Z

Closing this PR in favor of #265

BoCupp-Microsoft and others added 14 commits March 13, 2020 07:46

update scope of spec

4657165

mark spot for example

df921b8

Change title of spec

709f8de

rename spec

9c805ec

Record a bunch of issues and share WIP document

6650990

first change

31838e6

more changes to the spec

287485f

partial change

5577038

Merge pull request #1 from BoCupp-Microsoft/grishaChange

b607b9c

first change

updating with examples and fixing some grammatical issues

936bb59

small changes

c752195

removing setting

2b5014b

reverting what i though to be a correct grammar fix. Also, linked iss…

aa88953

…ue to github issue.

Merge pull request #2 from BoCupp-Microsoft/minorFixes

ba03b4e

Minor fixes

gked requested review from johanneswilm and marcoscaceres May 7, 2020 22:13

johanneswilm reviewed May 7, 2020

View reviewed changes

johanneswilm approved these changes May 7, 2020

View reviewed changes

BoCupp-Microsoft reviewed May 7, 2020

View reviewed changes

Active Documents/contenteditable-disabled.html Outdated Show resolved Hide resolved

BoCupp-Microsoft reviewed May 7, 2020

View reviewed changes

johanneswilm reviewed May 7, 2020

View reviewed changes

BoCupp-Microsoft reviewed May 7, 2020

View reviewed changes

first round of PR feedback

20458af

marcoscaceres reviewed May 8, 2020

View reviewed changes

marcoscaceres requested changes May 8, 2020

View reviewed changes

Grisha Lyukshin added 5 commits May 19, 2020 21:22

Merge pull request #3 from BoCupp-Microsoft/minorFixes

c2ffdb8

first round of PR feedback

addressing some of the PR feedback

8ee7cf4

Merge pull request #4 from BoCupp-Microsoft/minorFixes

6c46ff8

addressing some of the PR feedback

undoing title change

ac5ba6a

Merge pull request #5 from BoCupp-Microsoft/minorFixes

23bd69c

undoing title change

saschanaz requested changes May 23, 2020

View reviewed changes

Grisha Lyukshin and others added 3 commits August 11, 2020 07:07

Update Active Documents/contentEditableDisabled.html

c1ddf21

Co-authored-by: Kagami Sascha Rosylight <saschanaz@outlook.com>

Update Active Documents/contentEditableDisabled.html

cbd89f8

Co-authored-by: Kagami Sascha Rosylight <saschanaz@outlook.com>

Update Active Documents/contentEditableDisabled.html

a53b2b4

Co-authored-by: Kagami Sascha Rosylight <saschanaz@outlook.com>

gked mentioned this pull request Aug 11, 2020

updating contenteditabledisabled spec draft #265

Merged

1 task

marcoscaceres requested review from marcoscaceres and removed request for marcoscaceres July 26, 2021 04:41

johanneswilm added the Agenda+ Agenda item to be inserted in the Editing TF meeting queue label Aug 5, 2021

travisleithead removed the Agenda+ Agenda item to be inserted in the Editing TF meeting queue label Aug 6, 2021

travisleithead closed this Aug 6, 2021

	In contenteditable regions of documents, some user agents provide contextual user interface (UI) elements to help accelerate common editing operations. The UI is meant to enhance the editing experience, but when authors create customized editors that aren’t compatible with user agent UI, it leads to confused users.
	In contenteditable regions of documents, some user agents provide contextual user interface (UI) elements to help accelerate common editing operations. The UI is meant to enhance the editing experience, but when authors create customized editors that aren't compatible with user agent UI, it leads to confused users.

	<script src='https://www.w3.org/Tools/respec/respec-w3c-common' class='remove'></script>
	<script src='https://www.w3.org/Tools/respec/respec-w3c' class='remove'></script>

	This specification defines an API that indicates to user agents which editing-related commands are applicable to contenteditable regions of a document. User agents SHOULD take this information into account when presenting any editing-related UI to ensure its applicability.
	This specification defines an API that indicate which editing-related commands are applicable to `contenteditable` regions of a document. User agents can take this information into account when presenting any editing-related UI to ensure its applicability.

	The <code>contentEditableDisabled</code> WebIDL property reflects the contenteditable-disabled DOM content attribute.
	The {{ElementContentEditable/contentEditableDisabled}} IDL attribute reflects the contenteditable-disabled DOM content attribute.

Update to a spec draft document #251

Update to a spec draft document #251

Conversation

gked commented May 7, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

johanneswilm left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BoCupp-Microsoft commented May 7, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoscaceres May 8, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoscaceres May 8, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcoscaceres commented May 8, 2020

marcoscaceres left a comment

Choose a reason for hiding this comment

saschanaz commented May 8, 2020

marcoscaceres commented May 10, 2020

saschanaz commented May 10, 2020

marcoscaceres commented May 10, 2020

marcoscaceres commented May 20, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gked commented Aug 11, 2020

saschanaz commented Aug 11, 2020 • edited Loading

johanneswilm commented Jul 24, 2021

johanneswilm commented Aug 5, 2021

travisleithead commented Aug 6, 2021 • edited Loading

travisleithead commented Aug 6, 2021

gked commented May 7, 2020 •

edited

Loading

johanneswilm left a comment •

edited

Loading

marcoscaceres May 8, 2020 •

edited

Loading

marcoscaceres May 8, 2020 •

edited

Loading

saschanaz commented Aug 11, 2020 •

edited

Loading

travisleithead commented Aug 6, 2021 •

edited

Loading