diff options
Diffstat (limited to 'doc/user')
| -rw-r--r-- | doc/user/README | 4 | ||||
| -rw-r--r-- | doc/user/all | 4 | ||||
| -rw-r--r-- | doc/user/bas_unde | 28 | ||||
| -rw-r--r-- | doc/user/bgr | 1 | ||||
| -rw-r--r-- | doc/user/bgr_clip | 50 | ||||
| -rw-r--r-- | doc/user/bgr_incl | 11 | ||||
| -rw-r--r-- | doc/user/dia_link | 4 | ||||
| -rw-r--r-- | doc/user/dia_summ | 10 | ||||
| -rw-r--r-- | doc/user/preface | 2 | ||||
| -rw-r--r-- | doc/user/str_defs | 15 | ||||
| -rw-r--r-- | doc/user/vbgr | 3 |
11 files changed, 115 insertions, 17 deletions
diff --git a/doc/user/README b/doc/user/README index 932e3b2..5306c33 100644 --- a/doc/user/README +++ b/doc/user/README @@ -41,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.usyd.edu.au/jeff/lout/lout-3.34.user.ps.gz". +stored at "ftp://ftp.it.usyd.edu.au/jeff/lout/lout-3.35.user.ps.gz". Jeffrey H. Kingston -8 March 2007 +13 April 2007 diff --git a/doc/user/all b/doc/user/all index a018cd0..17726bd 100644 --- a/doc/user/all +++ b/doc/user/all @@ -22,8 +22,8 @@ Lout Document Formatting System } @Author { Jeffrey H. Kingston } - @Edition { Version 3.34 -March, 2007 } + @Edition { Version 3.35 +April, 2007 } @Publisher { Copyright @CopyRight 1991, 2007 Jeffrey H. Kingston, School of Information Technologies, diff --git a/doc/user/bas_unde b/doc/user/bas_unde index 9f7ea94..57bcc8a 100644 --- a/doc/user/bas_unde +++ b/doc/user/bas_unde @@ -24,4 +24,32 @@ underlined: how far below the baseline the line should be drawn, and how thick. The @Code "@Underline" symbol uses this information; the font it bases its underlining on is the font of the first object underlined if it is a word, or else the font of the enclosing paragraph. +@PP +The underline produced by @Code "@Underline" will have the same colour +as whatever is being underlined. If you want a different colour, you need +the @Code "@ColouredUnderline" or equivalently @Code "@ColoredUnderline" +symbol, which takes a colour on the left as well as the thing to be +underlined on the right: +@ID @OneRow @Code { +"This little paragraph of text will have" +"blue @ColouredUnderline { three underlined words } in it." +} +produces +@ID @OneRow 1.6i @Wide { +This little paragraph of text will have +blue @ColouredUnderline { three underlined words } in it. +} +The colours available are as for the @Code "@Colour" symbol from +Section {@NumberOf colour}. +@PP +There is no way to set a default value for the colour of a coloured +underline, but you can make it easy to get an underline of a specific +colour, by placing a definition at the start of your document, like this: +@ID @OneRow @Code @Verbatim { +import @BasicSetup +def @MustCheck right x { blue @ColouredUnderline x } +} +This allows you to type @Code "@MustCheck" instead of +{@Code "blue @ColouredUnderline"}. Definitions are explained in +general in Section {@NumberOf definitions}. @End @Section diff --git a/doc/user/bgr b/doc/user/bgr index 9646edb..66f4a2f 100644 --- a/doc/user/bgr +++ b/doc/user/bgr @@ -16,6 +16,7 @@ get them beyond the usual @Code "@SysInclude { doc }" or whatever. @Include { bgr_outl } @Include { bgr_rota } @Include { bgr_scal } +@Include { bgr_clip } @Include { bgr_mirr } @Include { bgr_incl } @Include { bgr_prec } diff --git a/doc/user/bgr_clip b/doc/user/bgr_clip new file mode 100644 index 0000000..696668a --- /dev/null +++ b/doc/user/bgr_clip @@ -0,0 +1,50 @@ +@Section + @Title { Clipping } + @Tag { clipping } +@Begin +@PP +The @Code "@HClip" symbol clips the following object horizontally to +the available width: +@ID @Code { +"@Box 1c @Wide @HClip WARNING!" +} +produces +@ID { +@Box 1c @Wide @HClip WARNING! +} +The following object may be arbitrary as usual; for example, it +could be an illustration included using @Code "@IncludeGraphic" +(Section {@NumberOf include}). +@PP +We have used the @Code "@Wide" symbol from Section {@NumberOf precise} +to make clear what the available width is in this small example (one +centimetre), but @Code "@HClip" will work in any context; for example, +you could use it to clip a table entry, or a display. +@PP +The @Code "@HClip" symbol has a @Code "shift" option which determines +which part of the clipped object is displayed. It may take on any +value between {@Code "0.0"}, meaning to display the leftmost part +(the default value), and {@Code "1.0"}, meaning to display the rightmost +part: +@ID @Code { +"@Box 1c @Wide @HClip shift { 1.0 } WARNING!" +} +produces +@ID { +@Box 1c @Wide @HClip shift { 1.0 } WARNING! +} +To display the central part, use shift value {@Code "0.5"}. Notice that +there is no unit of measurement attached to the value of {@Code "shift"}. +@PP +There is also a @Code "@VClip" symbol which works in exactly the same +way, only vertically. The two symbols combine together naturally: +@ID @Code { +"@Box 1c @Wide 0.2c @High @HClip @VClip WARNING!" +} +produces +@ID { +@Box 1c @Wide 0.2c @High @HClip @VClip WARNING! +} +The @Code "shift" options may be used as usual to determine which part of +the two-dimensional area is displayed. +@End @Section diff --git a/doc/user/bgr_incl b/doc/user/bgr_incl index 3b91070..bc54f4c 100644 --- a/doc/user/bgr_incl +++ b/doc/user/bgr_incl @@ -17,8 +17,8 @@ contains the University of Sydney crest. Then produces @ID @IncludeGraphic su_crest.eps In general, the result produced by @Code "@IncludeGraphic" is an object -that may be scaled, rotated, made into a display or placed within a -paragraph, just like any other object. Accolades for this remarkable +that may be scaled, clipped, rotated, made into a display or placed within +a paragraph, just like any other object. Accolades for this remarkable flexibility should go to the PostScript page description language, whose extraordinary power makes the provision of this feature in Lout almost trivial. @@ -72,4 +72,11 @@ Level 2 PostScript features which some older printers may not have, and it consumes a lot of memory in the printer. If memory runs out your job will not print properly, so use @Code "@IncludeGraphicRepeated" with caution. +@FootNote { +A test file using @Code "@IncludeGraphicRepeated" generated by the author +is currently (Version 3.35) being displayed correctly in two PostScript +viewers and converted to PDF correctly by the Unix @Code ps2pdf command. +This PDF file prints without any problems on the author's printer, but +the original PostScript file does not. +} @End @Section diff --git a/doc/user/dia_link b/doc/user/dia_link index fb44c8c..2c96a8c 100644 --- a/doc/user/dia_link +++ b/doc/user/dia_link @@ -275,6 +275,10 @@ of possible values for @Code "arrowstyle" is A { box } B { @Diag vstrut { no } { A:: @Circle |2c B:: @Circle // @Link from { A } to { B } arrow { yes } arrowstyle { box } } } +@Rowa + A { many } + B { @Diag vstrut { no } { A:: @Circle |2c B:: @Box + // @Link from { A } to { B } arrow { yes } arrowstyle { many } } } } The reader is invited to admire the beautifully sharp points on these arrowheads. diff --git a/doc/user/dia_summ b/doc/user/dia_summ index ad9f4ba..529c221 100644 --- a/doc/user/dia_summ +++ b/doc/user/dia_summ @@ -1335,8 +1335,9 @@ or {@Code both} } @Rowa A { " arrowstyle"} B { solid } - C { {@Code solid}, {@Code halfopen}, {@Code open}, {@Code curvedsolid}, -{@Code curvedhalfopen}, or {@Code curvedopen} } + C { {@Code solid}, {@Code solidwithbar}, {@Code halfopen}, {@Code open}, +{@Code curvedsolid}, {@Code curvedhalfopen}, {@Code curvedopen}, +{@Code circle}, {@Code box}, or {@Code many} } @Rowa A { " arrowwidth"} B { 0.3f } @@ -1348,8 +1349,9 @@ or {@Code both} } @Rowa A { " backarrowstyle"} B { solid } - C { {@Code solid}, {@Code halfopen}, {@Code open}, {@Code curvedsolid}, -{@Code curvedhalfopen}, or {@Code curvedopen} } + C { {@Code solid}, {@Code solidwithbar}, {@Code halfopen}, {@Code open}, +{@Code curvedsolid}, {@Code curvedhalfopen}, {@Code curvedopen}, +{@Code circle}, {@Code box}, or {@Code many} } @Rowa A { " backarrowwidth"} B { 0.3f } diff --git a/doc/user/preface b/doc/user/preface index b3a4466..4f9a212 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.34.tar.gz"}), and various other things including +(currently {@Code "lout-3.35.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_defs b/doc/user/str_defs index 71bd71e..42ea403 100644 --- a/doc/user/str_defs +++ b/doc/user/str_defs @@ -25,12 +25,15 @@ directory, containing definitions like this: "import @BasicSetup" "def @Batlow { Batlow Food Distributors Pty. Ltd. }" } -The meaning of the first line, {@Code "import @BasicSetup"}, will -be explained shortly. After that comes @Code "def" for `define,' -then the name of the symbol being defined, then its value between -braces. So this example defines a symbol called @Code "@Batlow" to -stand for the object following it between braces. Lout will read this -file during its setup phase (Section {@NumberOf setup}). +The meaning of the first line, {@Code "import @BasicSetup"}, will be +explained shortly. After that comes @Code "def" for `define,' then +the name of the symbol being defined, then its value between braces. +So this example defines a symbol called @Code "@Batlow" to stand for +the object following it between braces. Lout will read this file +during its setup phase (Section {@NumberOf setup}). Alternatively, you +can place definitions directly into your document files, following your +@Code "@SysInclude" lines and before {@Code "@Doc"}, {@Code "@Report"}, +or whatever symbol your document proper starts with. @PP Your symbols may have any names you wish made from letters and {@Code "@"}. However, it is good practice to have exactly one diff --git a/doc/user/vbgr b/doc/user/vbgr index 48f1466..be6461c 100644 --- a/doc/user/vbgr +++ b/doc/user/vbgr @@ -5,4 +5,7 @@ gvim bgr_boxs gvim bgr_outl gvim bgr_rota gvim bgr_scal +gvim bgr_clip +gvim bgr_mirr gvim bgr_incl +gvim bgr_prec |