User Tools


Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
public:nnels:etext:lists [2017/11/02 10:00]
farrah.little [Use the correct list type]
public:nnels:etext:lists [2022/09/15 12:07] (current)
rachel.osolen
Line 1: Line 1:
-===== Lists =====+====== Lists ======
  
-Lists are often overlooked as an accessibility feature, but the ability to move quickly and effectively through long lists of points is a key reading need. Unfortunately, it's still the case that lists are rendered as anything but proper listsi.e. you'll often see a new paragraph for each item, or manual line breaks to separate entries, etc.+Lists are often overlooked as an accessibility feature, but the ability to move quickly and effectively through long lists of points is a key reading need. 
 + 
 +Unfortunately, you will see in many ebooks it's still the case that lists are rendered as anything but proper lists (i.e. you'll often see a new paragraph for each item, or manual line breaks to separate entries, lists in tables etc.)
  
 When a reader has to traverse every item in the list one item at a time to get to the end, or listen to the entire list from beginning to end, the problems of bad markup become more pronounced. Properly tagging lists is a small measure that can greatly decrease reader frustration. When a reader has to traverse every item in the list one item at a time to get to the end, or listen to the entire list from beginning to end, the problems of bad markup become more pronounced. Properly tagging lists is a small measure that can greatly decrease reader frustration.
  
 <note>Everything that is actually a list should be formatted as a list, even if it’s not presented as a list in the source file.</note> <note>Everything that is actually a list should be formatted as a list, even if it’s not presented as a list in the source file.</note>
 +
 +<note>In addition to lists found in the main body of the work, there are a few items which are normally formatted as a list, including:
 +  * [[public:nnels:etext:also-by-the-author|Also by the author]]
 +  * [[public:nnels:etext:index|Index]]; and
 +  * [[public:nnels:etext:bibliography|Bibliography]]
 +</note>
  
 Do not make lists with just manually typed characters like dashes, numbers, asterisks, or graphics as a screenreader may not be able to read the list in the proper order. When bullet or numbered list formatting is used, screenreaders will properly announce the text as being part of a list, and provide a means for the user to quickly navigate between items as well as move in and out of lists. Do not make lists with just manually typed characters like dashes, numbers, asterisks, or graphics as a screenreader may not be able to read the list in the proper order. When bullet or numbered list formatting is used, screenreaders will properly announce the text as being part of a list, and provide a means for the user to quickly navigate between items as well as move in and out of lists.
  
 <note>Avoid using lists for either just indent or layout purposes. List elements must not be used for purely presentational purposes.</note> <note>Avoid using lists for either just indent or layout purposes. List elements must not be used for purely presentational purposes.</note>
-====Create a list in Word====+=====Create a list in Word=====
  
 Use the appropriate button in Word’s formatting toolbar, i.e. bullet or numbered list.  Use the appropriate button in Word’s formatting toolbar, i.e. bullet or numbered list. 
Line 20: Line 28:
 {{:public:nnels:lists.png?400|}} {{:public:nnels:lists.png?400|}}
  
-====Use the correct list type====+=====Use the correct list type=====
  
 Using the correct list type is also important as it may be the only cue to the reader whether the order of items is significant. An alphabetical list is not necessarily an ordered list; for example, arranging items is not the same as assigning them a specific order. If you can re-arrange the items without changing the meaning of the list, you've defined an unordered list (i.e. indexes and bibliographies do not lose meaning when re-ordered). Using the correct list type is also important as it may be the only cue to the reader whether the order of items is significant. An alphabetical list is not necessarily an ordered list; for example, arranging items is not the same as assigning them a specific order. If you can re-arrange the items without changing the meaning of the list, you've defined an unordered list (i.e. indexes and bibliographies do not lose meaning when re-ordered).
  
-===Unordered===+====Unordered====
 For unordered lists, use the bulleted list tool. The icon looks like this: {{:public:nnels:bullet_list.png?nolink&50|}} For unordered lists, use the bulleted list tool. The icon looks like this: {{:public:nnels:bullet_list.png?nolink&50|}}
  
