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 / s01 < prev    next >
Text File  |  1994-01-25  |  4KB  |  91 lines
  1. @Section
  2.    @Tag { intro }
  3.    @Title { Introduction }
  4. @Begin
  5. @PP
  6. The Lout document formatting system has been designed with the
  7. needs of the ordinary user very much in mind.  Although the features of Lout
  8. are virtually endless, and include mathematical equations, diagrams made
  9. from lines and shapes, bibliographic databases, and so on, the system is
  10. very simple to use.
  11. @PP
  12. Document formatting with Lout begins with the creation of a file like
  13. the following:
  14. @ID @Code {
  15. "@Doc @Text @Begin"
  16. "@Heading { Introduction }"
  17. "@PP"
  18. "For Virginia Woolf, @I Middlemarch"
  19. "was `the magnificent book which"
  20. "for all its imperfections is one"
  21. "of the few English novels written"
  22. "for grown-up people.'"
  23. "@End @Text"
  24. }
  25. Ordinary words are mixed with symbols of special meaning, such as
  26. {@Code "@Doc"}, {@Code "@Text"}, {@Code "@Heading"}, and
  27. {@Code "@I"}.  Most symbols begin with {@Code "@"}, but some, like
  28. {@Code "{"} and {@Code "}"}, do not.  It doesn't matter where the lines
  29. end:  the end of a line is treated the same as a single space.
  30. @PP
  31. This file is then processed by the Basser Lout interpreter, for example
  32. by typing
  33. @ID @Code "lout -idoc simple > simple.ps"
  34. on the Unix
  35. @FootNote { Unix is a trademark of "AT&T" Bell Laboratories. &0io }
  36. operating system, assuming that the file's name is
  37. {@Code "simple"}.  The @Code "-idoc" part instructs Lout to include a
  38. special @I {setup file} called {@Code doc}, in which the symbols are
  39. defined.  The output is the PostScript
  40. @FootNote { PostScript is a trademark of Adobe Systems, Inc. &0io }
  41. file {@Code "simple.ps"}, which is suitable for printing on most laser
  42. printers and many other devices.  When printed, it will appear like this:
  43. @ID {
  44. @Heading { Introduction }
  45. @PP
  46. For Virginia Woolf, @I Middlemarch was `the magnificent book which
  47. for all its imperfections is one of the few English novels written
  48. for grown-up people.'
  49. }
  50. The meaning of each symbol is now clear.  @Code "@Doc @Text @Begin" and
  51. @Code "@End @Text" have no visible effect, but they always bracket the
  52. document as a whole.  @Code "@Heading" makes the following thing into
  53. a heading; there is also @Code "@MajorHeading" for producing a large
  54. heading, and @Code "@MinorHeading" for a subheading.  The @Code "@PP"
  55. symbol starts a paragraph whose first line is indented; also available
  56. are {@Code "@LP"} which omits the indent, {@Code "@DP"} which leaves the
  57. amount of vertical space used for displays, and {@Code "@NP"}, which
  58. starts a new page or column (rarely used, since Lout does this
  59. automatically when the old one fills).  Finally, @Code "@I" changes the
  60. font of the following thing to {@I Italic}.
  61. @PP
  62. Braces are used to group parts of the document together so that nearby
  63. symbols will affect the whole part.  For example,
  64. @ID @Code "@I { Scenes of Clerical Life }"
  65. produces {@I { Scenes of Clerical Life }}.  The braces around
  66. @Code "Introduction" in the example above are not strictly necessary,
  67. since a single word does not need to be grouped; but a longer heading
  68. would require them.  Braces also help when a symbol must be immediately
  69. adjacent to another symbol or to a word:
  70. @ID @Code "QuikWipe{@TradeMark}"
  71. has result QuikWipe{@TradeMark}.  Without them Lout would confuse the
  72. two.  In a similar way, @Code "{@I Middlemarch}," produces
  73. {@I Middlemarch}, with the comma not set in Italic.
  74. @PP
  75. Characters like "{", which normally are symbols, will be
  76. treated as ordinary words when enclosed in double quotes.  For example,
  77. @Code "\"{\"" produces "{".  The characters
  78. @ID @Code "/    |    &    {    }    #    @    ^"
  79. should always be so enclosed, since otherwise they will have special
  80. effects.
  81. @PP
  82. The symbols described above form part of the {@I DocumentLayout @I package},
  83. a collection of symbols designed to make day-to-day document formatting
  84. easy.  This package also provides symbols for producing displays and
  85. lists, numbered sections, subsections, and appendices, footnotes,
  86. figures, tables, references, and cross references.  These are described
  87. in later sections of this report.  This same package may also be used to
  88. produce technical reports and books, as described in Sections
  89. @NumberOf reportlayout and {@NumberOf booklayout}.
  90. @End @Section
  91.