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 / s13 < prev    next >
Text File  |  1994-01-25  |  3KB  |  85 lines
  1. @Section
  2.    @Tag { reportlayout }
  3.    @Title { Technical reports }
  4. @Begin
  5. @PP
  6. This section describes how to use the DocumentLayout package to produce
  7. technical reports like the present document.  Type @Code "-ireport" in
  8. the Unix command instead of @Code "-idoc" to use the package in this
  9. way.  We present only the differences here; everything else works as
  10. before.
  11. @PP
  12. A technical report begins with a @Code "@Report" symbol analogous to the
  13. @Code "@Document" symbol described in the previous section.  Here it is,
  14. with its nine options and their default values:
  15. @ID @Code {
  16. "@Report"
  17. "    @Title {}"
  18. "    @Author {}"
  19. "    @Institution {}"
  20. "    @DateLine { @Date }"
  21. "    @InitialFont { Times Base 12p }"
  22. "    @InitialBreak { adjust 1.2fx }"
  23. "    @Hyphenate { Yes }"
  24. "    @PageNumbers { Yes }"
  25. "    @Columns { Single }"
  26. "//"
  27. }
  28. The {@Code "@Title"}, {@Code "@Author"}, and {@Code "@Institution"} options
  29. will be printed on the cover sheet and on the first page; they are formatted
  30. using {@Code "clines @Break"} (see page {@PageOf clines}).  Multiple authors
  31. should be given on separate lines within the @Code "@Author"
  32. option.  {@Code "@DateLine"} appears below the abstract on the cover sheet,
  33. and its default value is the current date as shown.  {@Code "@InitialFont"},
  34. {@Code "@InitialBreak"}, {@Code "@Hyphenate"}, {@Code "@PageNumbers"} and
  35. {@Code "@Columns"} are as described in the last section, except that there
  36. is nothing analogous to @Code "@Text" and {@Code "@ColText"}:  if
  37. @Code "@Columns" is set to {@Code Double}, the entire document after the
  38. title will be set in two columns.  There is no @Code "@FirstPageNumber"
  39. option.  As for {@Code "@Document"}, the symbol @Code "//" must follow
  40. after, and disaster will ensue if it is omitted.
  41. @PP
  42. If the technical report has an abstract, it comes next:
  43. @ID @Code {
  44. "@Abstract @Begin"
  45. "..."
  46. "..."
  47. "@End @Abstract"
  48. }
  49. The cover sheet of the present report shows how this will
  50. appear.  @Code "@Abstract" has a @Code "@Title" option like the ones
  51. below; its default value is {@I ABSTRACT}.
  52. @PP
  53. Next come the sections of the report, each enclosed in a @Code
  54. "@Section" symbol:
  55. @ID @Code {
  56. "@Section"
  57. "    @Title { Introduction }"
  58. "@Begin"
  59. "@PP"
  60. "..."
  61. "..."
  62. "@End @Section"
  63. }
  64. No @Code "@BeginSections" or @Code "@EndSections" symbols are needed.
  65.  The sections may contain subsections, preceded as usual by
  66. @Code "@BeginSubSections" and followed by {@Code "@EndSubSections"}.
  67.  After the sections there is opportunity for a sequence of appendices,
  68. each of the form
  69. @ID @Code {
  70. "@Appendix"
  71. "    @Title { ... }"
  72. "@Begin"
  73. "@PP"
  74. "..."
  75. "..."
  76. "@End @Appendix"
  77. }
  78. but these are quite optional.  No @Code "@BeginAppendices" and
  79. @Code "@EndAppendices" symbols are needed.  An appendix may contain
  80. sub-appendices via the usual symbols {@Code "@BeginSubAppendices"},
  81. {@Code "@SubAppendix"}, and {@Code "@BeginSubAppendices"}.  This ends
  82. the input; there is no {@Code "@End @Text"}, and any reference section
  83. will be added automatically.
  84. @End @Section
  85.