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

Updated Reflow understanding doc #4055

Draft
wants to merge 42 commits into
base: main
Choose a base branch
from

Conversation

scottaohara
Copy link
Member

@scottaohara scottaohara commented Sep 5, 2024

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).

  • identify all the reflow related issues this PR will close :)
  • add all the new graphics to this PR
  • make sure the added graphics render properly
  • add failure examples (per wg call requesting these)

Preview link

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)
Copy link

netlify bot commented Sep 5, 2024

Deploy Preview for wcag2 ready!

Name Link
🔨 Latest commit 9eea703
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/6740d16c2ec2b40008c5594f
😎 Deploy Preview https://deploy-preview-4055--wcag2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

fix some missing/stray markup end tags
understanding/21/reflow.html Outdated Show resolved Hide resolved
Co-authored-by: Dan Bjorge <dan@dbjorge.net>
@bruce-usab
Copy link
Contributor

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
@scottaohara
Copy link
Member Author

scottaohara commented Sep 13, 2024

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.
@bruce-usab
Copy link
Contributor

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
<!DOCTYPE html>
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Adjusting indentation </title>
Copy link
Member

Choose a reason for hiding this comment

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

this will need to be updated to match whatever heading we settle on

@mbgower mbgower self-assigned this Nov 1, 2024
<p>Reflow applies to both horizontally and vertically written languages. For pages where the primary written language expects vertical scrolling (such as English), users do not expect to scroll back-and-forth horizontally to read that content. Similarly, users reading content in a written language/direction that expects horizontal scrolling (such as traditional Chinese and Japanese) do not have to scroll up-and-down vertically to read that content.</p>

<div class="note">
<p>Reflow does not prohibit web pages from presenting both horizontal and vertical scrollbars for individual sections of content, nor does it disallow the use of bi-directional scrollbars at the page (viewport) level, when the content has been enlarged.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm concerned that the last half of this essentially lets almost every case drive through a giant loophole. It appears to say that when you have zoomed in, bi-directional scrolling is not a fail.

Copy link
Member Author

Choose a reason for hiding this comment

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

thanks @alastc - i see your point. The intent of this was to call out that bi-directional scroll bars at a page level do not necessarily mean the web page fails, so long as the scroll bars are there because of an exception, or if scroll bars appear but the content of the page can still be viewed without having to actually scroll in two directions to read it.

i hope that reading the rest of the doc makes this clear in context - but i can work on rewording this a bit so as to not to give off the wrong impression.

<link rel="stylesheet" href="../../css/sources.css" class="remove"/>
</head>
<body>
<h1>New technique title goes here</h1>
Copy link
Member Author

Choose a reason for hiding this comment

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

@detlevhfischer
Copy link
Contributor

Minor nitpick: There is an instance in the revised understanding text where "etc." ends a somewhat incomplete sentence in an odd way:

For instance, tabular data, graphics, maps, presentations, interfaces that necessiate persistent toolbars, etc.

Maybe replace with:

Examples are tabular data, graphics, maps, presentations, or interfaces that necessiate persistent toolbars.

roll back some of the edits to the in brief.  but we should probably talk about this some more.

addressed feedback from alastair re: the first note.  And takes Detlev's suggestion to reword the sentence calling out the types of excepted content.
pulling in some of mike's suggestions, and making further edits based on those.
scottaohara and others added 4 commits November 22, 2024 10:45
Co-authored-by: Giacomo Petri <giacomo.petri@usablenet.com>
Co-authored-by: Giacomo Petri <giacomo.petri@usablenet.com>
Co-authored-by: Giacomo Petri <giacomo.petri@usablenet.com>
additional wording changes concerning scrollable tables, inspired bi giacomo's accepted suggested wording changes
scottaohara and others added 5 commits November 22, 2024 13:18
Co-authored-by: Giacomo Petri <giacomo.petri@usablenet.com>
Co-authored-by: Giacomo Petri <giacomo.petri@usablenet.com>
thank you!

Co-authored-by: Giacomo Petri <giacomo.petri@usablenet.com>
Co-authored-by: Giacomo Petri <giacomo.petri@usablenet.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants