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/09/11 09:14]
rachel.osolen
public:nnels:etext:lists [2020/04/21 11:14]
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 57: Line 59:
 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.  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. +Definition lists generally consist of term/definition pairs - a term followed by its definition. These include glossary lists, definition lists, pronunciation lists, etc.
  
-For example, a glossary of terms would be a definition list:+<WRAP center round box 80%> 
 +**Example** 
 + 
 +glossary of terms would be a definition list:
  
    mango: tropical fruit with sweet golden flesh    mango: tropical fruit with sweet golden flesh
Line 65: Line 70:
    carambola: star shaped tropical fruit with tart lemon-pineapple flavour    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    rambutan: egg-shaped tropical fruit similar to lychees with leathery skin covered in soft red hairs
 +</WRAP>
 +
  
 There are two definition list styles in the [[public:nnels:etext:template-styles|NNELS Template]]: There are two definition list styles in the [[public:nnels:etext:template-styles|NNELS Template]]:
Line 73: Line 80:
 Both styles are used together to create a definition list. When creating a definition list, we follow these steps: 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 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. +  - Select each definition term (i.e. mango, lychee, etc.) and apply the ''Definition Term (DAISY)'' style. 
  
 That's it. That's it.
Line 93: Line 100:
    </dl>     </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, questions and answers, categories and topics, or any other groups of term-description pairs. +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.
- +
-For example, a list of cast members should be marked up as a definition list: +
- +
-   Cast +
-    +
-   Rita: Jennifer Copping +
-   Borghejm and Old Woman: Gloria May Eshkibok +
-   Alfred: Gerry Mackay +
-   Asta: Caitlin 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> +
- +
-As mentioned above, definition lists should also be used for Q & A or interviews within a text. For example, in the following text, the first line (Q) should be be Definition Term style, and the second line (A) should be Definition Data style:  +
- +
-Q: Did you fight any other battles during the course of the war?\\ A: No. I hiked east two days, hitched a ride near Cross Lake and ended up back in my hometown in southern Alabama. +
- +
-<note>This is only for Question and Answer sections in a text. If it is a quoted conversation between two people then you apply only the ''Blockquote'' style. If it is a dialogue within a play you only need to add ''Strong'' style to the Characters' name and keep the dialogue as ''Normal''</note> +
 =====Q&A===== =====Q&A=====
  
public/nnels/etext/lists.txt · Last modified: 2022/09/15 12:07 by rachel.osolen