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
Next revision Both sides next revision
public:nnels:etext:lists [2019/10/02 11:22]
rachel.osolen [Definition Lists]
public:nnels:etext:lists [2020/08/01 09:13]
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, 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 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==== 
- 
-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.  
- 
-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 
-   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) 
-  * Definition Term (DAISY) 
- 
-Both styles are used together to create a definition list. When creating a definition list, we follow these steps: 
- 
-  - Select all the text that comprise the list (terms and values) and apply the **Definition Data (DAISY)** style.  
-  - Select each definition term (i.e. mango, lychee, etc.) and apply the **Definition Term (DAISY)** style.  
- 
-That's it. 
- 
-<note>Do not apply any other list style to Definition Lists.</note> 
- 
-This will give us the below output in XML: 
  
-   <dl>  +=====Q&Archive=====
-     <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?** **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/lists.txt · Last modified: 2022/09/15 12:07 by rachel.osolen