|
| 1 | +<!DOCTYPE html> |
| 2 | +<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml"> |
| 3 | + <head> |
| 4 | + <title>Accounting for meaningful text indentation and Reflow</title> |
| 5 | + <link rel="stylesheet" href="../../css/sources.css" class="remove"/> |
| 6 | + </head> |
| 7 | + <body> |
| 8 | + <h1>Accounting for meaningful text indentation and Reflow</h1> |
| 9 | + <section class="meta"><p class="id">ID: G224</p><p class="technology">Technology: general</p><p class="type">Type: Technique</p></section> |
| 10 | + <section id="applicability"> |
| 11 | + <h2>When to Use</h2> |
| 12 | + <p>All technologies that support style switching</p> |
| 13 | + </section> |
| 14 | + |
| 15 | + <section id="description"> |
| 16 | + <h2>Description</h2> |
| 17 | + <p>There can be instances where indentation of text is considered important to the presentation and understandability of the text content. If the indentations were to be removed, then meaning or functionality could suffer. For instance, the nesting of unordered lists can be harder to notice if indentations are removed. Additionally, maintaining indentations can be important to help understand code patterns, if not even necessary for the code to function.</p> |
| 18 | + <p>Since maintaining indentation is important for these instances of text, two-dimensional scrolling of these distinct sections of content could be necessary. However, there are still styling modifications that could be made to help ensure the indentation was maintained, but as much text was made visible within the viewport as possible. Making such adjustments could limit, if not mitigate any two-dimensional scrolling from occurring, making the content easier for people to read.</p> |
| 19 | + </div> |
| 20 | + </section> |
| 21 | + |
| 22 | + <section id="examples"> |
| 23 | + <h2>Examples</h2> |
| 24 | + <section class="example"> |
| 25 | + <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 suffer if flattened so that all content would fit within a 320 CSS pixel wide viewport.</p> |
| 26 | + <p>The following example list contains additional nested lists to provide more context for each of the parent list item's text. To maintain the visual hierarchy, the indentation of each list level remains present, but modified once an author defined CSS breakpoint is met. Additional styles are set for different breakpoints to mitigate against the potential for content to extend beyond a 320px wide viewport, while accounting for visual spacing against the borders of the viewport, to attempt to make the content not feel cramped. At the smallest breakpoint, the content of list items receive a minimum width to mitigate against potentially "squished" content lists with many nested levels. At this breakpoint, each nested list level can be horizontally scrolled into view, and once a nested list is visible within the viewport, only vertical scrolling will be necessary to read the content of the nested list's items.</p> |
| 27 | +<pre> |
| 28 | +<div class="example"> |
| 29 | + <ul> |
| 30 | + <li> |
| 31 | + <p>Make a list using one of the HTML list elements, or even an ARIA <code>role=list</code> container.</p> |
| 32 | + <ul> |
| 33 | + <li> |
| 34 | + <p>There are three types of lists in HTML which can contain list items (<code>li</code> elements.</p> |
| 35 | + <ul> |
| 36 | + <li><p>the <code>ul</code> element</li> |
| 37 | + <li><p>the <code>ol</code> element</li> |
| 38 | + <li><p>the <code>menu</code> element</li> |
| 39 | + </ul> |
| 40 | + </li> |
| 41 | + <li> |
| 42 | + <p>Another type of list, description lists, exist as well - but they do not contain list items (<code>li</code> elements).</p> |
| 43 | + </li> |
| 44 | + ... |
| 45 | + </ul> |
| 46 | + </li> |
| 47 | + <li> |
| 48 | + <p>Neither the start or end tags of any of the HTML list elements are omissible.</p> |
| 49 | + <ul> |
| 50 | + <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> |
| 51 | + </li> |
| 52 | + ... |
| 53 | + </ul> |
| 54 | + </li> |
| 55 | + ... |
| 56 | + </ul> |
| 57 | +</div> |
| 58 | +</pre> |
| 59 | +<pre> |
| 60 | +*, *::before, *::after { |
| 61 | + box-sizing: border-box; |
| 62 | +} |
| 63 | +body, html { |
| 64 | + font-family: arial; |
| 65 | +} |
| 66 | +@media screen and ( max-width: 640px ) { |
| 67 | + .example { |
| 68 | + overflow: auto; |
| 69 | + max-width: 640px; |
| 70 | + } |
| 71 | + ul { |
| 72 | + padding-inline-start: 1.25em; |
| 73 | + } |
| 74 | + li p { |
| 75 | + padding: .25em; |
| 76 | + margin: .5em 0 .5em -.25em; |
| 77 | + max-width: 300px; /* saftey net for max-width */ |
| 78 | + } |
| 79 | +} |
| 80 | +@media screen and ( max-width: 400px ) { |
| 81 | + ul { padding-inline-start: 1em; } |
| 82 | + li p { min-width: 300px } { |
| 83 | + min-width: 300px; |
| 84 | + } |
| 85 | +} |
| 86 | +</pre> |
| 87 | + <p>A working example of <a href="../../working-examples/reflow-nested-lists">a list where nested levels can be read within a 320px wide viewport</a>.</p> |
| 88 | + </section> |
| 89 | + |
| 90 | + <section class="example"> |
| 91 | + <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 languages - such as with Python, are requirements when defining blocks of code.</p> |
| 92 | + <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 visible on a single line.</p> |
| 93 | + |
| 94 | + <p>The following represents a Python code example. The indentation of each line of text is necessary to create a group of statements that are executed as a block.</p> |
| 95 | +<pre> |
| 96 | +def complex_function(x): |
| 97 | + if x > 0: |
| 98 | + for i in range(x): |
| 99 | + if i % 2 == 0: |
| 100 | + print(f"{i} is even") |
| 101 | + for a in range(i): |
| 102 | + if a % 5 == 0: |
| 103 | + print(f" {a} can be divided by 5") |
| 104 | + else: |
| 105 | + print(f" {a} cannot be divided by 5") |
| 106 | + else: |
| 107 | + print(f"{i} is odd") |
| 108 | + for a in range(i): |
| 109 | + if a % 2 == 0: |
| 110 | + print(f" {a} is even") |
| 111 | + else: |
| 112 | + print(f" {a} is odd") |
| 113 | + else: |
| 114 | + print("x is not a positive number") |
| 115 | +</pre> |
| 116 | + <p>The following code example demonstrates the use of indentation to convey the nesting of elements in an HTML document:</p> |
| 117 | +<pre> |
| 118 | +<html lang=en> |
| 119 | + <head>...</head> |
| 120 | + <body> |
| 121 | + <div> |
| 122 | + <!-- ... keep indenting as necessary --> |
| 123 | + </div> |
| 124 | + </body> |
| 125 | +</html> |
| 126 | +</pre> |
| 127 | + <p>The indentation of code blocks like these could be adjusted at different viewport sizies, via a CSS Media Query.</p> |
| 128 | +<pre> |
| 129 | +@media screen and ( min-width: 320px ) { |
| 130 | + pre { |
| 131 | + tab-size: 8px; |
| 132 | + } |
| 133 | +} |
| 134 | + |
| 135 | +@media screen and ( min-width: 640px ) { |
| 136 | + pre { |
| 137 | + tab-size: 16px; |
| 138 | + } |
| 139 | +} |
| 140 | + |
| 141 | +@media screen and ( min-width: 1280px ) { |
| 142 | + pre { |
| 143 | + tab-size: 32px; |
| 144 | + } |
| 145 | +} |
| 146 | +</pre> |
| 147 | + <p>A working example of <a href="../../working-examples/reflow-indenting.html">code snippets using CSS to modigy indentation width at different breakpoints</a>. |
| 148 | + </section> |
| 149 | + </section> |
| 150 | + |
| 151 | + <section id="tests"> |
| 152 | + <h2>Tests</h2> |
| 153 | + <section class="procedure"><h3>Procedure for list example</h3> |
| 154 | + <ol> |
| 155 | + <li>Display the web page in a user agent where the page can be zoomed, or the user agent can be resized.</li> |
| 156 | + <li>Zoom in or resize the browser window so that the viewport is equivallent to 320 CSS pixels wide.</li> |
| 157 | + <li>The list content fits within the width so that it is only necessary so scroll vertically to read the list.</li> |
| 158 | + <li>Or, each nested list can be horizontally scrolled into view. Only vertical scrolling is necessary to read the content of list items within each specific nested list level.</li> |
| 159 | + </ol> |
| 160 | + </section> |
| 161 | + <section class="results"><h3>Expected Results</h3> |
| 162 | + <ul> |
| 163 | + <li>Checks 3 or 4 are true.</li> |
| 164 | + </ul> |
| 165 | + </section> |
| 166 | + |
| 167 | + <section class="procedure"><h3>Procedure for code snippets</h3> |
| 168 | + <ol> |
| 169 | + <li>Display the web page in a user agent where the page can be zoomed, or the user agent can be resized.</li> |
| 170 | + <li>Zoom in or resize the browser window so that the viewport is equivallent to 320 CSS pixels wide.</li> |
| 171 | + <li>The code snippets fits within the width so that it is only necessary so scroll vertically to read each line of code.</li> |
| 172 | + <li>Or, for code where non-wrapping lines are not essential, the code wraps or a mechanism is provided to allow line wrapping.</li> |
| 173 | + <li>Or, the indentation and linebreaks are meaningful to the code language. |
| 174 | + </ol> |
| 175 | + </section> |
| 176 | + <section class="results"><h3>Expected Results</h3> |
| 177 | + <ul> |
| 178 | + <li>Checks #3, #4 or #5 are true.</li> |
| 179 | + </ul> |
| 180 | + </section> |
| 181 | + </section> |
| 182 | + <section id="related"> |
| 183 | + <h2>Related Techniques</h2> |
| 184 | + <ul> |
| 185 | + <li><a href="../css/C20">C20</a></li> |
| 186 | + </ul> |
| 187 | + </section> |
| 188 | + </body> |
| 189 | +</html> |
0 commit comments