-Optional: for display purposes, you can create an invisible bullet using "define new bullet" and selecting the blank bullet character.+Optional: for display purposes, you can create an invisible bullet using "define new bullet" and selecting the blank bullet character. This is a less desirable format, as it can cause issues with lower vision or readers with cognitive disabilities.
  
 {{:public:nnels:unordered_list_biblio.png?linkonly|Example unordered list (Bibliography)}} {{:public:nnels:unordered_list_biblio.png?linkonly|Example unordered list (Bibliography)}}
 {{:public:nnels:toc_invisiblebullet.png?linkonly|Example unordered list with invisible bullet (Table of Contents)}} {{:public:nnels:toc_invisiblebullet.png?linkonly|Example unordered list with invisible bullet (Table of Contents)}}
  
-===Ordered===+====Ordered====
 For ordered lists, use the numbered list tool. The icon looks like this:{{:public:nnels:numbered_list.png?nolink&50|}} For ordered lists, use the numbered list tool. The icon looks like this:{{:public:nnels:numbered_list.png?nolink&50|}}
  
 {{:public:nnels:numbered_list1.png?linkonly|Example ordered list}} {{:public:nnels:numbered_list1.png?linkonly|Example ordered list}}
  
 +Sometimes you will have text that has ordered lists that are broken up by other bodies of text.  In these instances:
 +  * Highlight the section that is part of the list
 +  * Apply the ordered list as usual
 +  * Scroll down to the next instance of the ordered list
 +  * Highlight and repeat
  
-===Definition Lists===+<note>Sometimes the numbers will not continue, but this is an easy fix. Each time you apply a new ordered list in word a small lightning bolt box appears beside the newest number. {{:public:nnels:etext:autocorrect_button.png?25|}} This is an autocorrect menu that will only appear briefly after you apply the second item in the ordered list. Simply click this box to open a drop down menu that will give you the option to ''Continue Numbering''. Click this option and the number will automatically change to continue from the previous number despite the break between each.</note>
  
