User Tools

You are here: start » public » nnels » etext » lists
Trace:

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 [2019/10/02 11:22]
rachel.osolen [Definition Lists] 		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 lists, i.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.
Line 8: Line 10:
  
 <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: <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:table-of-contents|Table of Contents]];+  * [[public:nnels:etext:also-by-the-author|Also by the author]]
   * [[public:nnels:etext:index|Index]]; and   * [[public:nnels:etext:index|Index]]; and
   * [[public:nnels:etext:bibliography|Bibliography]]   * [[public:nnels:etext:bibliography|Bibliography]]
Line 33: Line 35:
 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)}}
Line 53: Line 55:
 For more information on how to continue ordered lists with breaks please see this [[https://screencast-o-matic.com/watch/cqQXodtpvR| tutorial]]. For more information on how to continue ordered lists with breaks please see this [[https://screencast-o-matic.com/watch/cqQXodtpvR| tutorial]].
  
-====Definition Lists====+<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>
  
-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. +<note tip>If you have any questions, check the archive below, if still not clear, post your question on the [[public:nnels:etext:q_a|Production Q&A]] 
 +</note>
  
-Definition lists generally consist of term/definition pairs - a term followed by its definition. +----
  
-For example, a glossary of terms would be a definition list: 
  
-   mango: tropical fruit with sweet golden flesh +=====Q&A Archive=====
-   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]]:+**Q: Should this list be formatted using H2 and H3 for the countries and institutions, and Lists for the collections? Or should I used nested lists for all elements?**
  
-  * Definition Data (DAISY) +{{ :public:nnels:etext:primarysourceslist.png?300 |}}
-  * Definition Term (DAISY)+
  
-Both styles are used together to create a definition list. When creating a definition list, we follow these steps:+A: Yes, using H2 for Canada, with the underlying content a nested list, seems like a logical structure.
  
-  - Select all the text that comprise the list (terms and values) and apply the **Definition Data (DAISY)** style.  +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 substitute. I'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.  
-  - Select each definition term (i.e. mango, lychee, etc.) and apply the **Definition Term (DAISY)** style. +
  
-That's it.+{{ :​public:​nnels:​etext:​screen_shot_2021-11-04_at_10.21.11_am.png?​600 |}}  
  
-<note>Do not apply any other list style to Definition Lists.</note>+{{ :​public:​nnels:​etext:​screen_shot_2021-11-04_at_10.24.22_am.png?​600 |}}
  
-This will give us the below output in XML: +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.
- +
-   <dl>  +
-     <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 terms. We use them for all term-description groups. Term-description groups may be names and definitions, categories and topics, or any other groups of term-description pairs. +
-=====Q&A===== +
- +
-**Q: Should this list be formatted using H2 and H3 for the countries and institutions, and Lists for the collections? Or should I used nested lists for all elements?**+
  
-{{ :public:nnels:etext:primarysourceslist.png?300 |}} 
- 
-A: Yes, using H2 for Canada, with the underlying content a nested list, seems like a logical structure. 
 ---- ----
  
Line 106: Line 84:
  
 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.1570040539.txt.gz · Last modified: 2019/10/02 11:22 by rachel.osolen

Page Tools

BC Libraries Coop wiki

Site Tools