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 / s10 < prev    next >
Text File  |  1994-01-25  |  4KB  |  102 lines
  1. @Section
  2.    @Tag { refs }
  3.    @Title { References }
  4. @Begin
  5. @PP
  6. The method of handling references described in this section is rather
  7. elaborate, but it has many advantages.  The first step is to create a
  8. separate @I {database file} containing @Code "@Reference" symbols.  Each
  9. is enclosed in braces, and has options chosen from
  10. {@Code "@Tag"}, {@Code "@Type"}, {@Code "@Author"}, {@Code "@Title"},
  11. {@Code "@Institution"}, {@Code "@Number"}, {@Code "@Publisher"},
  12. {@Code "@Year"}, {@Code "@Proceedings"}, {@Code "@Journal"},
  13. {@Code "@Volume"}, {@Code "@Pages"}, and {@Code "@Comment"}:
  14. @IndentedList
  15. @ListItem @Code {
  16. "{ @Reference"
  17. "     @Tag { strunk79 }"
  18. "     @Type { Book }"
  19. "     @Author { Strunk and White }"
  20. "     @Title { The Elements of Style }"
  21. "     @Publisher { MacMillan }"
  22. "     @Year { 1979 }"
  23. "}"
  24. }
  25. @ListItem @Code {
  26. "{ @Reference"
  27. "     @Tag { kingston92 }"
  28. "     @Type { TechReport }"
  29. "     @Author { Kingston, Jeffrey H. }"
  30. "     @Title { Document Formatting"
  31. "with Lout }"
  32. "     @Number { 449 }"
  33. "     @Institution { Basser Department"
  34. "of Computer Science F09, University"
  35. "of Sydney 2006, Australia }"
  36. "     @Year { 1992 }"
  37. "}"
  38. }
  39. @EndList
  40. The {@Code "@Tag"} and {@Code "@Type"} options are in fact compulsory; the
  41. first serves to name the reference, the second gives its type, which may
  42. be {@Code "TechReport"}, {@Code "ConferencePaper"}, {@Code "JournalArticle"},
  43. {@Code "PhD"}, or {@Code "Book"}, although a Lout expert will be able to add
  44. other types.  The type determines which other options must be present, as
  45. shown above, and how they will be printed.
  46. @PP
  47. Suppose this file is given the name @Code "myrefs.ld" (Basser Lout
  48. database file names must end in {@Code ".ld"}).  To tell Lout to refer
  49. to this file as needed,
  50. @ID @Code {
  51. "@Database @Reference { myrefs }"
  52. }
  53. is placed at the beginning of the document, before {@Code "@Doc"},
  54. {@Code "@Report"}, or {@Code "@Book"}.
  55. @PP
  56. Now, with everything prepared,
  57. @ID @Code {
  58. "{@Ref kingston92}"
  59. }
  60. for example at any point in the document will cause the reference whose
  61. tag is @Code "kingston92" to be added to the nearest following
  62. reference list, indicated by the symbol {@Code "@ReferenceSection"}, unless
  63. it is already there.  Typically one would write
  64. @ID @Code {
  65. "... which ends our study."
  66. "@DP"
  67. "@ReferenceSection"
  68. }
  69. at the very end of the document (although one could equally well have several
  70. @Code "@ReferenceSection" symbols scattered through the document if desired);
  71. technical reports and books add @Code "@ReferenceSection" automatically
  72. when needed.  The references will appear in alphabetical order by tag, and
  73. the @Code "@Ref" symbol will be replaced by the number of the reference,
  74. in this case {@Ref "kingston92"}.  @Code "@ReferenceSection" has a
  75. @Code "@Title" option like {@Code "@Section"}, and it also has {@Code style},
  76. {@Code indent}, {@Code gap} and {@Code start} options for contolling the
  77. appearance of the reference list, like {@Code "@RawIndentList"}.
  78. @PP
  79. If a separate database file is not convenient for some reason, perhaps
  80. because it is desirable for the entire document to reside in one file,
  81. the @Code "@Reference" symbols may be incorporated into the document
  82. itself, anywhere after {@Code "@Text @Begin"}.  Nothing will appear
  83. where they are typed in, but Lout will
  84. notice them and treat them exactly as if they had come from a database
  85. file.  In this case no @Code "@Database" symbol is needed.
  86. @PP
  87. A way to print references at any point in the document is provided by
  88. {@Code "@RefPrint"}:
  89. @ID @Code "{@RefPrint kingston92}"
  90. might have result
  91. @ID {@RefPrint kingston92}
  92. depending on what references exist.
  93. @PP
  94. To get section numbers, footnote numbers, cross references, and references
  95. right, Basser Lout has to process the document more than once (three times
  96. for numbered references), and create special files whose names end
  97. in `.li' and `.ld'.  It will print warning messages on runs when this
  98. process is incomplete, and substitute question marks for the unknown
  99. values.  There should be only one document containing these features per
  100. Unix directory, otherwise Basser Lout will confuse their special files.
  101. @End @Section
  102.