-In addition to the common types of lists mentioned above, there also exists what we call a "definition list"Definition lists require the use of special DAISY styles+For more information on how to continue ordered lists with breaks please see this [[https://screencast-o-matic.com/watch/cqQXodtpvR| tutorial]].
  
-Definition lists generally consist of term/definition pairs a term followed by its definition+<note>Here is a video tutorial on [[https://screencast-o-matic.com/watch/c3QQbkVOQFs|How to apply Ordered and Unordered lists in MS Word]].</note>
  
-For examplea glossary of terms would be a definition list:+<note tip>If you have any questionscheck the archive below, if still not clear, post your question on the [[public:nnels:etext:q_a|Production Q&A]] 
 +</note>
  
-   mango: tropical fruit with sweet golden flesh +----
-   lychee: tropical fruit with deep red leathery skin and clear white flesh +
-   carambola: star shaped tropical fruit with tart lemon-pineapple flavour +
-   rambutan: egg-shaped tropical fruit similar to lychees with leathery skin covered in soft red hairs+
  
-There are two definition list styles in the [[public:nnels:etext:template-styles|NNELS Template]]: 
  
-  * Definition Data (DAISY) +=====Q&A Archive=====
-  * Definition Term (DAISY)+
  
-Both styles are used together to create a definition list. When creating a definition list, we follow these steps:+**Q: Should this list be formatted using H2 and H3 for the countries and institutionsand Lists for the collections? Or should I used nested lists for all elements?**
  
-  - Select all the text that comprise the list (terms and values) and apply the **Definition Data (DAISY)** style.  +{{ :public:nnels:etext:primarysourceslist.png?300 |}}
-  - Select each definition term (i.e. mango, lychee, etc.) and apply the **Definition Term (DAISY)** style+
  
-That's it. This will give us the below output in XML:+AYes, using H2 for Canada, with the underlying content a nested list, seems like a logical structure.
  
-   <dl>  +Q: I'm working on the Cooking for Two cookbook. I know that we format something as a list, even when it isn't presented that way in the source file, and we previously discussed formatting the recipe variation sections as lists. My questions is to what degree do I format these sections as lists? Should I just make each sentence a list? Or when there is a list within a sentence should I use a nested list? This often occurs when they are listing what to substituteI've been debating back and forth, and I know consistency is important. I'm a bit in the weeds on this and really appreciate your help. The following are two instances of what I'm referring to regarding the sections that need to be lists.  
-     <dt>mango</dt>  +
-     <dd>tropical fruit with sweet golden flesh</dd>  +
-     <dt>lychee</dt>  +
-     <dd>tropical fruit with deep red leathery skin and clear white flesh</dd>  +
-     <dt>carambola</dt>  +
-     <dd>star shaped tropical fruit with tart lemon-pineapple flavour</dd>  +
-     <dt>rambutan</dt>  +
-     <dd>egg-shaped tropical fruit similar to lychees with leathery skin covered in soft red hairs</dd> +
-   </dl>  +
-   +
-Definition lists are not restricted to glossaries of termsWe use them for all term-description groups. Term-description groups may be names and definitionsquestions and answers, categories and topics, or any other groups of term-description pairs.+
  
-For example, a list of cast members should be marked up as a definition list:+{{ :​public:​nnels:​etext:​screen_shot_2021-11-04_at_10.21.11_am.png?​600 |}}  
  
-   Cast +{{ :​public:​nnels:​etext:​screen_shot_2021-11-04_at_10.24.22_am.png?​600 |}}
-    +
-   RitaJennifer Copping +
-   Borghejm and Old WomanGloria May Eshkibok +
-   AlfredGerry Mackay +
-   AstaCaitlin McFarlane +
-   Wolfie: Richard Russ +
-    +
-   Creative Team +
-    +
-   Director: Stephen Drover +
-   Production Designer: Drew Facey +
-   Lighting Designer: Conor Moore +
-   Sound Designer: James Coomber +
-   Associate Director: Corey Payette +
-   Stage Manager: Collette Brown +
-   Assistant Stage Manager: Noelle Sediego +
-   Production Manager: Becky Low +
-   Technical Director: Robin Richardson +
- +
-With the application of the definition list styles, this results in the below XML output: +
- +
- <h2>Cast</h2> +
- <dl> +
- <dt>Rita</dt> +
- <dd>: Jennifer Copping</dd> +
- <dt>Borghejm and Old Woman</dt> +
- <dd>: Gloria May Eshkibok</dd> +
- <dt>Alfred</dt> +
- <dd>: Gerry Mackay</dd> +
- <dt>Asta</dt> +
- <dd>: Caitlin McFarlane</dd> +
- <dt>Wolfie</dt> +
- <dd>: Richard Russ</dd> +
- </dl> +
- <p>Creative Team</p> +
- <dl> +
- <dt>Director</dt> +
- <dd>: Stephen Drover</dd> +
- <dt>Production Designer</dt> +
- <dd>: Drew Facey</dd> +
- <dt>Lighting Designer</dt> +
- <dd>: Conor Moore</dd> +
- <dt>Sound Designer</dt> +
- <dd>: James Coomber</dd> +
- <dt>Associate Director</dt> +
- <dd>: Corey Payette</dd> +
- <dt>Stage Manager</dt> +
- <dd>: Collette Brown</dd> +
- <dt>Assistant Stage Manager</dt> +
- <dd>: Noelle Sediego</dd> +
- <dt>Production Manager</dt> +
- <dd>: Becky Low</dd> +
- <dt>Technical Director</dt> +
- <dd>: Robin Richardson</dd> +
- </dl>+
  
 +A: The general rule is if it is a list, or can be a list (i.e. directions, items separated by commas, etc.) then it should be formatted as such. I am going to download the book and take a look more at the pages again. I will update this space once I have a clearer idea of the changes in the book.
  
 ---- ----
  
 WCAG 2.0 — H48: [[http://www.w3.org/TR/WCAG20-TECHS/H48.html|Using ol, ul and dl for lists or groups of links]] WCAG 2.0 — H48: [[http://www.w3.org/TR/WCAG20-TECHS/H48.html|Using ol, ul and dl for lists or groups of links]]
 +
 WCAG 2.0 - H40: [[https://www.w3.org/TR/WCAG20-TECHS/H40.html|Using description  lists]] WCAG 2.0 - H40: [[https://www.w3.org/TR/WCAG20-TECHS/H40.html|Using description  lists]]
 +
 +[[public:nnels:etext:start|Return to main eText Page]]
public/nnels/etext/lists.1509642059.txt.gz · Last modified: 2017/11/02 10:00 by farrah.little