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 130 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 or address in some form (see: this comment)
  • add all the new graphics to this PR / render properly
  • identify additional examples / techniques that could be created as additional future improvements

The latest updates will be visible via this preview link of the understanding doc

Closes #3121)

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 a9da106
🔍 Latest deploy log https://app.netlify.com/sites/wcag2/deploys/67afa4d80d74360008a4c484
😎 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
@mbgower mbgower assigned fstrr and unassigned mbgower Feb 7, 2025
@detlevhfischer
Copy link
Contributor

masonry layout

Hearing the term for the first time. Is this a commonly used and understood thing? Explain?

@fstrr
Copy link
Contributor

fstrr commented Feb 7, 2025

Masonry layout has been around for several years, initially using JavaScript to create the layout (for example: Cascading grid layout library). It's slowly being standardized (for example: Masonry layout).

@bruce-usab
Copy link
Contributor

Discussed on backlog call 2/7. @gundulaniemann offered to make one more editorial pass. TF goal is to send to AG by next Friday (2/17).

@fstrr fstrr mentioned this pull request Feb 10, 2025
added in mention of visual grid / masonry layouts to the end of the 'single column' section.

fixed a few typos / tried to shorten some content.
some rewording since i was trying to stress that increasing zoom makes the viewport smaller.  but i reworked the text a bit to make that clearer / work with all the other suggestions from #4055 (comment)
thank you @fstrr for doing the majority of the setup for this example.
add new example
revise text per feedback
@gundulaniemann
Copy link
Contributor

I had another look at the preview to see everything in context.
A few remarks and questions from my side:

Is it possible to add an image of an "electronic program guide"? I have no idea how this might look like, even not from the description.

My next finding has three points, ending with a question.

  1. In technique G301, in the first working example (nested list), the resulting page is too wide in that still horizontal scrolling is needed to read a line of text (tested in edge emulator with 320 px widdh as well as with 1280x1024 with 400% zoom, in the latter case the horizontal scrollbar is not readily available, but the user needs to scroll vertically to reach it, which is very inconvenient.
    The same effect as described above happens in the second example (indented coding): scroll to find the horizontal scrollbar, line of text still doesn't fit into viewport.
  2. In technique G302, in the working example I love the user can proceed via buttons. Nevertheless, wehe emulating in edge the content of one carousel panel cannot be fully seen. a part approximately the double scrollbar width is missing. An horizontal scrollbar to accommodate the padding is not available (and shouldn't be necessary, anyway).
  3. at the end of section "Not all user agents will support this SC's normative sizing requirements" it says:
    "While one can regard the inability to resize fixed-dimension browsers to the 320 CSS pixel or 256 CSS pixel sizes used by this criterion a user agent support issue, it is not the intent of this criterion to mandate that devices need to support these specific sizes for presenting content, nor is it to be assumed that if content cannot be presented within such sizes on specific devices that the web page would pass or fail Reflow. If a web page can be viewed on a device where the sizing requirements of this criterion can be accurately tested, then it is on such devices where a web page's ability to meet Reflow is best to be determined."
    Does that mean that my emulator tests are not suitable? Should a test with emulator be done with other dimensions, like 336x272 CSS px (adding the scrollbar widths)?

I see the test rule "Meta viewport allows for zoom" says all examples passing it also pass reflow, yet the original is for resizing text, which does not imply two dimensional scrolling to be avoided.
So how should reflow be tested?

@patrickhlauke
Copy link
Member

@patrickhlauke to make a stylised/simplified diagram for what an EPG looks like (a la https://en.wikipedia.org/wiki/File:Mythbuntu_Program_Guide.png)

patrickhlauke and others added 3 commits February 14, 2025 18:19
i'm commenting this out for now.  as mentioned, not every understanding doc has a benefits section.  This benefits section made sense in the old version of this understanding doc - but with the new in brief content, and the heavily revised content of this doc, this benefits section is redundant to other content now in this doc, and otherwise lacking in detail.
@scottaohara
Copy link
Member Author

some quick notes to about the responses to gundula's prior comment in this issue, which were made during the task force call today (but posting here so others who may read this issue don't think the comment went unaddressed):

  • we are going to link to a wikipedia page that helps describe the electronic program guide, so as to not have to introduce a tangent to explain that term - while keeping the reference to it per the ask that it'd be included from feedback outside of the wg.
  • Giacomo is helping to update g301, and already showed me a revised update to the working example which should help clarify this. Additionally - it was explained that the expectation for the horizontal scrollbar of the scrollable area to be within the viewport was a topic that had been discussed previously. That expectation goes beyond what reflow requires - though it can be a good recommendation for better usability. Also of note, one of the reasons this attempt at testing wasn't working out so well, we determined, was there were some issues with the testing due to use of emulation.
  • g302 similarly should be working fine, but some emulation testing issues seem to be what prompted this query.
  • for point/question 3 - this section being referenced is companion content to wcag2ict's section on reflow - see wcag2ict relfow note 7. The end of the quoted content, stating to test of devices where reflow can be properly evaluated is because if one tests on a device where a 320px wide viewport, for example, cannot be achieved - then that is not a good way to test when you could be reviewing the website within a desktop browser where a user can manipulate the viewport to be 320px. Per the question about emulation, I noted the common issues that people have creating proper emulation tests, and that more accurate results will come from testing with one's browser and adjusting its viewport via zooming, resizing or both.

@giacomo-petri
Copy link
Contributor

Wow, perfect timing! I just committed the update with the second example for comparison. Feel free to tweak the explanation if it's not clear enough!

Thanks @scottaohara for all of this! Truly amazing work!

@giacomo-petri
Copy link
Contributor

@scottaohara
Copy link
Member Author

thank you @giacomo-petri. i played around with some of the wording and expanded the last paragraph that introduces the examples a bit. really appreciate you getting this done so quickly.

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.

1.4.10 Reflow needs a preamble