home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / APPS / lout2.lzh / LOUT2 / DOC / TR.BEGIN / s03 < prev    next >
Text File  |  1994-01-25  |  5KB  |  171 lines
  1. @Section
  2.    @Tag { lists }
  3.    @Title { Lists }
  4. @Begin
  5. @PP
  6. We have just seen that consecutive displays are awkward to space
  7. correctly.  Provided they are not aligned or numbered,
  8. these are better treated as a {@I list}:
  9. @ID @Code {
  10. "... preceding text."
  11. "@IndentedList"
  12. "@ListItem @I Emma"
  13. "@ListItem @I { Mansfield Park }"
  14. "@EndList"
  15. "following text ..."
  16. }
  17. There are {@Code "@LeftList"}, {@Code "@IndentedList"}, and
  18. @Code "@CentredList" (or {@Code "@CenteredList"}) symbols; each item is
  19. introduced by {@Code "@ListItem"}, and the list ends with
  20. {@Code "@EndList"}.  There may be any number of items; @Code "@DP"
  21. symbols are inserted before, between, and after them.
  22. @PP
  23. A variety of automatically generated tags is available for indented
  24. lists.  Here is the full set, showing the first tag produced:
  25. @ID {
  26.      @Code "@NumberedList"    |1c    1.
  27. /1vx @Code "@ParenNumberedList" |    (1)
  28. /1vx @Code "@RomanList"        |    i.
  29. /1vx @Code "@ParenRomanList"    |    (i)
  30. /1vx @Code "@UCRomanList"    |    I.
  31. /1vx @Code "@ParenUCRomanList"    |    (I)
  32. /1vx @Code "@AlphaList"        |    a.
  33. /1vx @Code "@ParenAlphaList"    |    (a)
  34. /1vx @Code "@UCAlphaList"    |    A.
  35. /1vx @Code "@ParenUCAlphaList"    |    (A)
  36. /1vx @Code "@BulletList"    |    @Bullet
  37. /1vx @Code "@StarList"        |    @Star
  38. /1vx @Code "@DashList"        |    --
  39. }
  40. The Roman numerals end at c (100), and the alphabet ends
  41. at z (26), but ordinary numbers have no limit.  For example,
  42. @ID @Code {
  43. "@Heading { Quiz }"
  44. "@NumberedList"
  45. "@ListItem { Which American"
  46. "statesman owned a"
  47. "two-storey clock? }"
  48. "@ListItem { Which Yankee"
  49. "commander cut a swathe of"
  50. "destruction through the"
  51. "State of Georgia? }"
  52. "@EndList"
  53. }
  54. has result
  55. @ID {
  56. @Heading { Quiz }
  57. @DP
  58. @RawNumberedList
  59. @ListItem { Which American
  60. statesman owned a
  61. two-storey clock? }
  62. @ListItem { Which Yankee
  63. commander cut a swathe of
  64. destruction through the
  65. State of Georgia? }
  66. @EndList
  67. }
  68. Alternatively, the tags may be supplied by the author, using the
  69. @Code "@TaggedList" symbol and its variants @Code "@WideTaggedList" and
  70. {@Code "@VeryWideTaggedList"}, which leave a wider indent for the tags:
  71. @ID @Code {
  72. "@WideTaggedList"
  73. "{ 9 a.m. } @TagItem { Breakfast in"
  74. "the Ipamena Lounge, served with"
  75. "Irish coffee and fresh croissants. }"
  76. "{ 10 a.m. } @TagItem { Prof. A. Smith"
  77. "speaks on `The Wealth of Nations.' }"
  78. "@EndList"
  79. }
  80. has result
  81. @ID {
  82. @RawWideTaggedList
  83. { 9 a.m. } @TagItem { Breakfast in
  84. the Ipamena Lounge, served with
  85. Irish coffee and fresh croissants. }
  86. { 10 a.m. } @TagItem { Prof. A. Smith
  87. speaks on `The Wealth of Nations.' }
  88. @EndList
  89. }
  90. Each @Code "@TagItem" symbol uses the thing just preceding it as the tag.
  91. @PP
  92. Each of these lists also has a `raw' version which omits the preceding
  93. and following space.  These are mainly used when an item is itself a list:
  94. @ID @Code {
  95. "@ParenNumberedList"
  96. "@ListItem {"
  97. "   @RawParenRomanList"
  98. "   @ListItem { MV Nominees,"
  99. "hereinafter called the vendor, ... }"
  100. "   @EndList"
  101. "}"
  102. "@EndList"
  103. }
  104. has result
  105. @ID {
  106. @RawParenNumberedList
  107. @ListItem {
  108.    @RawParenRomanList
  109.    @ListItem { MV Nominees,
  110. hereinafter called the vendor, ... }
  111.    @EndList
  112. }
  113. @EndList
  114. }
  115. If @Code "@ParenRomanList" had been used instead of
  116. {@Code "@RawParenRomanList"}, (1) and (i) would have appeared on
  117. different lines.
  118. @PP
  119. In cases where it is desired to have a paragraph symbol following a raw
  120. list, owing to problems behind the scenes this symbol should be placed
  121. before the first {@Code "@ListItem"} or {@Code "@TagItem"}, not after
  122. the @Code "@EndList" as would naturally be expected.
  123. @PP
  124. A finer control over the appearance of lists is obtained with
  125. @Code "@RawIndentedList" and {@Code "@RawTaggedList"}.  These
  126. have {@I options}:  optional subsidiary symbols which modify the
  127. result.  For example,
  128. @ID @Code {
  129. "@RawIndentedList"
  130. "     style { [tag] }"
  131. "     indent { 0.5i }"
  132. "     gap { 0.3v }"
  133. "     start { 5 }"
  134. "@ListItem { ... }"
  135. "@ListItem { ... }"
  136. "@EndList"
  137. }
  138. shows the four options available with {@Code "@RawIndentedList"}, namely
  139. {@Code style}, @Code {indent}, {@Code gap}, and {@Code start}.  It
  140. has result
  141. @ID {
  142. @RawIndentedList
  143.      style { [tag] }
  144.      indent { 0.5i }
  145.      gap { 0.3v }
  146.      start { 5 }
  147. @ListItem { ... }
  148. @ListItem { ... }
  149. @EndList
  150. }
  151. The @Code style option determines the appearance of each tag, any
  152. @Code tag symbol
  153. within it being replaced by the number of the item.  If numbers are not
  154. wanted in the tag, @Code tag may be omitted.  The other options
  155. determine the indent, the gap between items, and the number of the first
  156. item.  In general, options may be given in any order, and if omitted
  157. will revert to a reasonable standard value.  @Code "@RawTaggedList" works
  158. in a similar way, except that @Code tag is replaced by the tag supplied
  159. by the @Code "@TagItem" symbol, and there is no @Code start option.  The
  160. symbol @Code "@DP" may be used above or below the list to produce the
  161. usual amount of space.
  162. @PP
  163. Individual list items are kept together on one page or column.  However,
  164. a new page may be started between two list items.
  165. @PP
  166. Every symbol introduced in this section has an abbreviated form consisting
  167. of @Code "@" followed by its capital letters only.  For example,
  168. @Code "@RawNumberedList" abbreviates to {@Code "@RNL"}, and
  169. @Code "@ListItem" to {@Code "@LI"}.
  170. @End @Section
  171.