diff options
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/README | 41 | ||||
-rw-r--r-- | doc/user/all | 8 | ||||
-rw-r--r-- | doc/user/preface | 2 | ||||
-rw-r--r-- | doc/user/str_figs | 20 |
4 files changed, 51 insertions, 20 deletions
diff --git a/doc/user/README b/doc/user/README index 706b31f..810f7ca 100644 --- a/doc/user/README +++ b/doc/user/README @@ -7,7 +7,7 @@ type the command lout all > op in this directory. Owing to some unfortunate page breaks in the -early runs, this must be done seven times to completely resolve +early runs, this must be done six times to completely resolve all cross references, although the PostScript file op is printable after the first run. Auxiliary files with .li and .ld suffixes will be created in this directory. @@ -15,24 +15,37 @@ will be created in this directory. The first run will produce a large number of error messages, nearly all beginning with "unresolved cross reference". These should gradually go away on later runs. The following shows the -error message output on the fifth run for A4 size printing: - -lout file "cpp_tabs" (from "cpp" line 80, from "all" line 45): - 56,23: prg2lout 2,1: program text ended within comment - 58,35: prg2lout 2,1: program text ended within comment - -These two warnings point to two places where a C program text ended -inside a comment, which in these cases was deliberate so is no problem. -If you set the document in Letter size paper, you will also get a -couple of other warning messages pointing to places where Lout had -to slightly scale a display to fit the smaller page. +error message output on the later runs for A4 size printing: + +lout file "str_indx" (from "str" line 15, from "all" line 37): + 43,1: 0.3c object too high for -0.0c space; will try elsewhere +lout file "typ_repo" (from "typ" line 19, from "all" line 38): + 38,1: 1.0c object too high for 0.2c space; will try elsewhere +lout file "dia_synt" (from "dia" line 49, from "all" line 44): + 79,1: 1.0c object too high for 0.8c space; will try elsewhere +lout file "prg_tabs" (from "prg" line 102, from "all" line 46): + 58,23: prg2lout 2,1: program text ended within comment + 60,35: prg2lout 2,1: program text ended within comment + +The first three warnings are about footnotes whose first lines did not +fit on the bottom of the current page, so had to begin on the following +page. The last two warnings point to two places where a C program text +ended inside a comment, which in these cases was deliberate. If you set +the document in Letter size paper, you will also get different warning +messages pointing to places where Lout had to slightly scale a display +to fit the smaller page: + +lout file "gra_summ" (from "gra" line 44, from "all" line 45): + 8,1: 23.6c object too high for 21.8c space; @Scale inserted +lout file "ap_qck" (from "all" line 48): + 158,25: 22.4c object too high for 21.9c space; @Scale inserted Optimal page breaking has been turned off for this document owing to 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.23.user.ps.gz". +stored at "ftp://ftp.cs.su.oz.au/jeff/lout/lout-3.24.user.ps.gz". Jeffrey H. Kingston -24 June 2000 +8 October 2000 diff --git a/doc/user/all b/doc/user/all index e0f239c..d38a47c 100644 --- a/doc/user/all +++ b/doc/user/all @@ -8,8 +8,8 @@ @SysInclude { cprint } @SysInclude { eiffel } @SysInclude { perl } -@SysInclude { book } -# @Include { letterbook } # for testing Letter size formatting +# @SysInclude { book } +@Include { letterbook } # for testing Letter size formatting @SysDatabase @Reference { loutrefs } @@ -21,8 +21,8 @@ Lout Document Formatting System } @Author { Jeffrey H. Kingston } - @Edition { Version 3.23 -June, 2000 } + @Edition { Version 3.24 +October, 2000 } @Publisher { Copyright @CopyRight 1991, 2000 Jeffrey H. Kingston, Basser Department of Computer Science, diff --git a/doc/user/preface b/doc/user/preface index 375999e..2b1c1b0 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.cs.usyd.edu.au/jeff/lout" in which may be found a gzipped tar file containing the main distribution -(currently {@Code "lout-3.23.tar.gz"}), and various other things including +(currently {@Code "lout-3.24.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_figs b/doc/user/str_figs index 285e097..154e355 100644 --- a/doc/user/str_figs +++ b/doc/user/str_figs @@ -145,7 +145,15 @@ together on one page or column (enclosing the body of the figure or table in @Code "@OneRow" would have the same effect except that it would not incorporate the caption, hence the need for this option). You need to be certain that the whole assembly will fit on one page when setting -@Code "@OnePage" to {@Code "Yes"}. +@Code "@OnePage" to {@Code "Yes"}. If it doesn't, Lout should warn you +with a message such as +@ID @Code "25.3c object too high for 23.4c space; will try elsewhere" +giving the size of the oversize object and the size of the space it +failed to fit into; but (unfortunately) it does not given a clear +indication of whether trying elsewhere succeeded or not. When you +see this message you need to check for yourself whether the figure was +actually printed or not; it may mean merely that the figure was put +back to a later page than the first possible one. @PP The @I default value of the @Code "@OnePage" option for each figure or table depends on the value of its @Code "@Location" option as follows: @@ -181,6 +189,16 @@ which is horizontally expanded (by the @Code "@HExpand" symbol, which is not specific to figures) to occupy the full width of the page or column, rather than fitting snugly around the figure. @PP +Although @Code "@CC" will always centre the figure or table, occasionally +it underestimates the amount of space available to centre in, and hence +the figure or table appears only partly centred, or even left +justified. This occurs when nothing on the page extends the full +width of the page. If this problem occurs, use +@ID @Code "@Format { @HExpand @CC @Body }" +The @Code "@HExpand" symbol expands the space available to the following +object to the maximum possible amount, so that the centring is with respect +to the full available width as desired. +@PP The @Code "@Format" option applies to just the body of the figure, not to its caption. It applies to each page or column of a multi-page or multi-column figure; for example, the above format will draw a box around |