diff options
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/README | 28 | ||||
| -rw-r--r-- | doc/user/all | 4 | ||||
| -rw-r--r-- | doc/user/bgr_prec | 20 | ||||
| -rw-r--r-- | doc/user/dia_summ | 124 | ||||
| -rw-r--r-- | doc/user/fmt_size | 18 | ||||
| -rw-r--r-- | doc/user/preface | 2 | ||||
| -rw-r--r-- | doc/user/str_larg | 25 | ||||
| -rw-r--r-- | doc/user/str_list | 16 |
8 files changed, 207 insertions, 30 deletions
diff --git a/doc/user/README b/doc/user/README index 2147e56..85e8743 100644 --- a/doc/user/README +++ b/doc/user/README @@ -19,19 +19,17 @@ nearly all beginning with "unresolved cross reference". These should gradually go away on later runs. The following shows the error message output on the last run for A4 size printing: - lout: - : lout -r beginning run 6: - lout file "str_glos" (from "str" line 15, from "all" line 38): - 8,1: 1.0c object too high for 1.0c space; will try elsewhere - lout file "str_indx" (from "str" line 16, from "all" line 38): - 54,1: 0.3c object too high for 0.2c space; will try elsewhere - lout file "gra_summ" (from "gra" line 44, from "all" line 46): - 10,1: 24.1c object too high for 23.6c space; @Scale inserted - lout file "prg_tabs" (from "prg" line 141, from "all" line 48): - 66,23: prg2lout 2,1: program text ended within comment - 68,35: prg2lout 2,1: program text ended within comment - -The first two warnings are about footnotes that did not fit onto the +lout: + : lout -r beginning run 6: +lout file "str_indx" (from "str" line 16, from "all" line 38): + 54,1: 0.3c object too high for 0.1c space; will try elsewhere +lout file "gra_summ" (from "gra" line 44, from "all" line 46): + 10,1: 24.1c object too high for 23.6c space; @Scale inserted +lout file "prg_tabs" (from "prg" line 141, from "all" line 48): + 66,23: prg2lout 2,1: program text ended within comment + 68,35: prg2lout 2,1: program text ended within comment + +The first warning is about a footnote that did not fit onto the first available page. The next is about a large table that had to be scaled down slightly to fit on the page. The last two warnings point to two places where a C program text ended inside a comment, which in @@ -43,7 +41,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.it.su.edu.au/jeff/lout/lout-3.32.user.ps.gz". +stored at "ftp://ftp.it.usyd.edu.au/jeff/lout/lout-3.33.user.ps.gz". Jeffrey H. Kingston -25 October 2006 +14 November 2006 diff --git a/doc/user/all b/doc/user/all index 37fc0d3..e130067 100644 --- a/doc/user/all +++ b/doc/user/all @@ -22,8 +22,8 @@ Lout Document Formatting System } @Author { Jeffrey H. Kingston } - @Edition { Version 3.32 -October, 2006 } + @Edition { Version 3.33 +November, 2006 } @Publisher { Copyright @CopyRight 1991, 2006 Jeffrey H. Kingston, School of Information Technologies, diff --git a/doc/user/bgr_prec b/doc/user/bgr_prec index d26b989..7ece8ff 100644 --- a/doc/user/bgr_prec +++ b/doc/user/bgr_prec @@ -141,6 +141,26 @@ the bottom edge of the higher list item to the top edge of the lower one, rather than from baseline to baseline. Enclosing the last word of the troublesome items in @Code "@VStrut" will fix this problem. @PP +Alternatively, and possibly more conveniently, Version 3.33 of Lout +has added a @Code "strut" option to the @Code "@Font" symbol, used +alone like this: +@ID @Code "strut @Font ..." +or in combination with other values suited to go to the left of +{@Code "@Font"}, like this: +@ID @Code "{ strut +2p } @Font ..." +This causes a vertical strut to be added to every word under the +influence of the {@Code "@Font"} symbol. The height of this +kind of strut is fixed at the height of the highest character in +the font, and its depth at the depth of the deepest character, +as recorded by the `font bounding box' stored with the description +of the font. For example, +@ID @Code "strut @Font { @Box { e }, @Box { @f }, and @Box { g } }" +produces +@ID strut @Font { @Box { e }, @Box { f }, and @Box { g } } +If you need many struts, it might pay to include @Code "strut" +in the @Code "@InitialFont" option of your document, so that it +applies everywhere. +@PP The @Code "@OverStrike" symbol causes the objects on overstrike. @Index @Code "@OverStrike" each side of it to be overstruck: diff --git a/doc/user/dia_summ b/doc/user/dia_summ index c068fe5..ad9f4ba 100644 --- a/doc/user/dia_summ +++ b/doc/user/dia_summ @@ -765,6 +765,112 @@ A:: @Circle /0.8c |1.5c B:: @Circle } } +@LI { +@Code { +"@Link" +" path { dhuline }" +" bias { 2.0f }" +} +||6ct +@Diag { +//0.5f +A:: @Circle /0.8c |1.5c B:: @Circle /2f +// +@ShowTags @Link + pathstyle { solid dashed } + path { dhuline } from { A } to { B } +} +&2.5c +@Diag { +//0.5f +|1.5c B:: @Circle /0.8c A:: @Circle /2f +// +@ShowTags @Link + pathstyle { solid dashed } + path { dhuline } from { A } to { B } +} +} + +@LI { +@Code { +"@Link" +" path { uhdline }" +" bias { 2.0f }" +} +||6ct +@Diag { +//2.5f +A:: @Circle /0.8c |1.5c B:: @Circle +// +@ShowTags @Link + pathstyle { solid dashed } + path { uhdline } from { A } to { B } +} +&2.5c +@Diag { +//2.5f +|1.5c B:: @Circle /0.8c A:: @Circle +// +@ShowTags @Link + pathstyle { solid dashed } + path { uhdline } from { A } to { B } +} +} + +@LI { +@Code { +"@Link" +" path { dhucurve }" +" bias { 2.0f }" +" radius { 1.0f }" +} +||6ct +@Diag { +//0.5f +A:: @Circle /0.8c |1.5c B:: @Circle /2f +// +@ShowTags @Link + pathstyle { solid dashed } + path { dhucurve } from { A } to { B } +} +&2.5c +@Diag { +//0.5f +|1.5c B:: @Circle /0.8c A:: @Circle /2f +// +@ShowTags @Link + pathstyle { solid dashed } + path { dhucurve } from { A } to { B } +} +} + +@LI { +@Code { +"@Link" +" path { uhdcurve }" +" bias { 2.0f }" +" radius { 1.0f }" +} +||6ct +@Diag { +//2.5f +A:: @Circle /0.8c |1.5c B:: @Circle +// +@ShowTags @Link + pathstyle { solid dashed } + path { uhdcurve } from { A } to { B } +} +&2.5c +@Diag { +//2.5f +|1.5c B:: @Circle /0.8c A:: @Circle +// +@ShowTags @Link + pathstyle { solid dashed } + path { uhdcurve } from { A } to { B } +} +} + @LII { In the following links, the @Code "hfrac" and @Code "hbias" options determine how far across from @Code "FROM" to @Code "TO" the path turns @@ -1078,6 +1184,23 @@ path also has an abbreviation which adds a forward arrow: C { RVLCurveArrow } @Rowa + A { dhuline } + B { DHULine } + C { DHUArrow } +@Rowa + A { uhdline } + B { UHDLine } + C { UHDArrow } +@Rowa + A { dhucurve } + B { DHUCurve } + C { DHUCurveArrow } +@Rowa + A { uhdcurve } + B { RVLCurve } + C { RVLCurveArrow } + +@Rowa A { hvhline } B { HVHLine } C { HVHArrow } @@ -1133,6 +1256,7 @@ have been omitted where they are the same as the {@Code linklabel} options. {@Code "ccurve"}, {@Code "bezier"}, {@Code "vhline"}, {@Code "hvline"}, {@Code "vhcurve"}, {@Code "hvcurve"}, {@Code "lvrline"}, {@Code "rvlline"}, {@Code "lvrcurve"}, {@Code "rvlcurve"}, +{@Code "dhuline"}, {@Code "uhdline"}, {@Code "dhucurve"}, {@Code "uhdcurve"}, {@Code "hvhline"}, {@Code "vhvline"}, {@Code "hvhcurve"}, {@Code "vhvcurve"}, {@Code "dwrapline"}, {@Code "uwrapline"}, {@Code "dwrapcurve"}, {@Code "uwrapcurve"}, or any path } diff --git a/doc/user/fmt_size b/doc/user/fmt_size index 7fd138e..550bf57 100644 --- a/doc/user/fmt_size +++ b/doc/user/fmt_size @@ -12,8 +12,10 @@ page.type @Index @Code "@PageType" @PageHeight {} @PageOrientation { Portrait } } -The usual way to determine the page size is to set the @Code "@PageType" -option to the name of the paper you use: +The default value at your site may be different, since installers of +Lout are recommended to set it to the usual size of a piece of paper +at their location. The easy way to change the page size is to set +the @Code "@PageType" option to the name of the paper you use: @ID @Tab vmargin { 0.5vx } @Fmtb { @Col ! @Col ! @Col @I @RR B ! @Col @I @RR C } @@ -27,7 +29,9 @@ option to the name of the paper you use: @Rowa A { Legal } B { 612p } C { 1008p } @Rowa A { Statement } B { 396p } C { 612p } @Rowa A { Executive } B { 540p } C { 720p } -@Rowa A { A2 } B { 1190p } C { 1884p } +@Rowa A { A0 } B { 2380p } C { 3368p } +@Rowa A { A1 } B { 1684p } C { 2380p } +@Rowa A { A2 } B { 1190p } C { 1684p } @Rowa A { A3 } B { 842p } C { 1190p } @Rowa A { A4 } B { 595p } C { 842p } @Rowa A { A5 } B { 420p } C { 595p } @@ -85,8 +89,8 @@ the basic ones: A { "@PageOrientation { ReverseLandscape }" } B { @Box 1.4c @Wide 1.0c @High { //1rt &1rt 180d @Rotate Hello } } } -@Code ReverseLandscape might be useful when post-processing the PostScript output -to print two landscape pages per sheet. The @Code "@PageOrientation" symbol is -available at the start of a document, as well as in the setup file, like -{@Code "@InitialFont"} and {@Code "@PageHeaders"}. +@Code ReverseLandscape might be useful when post-processing the PostScript +output to print two landscape pages per sheet. The @Code "@PageOrientation" +symbol is available at the start of a document, as well as in the setup +file, like {@Code "@InitialFont"} and {@Code "@PageHeaders"}. @End @Section diff --git a/doc/user/preface b/doc/user/preface index 431dbf8..505b0d3 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.32.tar.gz"}), and various other things including +(currently {@Code "lout-3.33.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/str_larg b/doc/user/str_larg index 2d244ae..9e5fc79 100644 --- a/doc/user/str_larg +++ b/doc/user/str_larg @@ -46,17 +46,32 @@ symbols, like this: } This arrangement is reminiscent of the one for lists, and, as for lists, there may be no paragraph or new page symbols before, between, -or after the sections. To change the gap between sections, you need -to change the @Code "@SectionGap" option in the setup file, as explained -in Chapter {@NumberOf types}. If you just want a new page before one -section, not all sections, place @Code "@NP" at the very end of the -previous section, just before its {@Code "@End @Section"}. +or after the sections. @PP The @Code "@Begin ... @End @Section" that brackets the body of each section may be abbreviated to {@Code "{ ... }"}. However, the long form is recommended because it helps Lout to detect missing or extra braces within the body of the section. @PP +To change the gap between sections, you need to change the +@Code "@SectionGap" option in the setup file, as explained in +Chapter {@NumberOf types}. If you just want a new page or column +before one section, then use the @Code "@NewPage" option of that +section, like this: +@ID @OneRow @Code { +"@Section" +" @Title { Bandicoots and quolls }" +" @NewPage { Yes }" +"@Begin" +"..." +"@End @Section" +} +The @Code "@NewPage" option is only available with large-scale structure +symbols that usually do not appear on a new page (like {@Code "@Section"}), +and it forces them to appear on a new page. You can't use it with +large-scale structure symbols that usually appear on a new page (like +{@Code "@Chapter"}) to force them not to -- there is no way to do that. +@PP All large-scale structure symbols have a @Code "@Tag" option, whose use is explained in Section {@NumberOf cross}, and a @Code "@RunningTitle" runningtitle. @Index @Code "@RunningTitle" diff --git a/doc/user/str_list b/doc/user/str_list index 4f65e68..9747c15 100644 --- a/doc/user/str_list +++ b/doc/user/str_list @@ -368,6 +368,7 @@ are all the options, together with their default values: rightindent { 0c } gap { 1v } start { 1 } + font { } break { } colnum { 1 } colgap { 1.0c } @@ -440,6 +441,21 @@ item. It must be decimal: looks strange, but it is the correct way to number the first item (xxv). @PP +The @Code "font" option defines a font (or any value suited for +the @Code "@Font" symbol) which is to be applied to each item +(but not the labels). For example, you might be bothered by +the fact that a list item whose last line has no descenders in +its letters is closer to the next list item, producing a slightly +irregular appearance. One way to solve this problem is +@ID @OneRow @Code @Verbatim { +@NumberedList + font { strut } +} +since the value @Code "strut" given to the @Code "@Font" symbol +causes it to insert an invisible vertical strut into every word under +the influence of that symbol. For more information, including +another way to insert struts, consult Section {@NumberOf precise}. +@PP The @Code "break" option defines a break style (suitable for the @Code "@Break" symbol) which is to be applied to each item. If you wanted each item in a ragged style, for example, you could |