diff options
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/README | 6 | ||||
| -rw-r--r-- | doc/user/all | 4 | ||||
| -rw-r--r-- | doc/user/bas | 2 | ||||
| -rw-r--r-- | doc/user/bas_char | 278 | ||||
| -rw-r--r-- | doc/user/bas_lang | 55 | ||||
| -rw-r--r-- | doc/user/bgr_text | 13 | ||||
| -rw-r--r-- | doc/user/dia_tags | 22 | ||||
| -rw-r--r-- | doc/user/preface | 2 | ||||
| -rw-r--r-- | doc/user/prg | 17 | ||||
| -rw-r--r-- | doc/user/typ_book | 67 | ||||
| -rw-r--r-- | doc/user/typ_orga | 1 | ||||
| -rw-r--r-- | doc/user/typ_over | 25 | ||||
| -rw-r--r-- | doc/user/typ_plai | 2 |
13 files changed, 417 insertions, 77 deletions
diff --git a/doc/user/README b/doc/user/README index 85c95c7..99e1a75 100644 --- a/doc/user/README +++ b/doc/user/README @@ -19,7 +19,7 @@ error message output on the later runs for A4 size printing: lout file "gra_summ" (from "gra" line 44, from "all" line 46): 10,1: 23.7c object too high for 23.6c space; @Scale inserted -lout file "prg_tabs" (from "prg" line 112, from "all" line 48): +lout file "prg_tabs" (from "prg" line 127, from "all" line 48): 66,23: prg2lout 2,1: program text ended within comment 68,35: prg2lout 2,1: program text ended within comment @@ -35,7 +35,7 @@ repeated failure to converge, caused by footnotes and floating figures close to large unbreakable displays. A copy of the final PostScript output file (A4 paper size) is -stored at "ftp://ftp.cs.su.oz.au/jeff/lout/lout-3.27.user.ps.gz". +stored at "ftp://ftp.cs.su.oz.au/jeff/lout/lout-3.28.user.ps.gz". Jeffrey H. Kingston -22 November 2002 +20 December 2002 diff --git a/doc/user/all b/doc/user/all index b92514b..96aa5af 100644 --- a/doc/user/all +++ b/doc/user/all @@ -22,8 +22,8 @@ Lout Document Formatting System } @Author { Jeffrey H. Kingston } - @Edition { Version 3.27 -November, 2002 } + @Edition { Version 3.28 +December, 2002 } @Publisher { Copyright @CopyRight 1991, 2002 Jeffrey H. Kingston, School of Information Technologies, diff --git a/doc/user/bas b/doc/user/bas index 239d35a..253abd8 100644 --- a/doc/user/bas +++ b/doc/user/bas @@ -21,8 +21,8 @@ simple to use. @Include { bas_line } @Include { bas_hyph } @Include { bas_unde } -@Include { bas_date } @Include { bas_lang } +@Include { bas_date } @Include { bas_supe } @Include { bas_verb } @Include { bas_drop } diff --git a/doc/user/bas_char b/doc/user/bas_char index 7efa566..4f4b8a6 100644 --- a/doc/user/bas_char +++ b/doc/user/bas_char @@ -303,6 +303,284 @@ like the other fonts. Typing @Code "@B @Sym alpha" is therefore useless, and anyway there is no bold @Sym alpha character in any font distributed with Lout (except see Section {@NumberOf teq}). @PP +Next there are the dingbats. Here they are with their +dingbats. @Index { dingbats characters } +(regrettably meaningless) names: +@FootNote { +If you see only conventional characters in this table, the problem +is that your viewer does not have access to the Dingbats font. The +author's viewer has this problem, for example, but his printer doesn't. +} +@CD @Tbl + indent { ctr } + iv { ctr } + rule { yes } + font { -1p } + width { 1.0c } + margin { 0.2f } + aiv { top } + afont { Helvetica Base -2p } + aformat { + @Cell paint { @Xrgb grey95 } -90d @Rotate B | + @Cell ruleright { double } -90d @Rotate C | + @Cell paint { @Xrgb grey95 } -90d @Rotate D | + @Cell ruleright { double } -90d @Rotate E | + @Cell paint { @Xrgb grey95 } -90d @Rotate F | + @Cell ruleright { double } -90d @Rotate G | + @Cell paint { @Xrgb grey95 } -90d @Rotate H | + @Cell ruleright { double } -90d @Rotate I | + @Cell paint { @Xrgb grey95 } -90d @Rotate J | + @Cell ruleright { double } -90d @Rotate K | + @Cell paint { @Xrgb grey95 } -90d @Rotate L | + @Cell -90d @Rotate M | } + bformat { + @Cell paint { @Xrgb grey95 } indent { right } B | + @Cell ruleright { double } font { Dingbats Base -1p } @Char C | + @Cell paint { @Xrgb grey95 } indent { right } D | + @Cell ruleright { double } font { Dingbats Base -1p } @Char E | + @Cell paint { @Xrgb grey95 } indent { right } F | + @Cell ruleright { double } font { Dingbats Base -1p } @Char G | + @Cell paint { @Xrgb grey95 } indent { right } H | + @Cell ruleright { double } font { Dingbats Base -1p } @Char I | + @Cell paint { @Xrgb grey95 } indent { right } J | + @Cell ruleright { double } font { Dingbats Base -1p } @Char K | + @Cell paint { @Xrgb grey95 } indent { right } L | + @Cell font { Dingbats Base -1p } @Char M | } +{ + @Rowa + B { "@"Ding } C{ Dingbat } + D { "@"Ding } E{ Dingbat } + F { "@"Ding } G{ Dingbat } + H { "@"Ding } I{ Dingbat } + J { "@"Ding } K{ Dingbat } + L { "@"Ding } M{ Dingbat } + @Rowb + B{a1} C{a1} + D{a2} E{a2} + F{a202} G{a202} + H{a3} I{a3} + J{a4} K{a4} + L{a5} M{a5} + @Rowb + B{a119} C{a119} + D{a118} E{a118} + F{a117} G{a117} + H{a11} I{a11} + J{a12} K{a12} + L{a13} M{a13} + @Rowb + B{a14} C{a14} + D{a15} E{a15} + F{a16} G{a16} + H{a105}I{a105} + J{a17} K{a17} + L{a18} M{a18} + @Rowb + B{a19} C{a19} + D{a20} E{a20} + F{a21} G{a21} + H{a22} I{a22} + J{a23} K{a23} + L{a24} M{a24} + @Rowb + B{a25} C{a25} + D{a26} E{a26} + F{a27} G{a27} + H{a28}I{a28} + J{a6} K{a6} + L{a7} M{a7} + @Rowb + B{a8} C{a8} + D{a9} E{a9} + F{a10} G{a10} + H{a29} I{a29} + J{a30} K{a30} + L{a31} M{a31} + @Rowb + B{a32} C{a32} + D{a33} E{a33} + F{a34} G{a34} + H{a35} I{a35} + J{a36} K{a36} + L{a37} M{a37} + @Rowb + B{a38} C{a38} + D{a39} E{a39} + F{a40} G{a40} + H{a41} I{a41} + J{a42} K{a42} + L{a43} M{a43} + @Rowb + B{a44} C{a44} + D{a45} E{a45} + F{a46} G{a46} + H{a47} I{a47} + J{a48} K{a48} + L{a49} M{a49} + @Rowb + B{a50} C{a50} + D{a51} E{a51} + F{a52} G{a52} + H{a54} I{a54} + J{a55} K{a55} + L{a56} M{a56} + @Rowb + B{a57} C{a57} + D{a58} E{a58} + F{a59} G{a59} + H{a60} I{a60} + J{a61} K{a61} + L{a62} M{a62} + @Rowb + B{a63} C{a63} + D{a64} E{a64} + F{a65} G{a65} + H{a66} I{a66} + J{a67} K{a67} + L{a68} M{a68} + @Rowb + B{a69} C{a69} + D{a70} E{a70} + F{a71} G{a71} + H{a72} I{a72} + J{a73} K{a73} + L{a74} M{a74} + @Rowb + B{a203} C{a203} + D{a75} E{a75} + F{a204} G{a204} + H{a76} I{a76} + J{a77} K{a77} + L{a78} M{a78} + @Rowb + B{a79} C{a79} + D{a81} E{a81} + F{a82} G{a82} + H{a83} I{a83} + J{a84} K{a84} + L{a97} M{a97} + @Rowb + B{a98} C{a98} + D{a99} E{a99} + F{a100} G{a100} + H{a101} I{a101} + J{a102} K{a102} + L{a103} M{a103} + @Rowb + B{a104} C{a104} + D{a106} E{a106} + F{a107} G{a107} + H{a108} I{a108} + J{a112} K{a112} + L{a111} M{a111} + @Rowb + B{a110} C{a110} + D{a109} E{a109} + F{a120} G{a120} + H{a121} I{a121} + J{a122} K{a122} + L{a123} M{a123} + @Rowb + B{a124} C{a124} + D{a125} E{a125} + F{a126} G{a126} + H{a127} I{a127} + J{a128} K{a128} + L{a129} M{a129} + @Rowb + B{a130} C{a130} + D{a131} E{a131} + F{a132} G{a132} + H{a133} I{a133} + J{a134} K{a134} + L{a135} M{a135} + @Rowb + B{a136} C{a136} + D{a137} E{a137} + F{a138} G{a138} + H{a139} I{a139} + J{a140} K{a140} + L{a141} M{a141} + @Rowb + B{a142} C{a142} + D{a143} E{a143} + F{a144} G{a144} + H{a145} I{a145} + J{a146} K{a146} + L{a147} M{a147} + @Rowb + B{a148} C{a148} + D{a149} E{a149} + F{a150} G{a150} + H{a151} I{a151} + J{a152} K{a152} + L{a153} M{a153} + @Rowb + B{a154} C{a154} + D{a155} E{a155} + F{a156} G{a156} + H{a157} I{a157} + J{a158} K{a158} + L{a159} M{a159} + @Rowb + B{a160} C{a160} + D{a161} E{a161} + F{a163} G{a163} + H{a164} I{a164} + J{a196} K{a196} + L{a165} M{a165} + @Rowb + B{a192} C{a192} + D{a166} E{a166} + F{a167} G{a167} + H{a168} I{a168} + J{a169} K{a169} + L{a170} M{a170} + @Rowb + B{a171} C{a171} + D{a172} E{a172} + F{a173} G{a173} + H{a162} I{a162} + J{a174} K{a174} + L{a175} M{a175} + @Rowb + B{a176} C{a176} + D{a177} E{a177} + F{a178} G{a178} + H{a179} I{a179} + J{a193} K{a193} + L{a180} M{a180} + @Rowb + B{a199} C{a199} + D{a181} E{a181} + F{a200} G{a200} + H{a182} I{a182} + J{a201} K{a201} + L{a183} M{a183} + @Rowb + B{a184} C{a184} + D{a197} E{a197} + F{a185} G{a185} + H{a194} I{a194} + J{a198} K{a198} + L{a186} M{a186} + @Rowb + B{a195} C{a195} + D{a187} E{a187} + F{a188} G{a188} + H{a189} I{a189} + J{a190} K{a190} + L{a191} M{a191} +} +The easiest way to get a dingbat is to write, for example, +@ID @Code "@Ding a123" +which produces the dingbat with the given name from the table +above. This is just a shorthand for +@ID @Code @Verbatim { +{ Dingbats Base } @Font { @Char a123 } +} +In other words, dingbats are just another font. +@PP Finally we have a few more characters that you get with the @Code "@Char" symbol, although they aren't ISO-LATIN-1 characters. @ID @OneRow -3p @Font @Tab diff --git a/doc/user/bas_lang b/doc/user/bas_lang index fea9f3f..7468076 100644 --- a/doc/user/bas_lang +++ b/doc/user/bas_lang @@ -15,27 +15,40 @@ Changing language is quite analogous to changing font using the @Code "@Font" symbol. @PP At the time of writing, the following languages were available: -@ID @OneRow @Code { -Croatian Hrvatski -Czech Cesky Cestina cs -Danish Dansk da -Dutch Nederlands nl -English en -EnglishUK en-GB -Finnish Suomi fi -French Francais Fran{@Char ccedilla}ais fr -German Deutsch de -Hungarian Magyar hu -Italian Italiano it -Norwegian Norsk no -Polish Polski pl -Portuguese Português pt -Russian ru -Slovak Slovensky Slovencina -Slovenian Slovenia Slovenija sl -Spanish Espa{@Char ntilde}ol es -Swedish Svenska sv -UpperSorbian hornjoserbsce serbsce +@CD @OneRow @Tbl + aformat { @Cell ml { 0i } @Code A | @Cell mr { 0i } @Code B } + mv { 0.5vx } +{ +@Rowa + A { Croatian Hrvatski } + B { Italian Italiano it } +@Rowa + A { Czech Cesky Cestina cs } + B { Norwegian Norsk no } +@Rowa + A { Danish Dansk da } + B { Polish Polski pl } +@Rowa + A { Dutch Nederlands nl } + B { Portuguese Português pt } +@Rowa + A { English en } + B { Russian ru } +@Rowa + A { EnglishUK en-GB } + B { Slovak Slovensky Slovencina } +@Rowa + A { Finnish Suomi fi } + B { Slovenian Slovenia Slovenija sl } +@Rowa + A { French Francais Fran{@Char ccedilla}ais fr } + B { Spanish Espa{@Char ntilde}ol es } +@Rowa + A { German Deutsch de } + B { Swedish Svenska sv } +@Rowa + A { Hungarian Magyar hu } + B { UpperSorbian hornjoserbsce serbsce } } File @Code "include/langdefs" in the distribution always has the exact list of known languages. As shown, most languages have alternative diff --git a/doc/user/bgr_text b/doc/user/bgr_text index 2c56022..286698a 100644 --- a/doc/user/bgr_text +++ b/doc/user/bgr_text @@ -8,7 +8,7 @@ texture.sym @Index { @Code "@Texture" symbol } and @Code "@Colour" do. It causes the object to its right to be printed in a texture specified by the object to its left: -@ID @Code "striped @Texture 50p @Font ABC" +@ID @Code "striped @Texture 40p @Font ABC" produces @FootNote { If you can't see the result here, or if you can see it but without @@ -16,9 +16,12 @@ texture, then the fault is probably in your PostScript viewer. The PostScript viewer used by the author (a 1997 version of @I { gv }) shows a blank space here and throughout this section wherever a texture is supposed to appear, but when printed on his printer -the textures appear correctly. +the textures appear correctly. Some viewers may fail altogether when +given a PostScript file with textures. In that case, run your document +again using @OneCol @I { lout -t } instead of @I { lout }. This will +cause Lout to ignore all textures and print everything in solid colour. } -@CD striped @Texture 50p @Font ABC +@CD striped @Texture 40p @Font ABC The object to the right of @Code "@Texture" may be arbitrary as usual. @PP # Textures are harder to specify than colours, and only a few @@ -39,7 +42,7 @@ striped @Texture angle { 45d } hshift { 1p } vshift { 3p } -50p @Font ABC +40p @Font ABC } produces @CD striped @Texture @@ -47,7 +50,7 @@ produces angle { 45d } hshift { 1p } vshift { 3p } -50p @Font ABC +40p @Font ABC with the texture scaled by a factor of 2, printed at an angle of 45 degrees, and shifted one point horizontally and three points vertically. The @Code scale option causes equal scaling in the diff --git a/doc/user/dia_tags b/doc/user/dia_tags index ce2e2d7..67ad6a0 100644 --- a/doc/user/dia_tags +++ b/doc/user/dia_tags @@ -122,9 +122,15 @@ A:: { } } In practice one usually only retags individual nodes. It is best to -use only upper-case letters and digits in tags, because Lout and -PostScript have tags of their own containing lower-case letters, and -any mixup causes total disaster. +use only upper-case letters in tags, because Lout and PostScript have +tags of their own containing lower-case letters, and any mixup causes +total disaster. Although the above example uses digits, these can +cause problems since a tag like {@Code "A@1@S"} will be interpreted +by Lout as @Code "A@1" followed by the @Code "@S" small capitals +symbol. (This problem can itself be avoided by enclosing the entire +tag in quotes, as in {@Code "\"A@1@S\""}; this works because tags are +just words to Lout, although they are symbols to PostScript. But +better to avoid the whole problem by not using digits.) @PP When a tag lies within the object following some node, it is automatically retagged in this way with tag {@Code IN}. For example, in @@ -147,8 +153,8 @@ Although @Code from and @Code to are just two of several options within given, they have a special virtue not shared by any other options. It is possible to give the name of an entire node, not just a tag denoting one point, to them: -@ID @Verbatim { -@Code { +@ID { +@Code @Verbatim { A:: @Circle @DP B:: @Ellipse { Hello, world } @@ -173,9 +179,9 @@ The @Code "::" symbol has a @Code restrict option which can be diagrams. @RawIndex { diagrams } diagrams.restrict @SubIndex { @Code "restrict" option } restrict.diagrams @Index { @Code "restrict" option (diagrams) } -used to save printer memory in deeply nested structures (such as -the syntax diagrams of Section {@NumberOf dia_synt}) by restricting -the tags promoted by @Code "::" to a limited set: +used to save printer memory in deeply nested structures (such as the +syntax diagrams of Section {@NumberOf dia_synt}) by restricting the +tags promoted by @Code "::" to a limited set and discarding the rest: @ID { @Code { "A:: restrict { (E) (W) } @Ellipse" diff --git a/doc/user/preface b/doc/user/preface index c2d3da1..ba2ea1a 100644 --- a/doc/user/preface +++ b/doc/user/preface @@ -18,7 +18,7 @@ gnu. @Index { GNU Public License } primary source is directory @ID @Code "ftp://ftp.it.usyd.edu.au/jeff/lout" containing a gzipped tar file of the current version -(currently {@Code "lout-3.27.tar.gz"}), and various other things including +(currently {@Code "lout-3.28.tar.gz"}), and various other things including a PostScript version of this guide. The distribution contains source code, libraries, documentation, license, and installation instructions. @PP diff --git a/doc/user/prg b/doc/user/prg index 6b64e12..ad5e1fc 100644 --- a/doc/user/prg +++ b/doc/user/prg @@ -33,17 +33,19 @@ blue. @Index { Blue program printing } c. @Index { C and C++ program printing } eiffel. @Index { Eiffel program printing } java. @Index { Java program printing } +nonpareil. @Index { Nonpareil program printing } perl. @Index { Perl program printing } pod. @Index { Pod (for Perl) printing } python. @Index { Python program printing } +ruby. @Index { Ruby program printing } @CD @Tbl mv { 0.5vx } af { Italic } - arb { yes } aformat { @Cell A | @Cell B | @Cell C | @Cell D | @Cell E } bformat { @Cell A | @Cell @Code B | @Cell @Code C | @Cell @Code D | @Cell E } { @Rowa + rb { yes } A { Language name } B { Setup file name } C { Lout symbol } @@ -74,6 +76,12 @@ python. @Index { Python program printing } D { fixed } E { No } @Rowb + A { Nonpareil } + B { np } + C { "@Nonpareil" } + D { symbol } + E { Yes } +@Rowb A { Perl } B { perl } C { "@Perl" } @@ -91,6 +99,13 @@ python. @Index { Python program printing } C { "@Python" } D { varying } E { No } +@Rowb + A { Ruby } + B { ruby } + C { "@Ruby" } + D { fixed } + E { No } + rb { yes } } C and C++ are handled together since, for formatting purposes, they differ only in that C++ has some additional keywords plus an extra diff --git a/doc/user/typ_book b/doc/user/typ_book index 6daa713..dec1e20 100644 --- a/doc/user/typ_book +++ b/doc/user/typ_book @@ -64,7 +64,9 @@ with no page headers or footers, and using the same margins as for even pages, after the very last page of the book; even after the index if there is one. It is intended to make it possible to include a back cover, so @Code "@PageOf last.page" (Section {@NumberOf cross}) does -not take account of any @Code "@AtEnd" page. +not take account of any @Code "@AtEnd" page. (To make a colophon, +which occupies any number of numbered pages after the index, consult +the @Code "@Colophon" symbol below.) @PP The remaining options are a selection of setup file options (Section {@NumberOf setup}) that frequently need to be changed. If your changes @@ -265,11 +267,12 @@ beginsubsubappendices.books @SubIndex { in books } endsubsubappendices.books @SubIndex { in books } sub-sub-subappendices. @PP -The book ends with the last chapter or appendix; any reference list or -index will be appended automatically. Although we have described how to -create books as though everything was in one large file, in practice it -is much better to divide the book into multiple files, following the -method given in Section {@NumberOf organizing}. +Apart from any colophon, described below, the book ends with the last +chapter or appendix; any reference list or index will be appended +automatically. Although we have described how to create books as +though everything was in one large file, in practice it is much better +to divide the book into multiple files, following the method given in +Section {@NumberOf organizing}. @PP In addition to the {@Code "@Title"} option, each large-scale structure symbol (i.e. {@Code "@Preface"}, {@Code "@Introduction"}, {@Code "@Chapter"}, @@ -300,6 +303,37 @@ will also be an entry made in the table of contents. Parts are @I not numbered automatically: you have to supply your own numbers or letters as shown above. @PP +After the last chapter or appendix, an optional colophon may be given: +@ID @OneRow @Code @Verbatim { +@Colophon @Begin +This document was typeset using the Lout document +formatting system. The resulting PostScript file +was converted to PDF using GNU @I { ps2pdf }. +@End @Colophon +} +For this to work, however, the @Code "@MakeColophon" option of the +setup file must be changed to @Code Yes (see next paragraph). A +colophon appears at the very end of the book, after the index. It may +occupy several pages, and these will be numbered as usual. See also +the @Code "@AtEnd" option above, which is intended to hold a one-page +unnumbered back cover. As the example suggests, colophons these days +are generally used for notes concerning how a book was produced. They +are an old form that has been revived; previously, according to my +dictionary, they contained information now printed on the title page. +@PP +A colophon is like a preface except that it appears at the end, and +should logically be implemented like the {@Code "@Preface"} symbol. +Unfortunately, owing to problems behind the scenes it has instead +been implemented like glossaries and indexes: you have to set a +@Code "@MakeColophon" option in the setup file to {@Code Yes}. There +are setup file options for setting the font and break style, column +number and column gap, and heading ({@Code "@ColophonFont"}, +{@Code "@ColophonBreak"}, {@Code "@ColophonColumnNumber"}, +{@Code "@ColophonColumnGap"}, and {@Code "@ColophonWord"}). There are +also {@Code "@ColophonInContents"} and {@Code "@ColophonPrefix"} +options for determining whether the colophon appears in the table +of contents, and its prefix when structured page numbers are used. +@PP The features described in other chapters are all available within books. A table of contents and index will appear automatically, and you will need to change the setup file to avoid them. Endnotes will @@ -393,8 +427,7 @@ write, say, "@ChapterHeadingFormat { @Box paint { lightgrey } { number @DP title } }" to get the title below the number, both enclosed in a box. The default value uses the @Code "@DotSep" symbol from Section {@NumberOf headers} -to produce the number and title separated by a dot and two spaces, roughly -the same as +to show the number and title separated by a dot and two spaces, like @ID @Code "@ChapterHeadingFormat { number. title }" except when there is no number. This option is applied to other major headings, in the preface, introduction, table of @@ -414,16 +447,16 @@ within @Code "@PartHeadingFormat" to change this. @PP The example of boxed titles for chapters given above suffers from two practical deficiencies. First, the box won't extend right across the -page, and second, when there is no @Code "number" we don't want the +page, and second, when there is no @Code "number" we don't want @Code "@DP" either. Here is a value for @Code "@ChapterHeadingFormat" -that solves both of these problems and looks good in practice: -@ID @OneCol @Code { -"@ChapterHeadingFormat {" -" number @Case {" -" {} @Yield @Box paint { lightgrey } @HExpand { title }" -" else @Yield @Box paint { lightgrey } @HExpand { number @DP title }" -" }" -"}" +that solves both problems: +@ID @OneCol @Code @Verbatim { +@ChapterHeadingFormat { + number @Case { + {} @Yield @Box paint { lightgrey } @HExpand { title } + else @Yield @Box paint { lightgrey } @HExpand { number @DP title } + } +} } The @Code "@Case" symbol (Expert's Guide @Cite { $kingston1995lout.expert }) distinguishes between the cases where @Code "number" is empty and non-empty; diff --git a/doc/user/typ_orga b/doc/user/typ_orga index 8ba6ab7..1e9aa36 100644 --- a/doc/user/typ_orga +++ b/doc/user/typ_orga @@ -20,6 +20,7 @@ chapter as a whole whose contents are as follows: @ID @OneRow @Code { "@Chapter" " @Title { Australian Native Plants }" +" @Tag { natives }" "@Begin" "Australian native plants provide a distinctive identity to the garden. Although" "less colourful than their European alternatives, some banksias and grevilleas do" diff --git a/doc/user/typ_over b/doc/user/typ_over index fd14e2a..cf3a189 100644 --- a/doc/user/typ_over +++ b/doc/user/typ_over @@ -91,18 +91,6 @@ page numbers only, @Code Titles produces full running titles, and @Code "@FirstOverheadNumber" is the number given to the first overhead, and @Code "@FirstLectureNumber" is the number given to the first lecture, of which more below. See preceding sections for {@Code "@OptimizePages"}. -# Lout ordinarily places lines onto a page until space runs out, then moves -# to the next page and so on. This often produces ugly empty spaces at -# the bottoms of pages preceding large unbreakable displays. Setting the -# @Code "@OptimizePages" option to {@Code "Yes"} causes Lout to examine the -# overall situation and try to minimize the ugliness, using the @TeX -# optimal paragraph breaking algorithm. It takes two runs to do this, -# with intermediate results stored in Lout's cross reference database -# (Section {@NumberOf cross}); so deleting file {@Code lout.li} will reset -# it, which might be wise after major changes. It is possible for the -# optimizer to cycle, never settling on a single final best -# version; this is usually caused by footnotes or floating figures inserted -# at points which end up near page boundaries. @PP After the compulsory {@Code "//"} come the overheads themselves. There are two alternatives: a series of overheads, corresponding to a single @@ -112,6 +100,9 @@ overhead. @Index @Code "@Overhead" @ID @OneRow @Code { "@SysInclude { slides }" "@OverheadTransparencies" +" @Title { ... }" +" @Author { ... }" +" @DateLine { ... }" " ..." "//" "@Overhead ... @End @Overhead" @@ -168,6 +159,9 @@ lecture. @Index @Code "@Lecture" @ID @OneRow @Code { "@SysInclude { slides }" "@OverheadTransparencies" +" @Title { ... }" +" @Author { ... }" +" @DateLine { ... }" " ..." "//" "@Lecture ... @End @Lecture" @@ -191,18 +185,15 @@ If @Code "@Title" is non-empty the series of overheads will begin with an overhead containing the title alone, centred on the page using the @Code "clines" paragraph breaking style. This means that it makes sense to have a multi-line title. Any text following the @Code "@Begin" -will appear under the lecture title as you would expect. -@PP -Within the body of {@Code "@Lecture"}, place a series of overheads +will appear under the lecture title as you would expect. Within the +body of {@Code "@Lecture"}, place a series of overheads bracketed by @Code "@BeginOverheads" and {@Code "@EndOverheads"}: beginoverheads. @Index @Code "@BeginOverheads" endoverheads. @Index @Code "@EndOverheads" @ID @OneRow @Code { "@BeginOverheads" "@Overhead ... @End @Overhead" -"@Overhead ... @End @Overhead" "..." -"@Overhead ... @End @Overhead" "@EndOverheads" } The @Code "@Overhead" symbol is exactly as described earlier. diff --git a/doc/user/typ_plai b/doc/user/typ_plai index a880ccb..8b5c327 100644 --- a/doc/user/typ_plai +++ b/doc/user/typ_plai @@ -70,7 +70,7 @@ the plain text output to appear unpaginated, that is, in one long continous stream with no page breaks. Its value is ignored if plain text output is not in effect, so it can be safely set to @Code "Yes" in documents intended for formatting both ways. The usual margins apply; -footnotes appear at the end; figures and tables do not work. Lout +footnotes appear at the end; floating figures and tables do not work. Lout stupidly reads the entire document before producing any output when this option is used, so if the document is long you might run out of memory. @End @Section |