-
Notifications
You must be signed in to change notification settings - Fork 281
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
Updated Reflow understanding doc #4055
Conversation
This initial commit takes the current draft from the google doc that had been worked on for quite some time now, and makes it into a PR for further editing and review. Not all feedback from the google doc was directly taken/addressed, but there have been additional changes made that attempted to consider a good portion of the unresolved comments. Marking this PR as a draft, as there is still work to do (and I also need to upload all the new graphics for the examples - and a few examples still need to be created, which are currently marked as comments in the HTML file)
✅ Deploy Preview for wcag2 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
fix some missing/stray markup end tags
Co-authored-by: Dan Bjorge <[email protected]>
Briefly discussed on backlog call 9/6. |
attempt at further addressing issues: 2043 and 366
trying this text out to see what people think. again i'm wary about saying viewport here since that's not always what is needed.
attempting to briefly address issue 3311 and 648
making notes of existing issues addressed with this PR (more to come):
|
add in the carousel/swimlane examples that were noticed as missing during today's call. fix the broken animated gif and put it into a disclosure widget so that someone who doesn't want to see the animation can open/close it.
Discussed on backlog call 9/13, thank you @scottaohara! A preview is available but a reminder that the PR is still a work in progress. Most (but not all) content from Google Doc drafting has been pulled in and Scott has placeholders and inline notes-to-self. Looking really good! Outstanding question to @iadawn about replacing 4mb animated gif with an MP4, but where should a multimedia file go? TF would be okay with publishing without (and adding later) as the MVP need not be perfect. |
thanks @mfairchild365 for suggestions in simplifying my wordy intro paragraphs.
- wording updates per feedback i received off-github - added content to replace the "todo" placeholder content for section that introduces the carousel example
- spelling mistakes corrected - wording modifications to in brief section - expand tabular data section to call out grid-based UI, incorporating from off-github suggestion to reference "electronic program guides"
part 1 of at least 2. various wording adjustments for things that people commented could have been clearer. comment in the html to add a failing example (line 96)
the images were rather large - so made them a bit smaller to hopefully make the doc feel less 'broken up' by them
move the scoping of exceptions section into the exceptions section (preceded it, and that was weird) also fixes a paragraph with a missing start tag
Understanding pages typically share a consistent structure with regard to level 2 headings, and therefore the table of contents. This page deviates significantly:
This may cause a jarring experience for folks used to navigating the rest of the Understanding pages, including the previous version of this one. Is this divergence in |
@kfranqueiro I had made this comment about the benefits section for thoughts from the task force. @giacomo-petri responded, but i suspect many others didn't notice here's the text of the comment, as it's likely hidden to most due to the number of comments/commits in this PR
so yes, benefits and examples are spread throughout the doc (though there is also still an examples section, and it is in the TOC) Re:
and yes, this was done on purpose and had been discussed in the task force meetings as being done to make the TOC more useful, particularly since this doc is now so much longer than most other understanding docs. |
Thanks @scottaohara for catching me up / reminding me, and sorry for what probably felt like a redundant question while I had my maintainer hat on. |
no problem @kfranqueiro - it was good to call out, as many people coming into this thread will not have had any of that context / could likely miss the comment about removing benefits (since it's hidden by default). so thank you for bringing these points up |
First, modern Japanese text uses both vertical and horizontal writing. Moreover, a single web page can incorporate both writing directions. This might already seem complex, but there are even more intricate aspects to consider. Even if an entire web page uses vertical writing, it may have multiple columns, ensuring that only vertical scrolling is needed instead of horizontal scrolling. Here are two examples: https://www.renhai.org.tw/AboutUs That said, a web page with reflowable Japanese text never requires both horizontal and vertical scrolling simultaneously. |
Oh my Thanks @murata2makoto not so simple indeed. these links we should capture someplace where we can easily look at them when we are creating our new rules and thinking on scrolling and wrapping etc. @murata2makoto do these pages behave well for scrolling and wrapping? if not - do you have some reference pages we can use that do behave well? |
@murata2makoto For your second example, when the page is magnified to 400%, the top navigation remains in view the whole time, taking up a sizable portion of the viewport and preventing vertically written text from displaying inside the remaining space. If this top bar was removed/collpased, it appears to me (without doing actual measurements) that some but not all the vertically written sections would meet the Reflow requirements.
Other parts of the page do not accomplish this past about 200% zoom. In the following screenshot, the text in the area with the whitebackground fits at 200%, but beyond that, even if the top banner were dismissed, the text would not fit vertically in the viewport without scrolling. I also find that the text isn't really doing much reflow. The heading is repositioned to proceed the chunk at the next level of navigation, but the lines do not seem to flow to a set vertical height.
Your examples are interesting to me from the perspective that although the text is vertically written, it is often designed to fit within a vertical page flow. The language of the success criterion is written from the assumption that vertically written text would not be presented on a page that scrolled vertically, but on a page that scrolled horizontally. Thus, the language of the success criterion seems to be passed even where IMO, the page is failing to allow vertical text to be read without scrolling "in the direction of text".
Agreed. Even in the final image with the text on a white background, the user never needs to scroll horizontally to read this. But the intended purpose of Reflow -- that a user does not need to scroll vertically to read vertically written languages nor need to scroll horizonally to read L2R/R2L languages, and -- is not met. @scottaohara you should review. I'd also ask @MakotoUeki to weigh in on this. |
I think the assumption was that horizontal text would be part of a page that had vertical scrolling and that vertical text would be part of a page that had horizontal scrolling - thus the wording of the SC. If vertically scrolling text also can be scrolled vertically then that doesn't seem to be clearly covered by the wording. |
How do you like these small and simple pages:
Please view those pages in the "Full Page" view and shrink the browser window to small. The browser controls the width of the column, sending the overflow characters to the following line and sending the overflow lines to the next column. |
@mbgower @murata2makoto - I think Mike's assessment is spot on. I went over these two example pages and from what i could tell the first example seemed like it could end up being a good example of how to meet Reflow - as the text that was written vertically changes to be horizontally presented at smaller viewports. The second example, imo, passes Reflow while not meeting the intent. The page only scrolls vertically - but the text is presented vertically. Someone may have to scroll back and forth (up/down) to read a section of text.... but they don't have to scroll in two dimensions AND the vertical text is not horizontally scrolling (so 320 width applies, not 256 height) - so per the wording of the requirement (which is out of scope for this PR) this passes. |
…niques" This reverts commit 874fe86. (Sorry for the noise; I realized the hard tab usage is intentional, even if it does look inconsistent)
working-examples/reflow-carousel-panel-horizontal-scroll/index.html
Outdated
Show resolved
Hide resolved
working-examples/reflow-carousel-panel-horizontal-scroll/index.html
Outdated
Show resolved
Hide resolved
working-examples/reflow-carousel-panel-horizontal-scroll/index.html
Outdated
Show resolved
Hide resolved
Discussed on backlog call 3/7 and everyone for publishing. TF facilitators discussed after call, to either give more review time or go forward with publishing, and advanced this PR to Fully Reviewed. Thank you @scottaohara and everyone for the feedback! |
This initial commit takes the current draft from the google doc that had been worked on for quite some time now, and makes it into a PR for further editing and review.
Not all feedback from the google doc was directly taken/addressed, but there have been additional changes made that attempted to consider a good portion of the unresolved comments.
Marking this PR as a draft, as there is still work to do (and I also need to upload all the new graphics for the examples - and a few examples still need to be created, which are currently marked as comments in the HTML file).
The latest updates will be visible via this preview link of the understanding doc
Closes #3121