-
Notifications
You must be signed in to change notification settings - Fork 256
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
scottaohara
wants to merge
42
commits into
main
Choose a base branch
from
scottaohara-reflow-understanding-rewrite
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 29 commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
1cb8c80
Updated Reflow understanding doc
scottaohara 8d0f1f9
Update reflow.html
scottaohara b1e767f
Update understanding/21/reflow.html
scottaohara 7504dd2
Update understanding/21/reflow.html
scottaohara 005e080
new graphics used in the examples
scottaohara 60c3d71
add img folder to all new img src
scottaohara 8c2236e
note for sticky/fixed content
scottaohara 54adc01
fix missing word in 'what to do'
scottaohara 627dbc5
add clarifying note to 320x256 section
scottaohara bf3d520
pull in missing content from the external doc
scottaohara 6d1d428
revise initial intent paragraphs
scottaohara 89cecfe
updates to reflow doc
scottaohara 5e1ee84
content updates
scottaohara cfb36fb
Merge branch 'main' into scottaohara-reflow-understanding-rewrite
scottaohara a6dd504
Merge branch 'main' into scottaohara-reflow-understanding-rewrite
scottaohara 2453865
updates per external feedback
scottaohara 633eaa2
finish addressing external feedback
scottaohara 473a63b
adjust example image widths
scottaohara 030256f
re-arrange and fix p markup
scottaohara 845c55a
rewording of reorganized content
scottaohara ca79e05
new example screenshot
scottaohara 6296a9e
simplify wording
scottaohara 9dcfcbd
addressing issue 887
scottaohara ac903e5
fix incomplete sentence and punctuation fixes
scottaohara a475898
Create g20x.html
scottaohara 67e1761
Update understanding/21/reflow.html
scottaohara bc1d2f5
off screen to off-screen
scottaohara 2fdad82
Update understanding/21/reflow.html
fstrr 3670020
Update techniques/general/g20x.html
scottaohara b89e94f
address some of the feedback
scottaohara 7597c58
updates to first intent paragraph
scottaohara 9fe9bae
add more content to new indentation technique
scottaohara 9db3dba
Update understanding/21/reflow.html
scottaohara 9034790
Update understanding/21/reflow.html
scottaohara 8ffffcf
remove in-page link / text that was broken
scottaohara acbbb3f
Update understanding/21/reflow.html
scottaohara 389a46e
more wording updates
scottaohara dd46e18
Update understanding/21/reflow.html
scottaohara d2f5623
Update understanding/21/reflow.html
scottaohara ef48bf4
Update reflow.html
scottaohara 295747f
Update understanding/21/reflow.html
scottaohara 9eea703
Update understanding/21/reflow.html
scottaohara File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,148 @@ | ||
<!DOCTYPE html> | ||
<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml"> | ||
<head> | ||
<title>Adjusting indentation </title> | ||
<link rel="stylesheet" href="../../css/sources.css" class="remove"/> | ||
</head> | ||
<body> | ||
<h1>New technique title goes here</h1> | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
<section class="meta"><p class="id">ID: G206</p><p class="technology">Technology: general</p><p class="type">Type: Technique</p></section> | ||
<section id="applicability"> | ||
<h2>When to Use</h2> | ||
<p>All technologies that support style switching</p> | ||
</section> | ||
|
||
<section id="description"> | ||
<h2>Description</h2> | ||
<p>There are instances where indentation of text or even nested lists provide meaningful information that would make content more difficult to understand if it were removed.</p> | ||
TODO: longer explainer | ||
</div> | ||
</section> | ||
|
||
<section id="examples"> | ||
<h2>Examples</h2> | ||
<section class="example"> | ||
<p>A website conveys information in a nested list format. The understandability of the list hierarchy is supported by the indentation of the list content. While it is important for the individual list item text to reflow, the list hierarchy would potentially suffer if flattened so that all content neatly fit within a 320 CSS pixel wide container.</p> | ||
<p>The following example list contains additional nested lists to provide more context for each of the primary list item's points. To maintain the visual hierarchy, the indentation of the lists is maintained, but reduced once a certain CSS breakpoint is met. The content of each list item is given a maximum width of 320 CSS pixels so that even though the list will require bi-dimensional scrolling to view all content, each list item in each nested list level will be able to be read without scrolling in two directions.</p> | ||
<pre> | ||
<div class=example> | ||
<ul> | ||
<li> | ||
<p>Make a list using one of the HTML list elements, or even an ARIA <code>role=list</code> container.</p> | ||
<ul> | ||
<li> | ||
<p>There are three types of lists in HTML which can contain list items (<code>li</code> elements.</p> | ||
<ul> | ||
<li><p>the <code>ul</code> element</li> | ||
<li><p>the <code>ol</code> element</li> | ||
<li><p>the <code>menu</code> element</li> | ||
</ul> | ||
</li> | ||
<li> | ||
<p>Another type of list, description lists, exist as well - but they do not contain list items (<code>li</code> elements).</p> | ||
</li> | ||
</ul> | ||
</li> | ||
<li> | ||
<p>Neither the start or end tags of any of the HTML list elements are omissible.</p> | ||
<ul> | ||
<li><p>The end tags of <code>li</code> elements can be omitted if the <code>li</code> element is immeditely followed by another <code>li</code> element or there is no more content in the parent list element.</p> | ||
</li> | ||
<li><p>The list marker for each <code>li</code> element is initially based on the parent list element used.</p> | ||
<ul> | ||
<li><p>The list maker can be modified by using CSS,</p></li> | ||
<li><p>or the list marker can be modifed by using the <code>type</code> attribute, if the parent list element is an <code>ol</code> element.</p></li> | ||
</ul> | ||
</li> | ||
</ul> | ||
</li> | ||
<li> | ||
<p>Validate your markup.</p> | ||
</li> | ||
</ul> | ||
</div> | ||
</pre> | ||
<pre> | ||
@media screen and (max-width: 640px) { | ||
.example { | ||
overflow: auto; | ||
max-width: 640px; | ||
} | ||
ul { | ||
padding-inline-start: 1em; | ||
} | ||
li p { | ||
max-width: 320px; | ||
margin: .5em 0; | ||
} | ||
} | ||
</pre> | ||
</section> | ||
|
||
<section class="example"> | ||
<p>A website providing code snippets needs to maintain line indentations, as the indentations are meaningful not only to the structure of the code, but in some cases such as with Python, are requirements when defining blocks of code.</p> | ||
<p>As a user zooms in the web page, the CSS of the indentation can be adjusted to maintain this necessary structure, while also allowing more text to be legibale on a single line.</p> | ||
|
||
<p>Whether providing a Python example where indentation is required for valid code,</p> | ||
<pre> | ||
myset = {"apple", "orange", "kiwi", "banana"} | ||
|
||
for x in myset: | ||
print(x) | ||
</pre> | ||
<p>Or needing to maintain and convey proper indentation of an HTML document:</p> | ||
<pre> | ||
<html lang=en> | ||
<head>...</head> | ||
<body> | ||
<div> | ||
<!-- ... keep indenting as necessary --> | ||
</div> | ||
</body> | ||
</html> | ||
</pre> | ||
<p>The indentation of code blocks like these could be adjusted at different viewport sizies, via a CSS Media Query.</p> | ||
<pre> | ||
@media screen and ( min-width: 320px ) { | ||
pre { | ||
tab-size: 8px; | ||
} | ||
} | ||
|
||
@media screen and ( min-width: 640px ) { | ||
pre { | ||
tab-size: 16px; | ||
} | ||
} | ||
|
||
@media screen and ( min-width: 1280px ) { | ||
pre { | ||
tab-size: 32px; | ||
} | ||
} | ||
</pre> | ||
</section> | ||
</section> | ||
|
||
<section id="tests"> | ||
<h2>Tests</h2> | ||
<section class="procedure"><h3>Procedure</h3> | ||
<ol> | ||
<li>Open the content that requires horizontal scrolling on a full screen window. </li> | ||
<li>TODO, finish test checks | ||
</ol> | ||
</section> | ||
<section class="results"><h3>Expected Results</h3> | ||
<ul> | ||
<li>Checks X are true.</li> | ||
</ul> | ||
</section> | ||
</section> | ||
<section id="related"> | ||
<h2>Related Techniques</h2> | ||
<ul> | ||
<li><a href="../css/C20">C20</a></li> | ||
</ul> | ||
</section> | ||
</body> | ||
</html> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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