diff options
Diffstat (limited to 'doc/expert')
| -rw-r--r-- | doc/expert/README | 2 | ||||
| -rw-r--r-- | doc/expert/all | 6 | ||||
| -rw-r--r-- | doc/expert/det_gall | 33 | ||||
| -rw-r--r-- | doc/expert/det_lexi | 11 | ||||
| -rw-r--r-- | doc/expert/det_size | 17 | ||||
| -rw-r--r-- | doc/expert/mydefs | 5 | ||||
| -rw-r--r-- | doc/expert/pre | 1 | ||||
| -rw-r--r-- | doc/expert/pre_outl | 21 | ||||
| -rw-r--r-- | doc/expert/pre_yuni | 9 | ||||
| -rw-r--r-- | doc/expert/preface | 2 |
10 files changed, 76 insertions, 31 deletions
diff --git a/doc/expert/README b/doc/expert/README index 9b9c3e0..d066d57 100644 --- a/doc/expert/README +++ b/doc/expert/README @@ -16,4 +16,4 @@ copy of the final outfile.ps is included. There should be no warning messages on the fifth run. Jeffrey H. Kingston -!7 September 1999 +26 February 2000 diff --git a/doc/expert/all b/doc/expert/all index 46471c0..e2a5a78 100644 --- a/doc/expert/all +++ b/doc/expert/all @@ -10,9 +10,9 @@ Lout Document Formatting System } @Author { Jeffrey H. Kingston } - @Edition { Version 3.17 -September, 1999 } - @Publisher { @I { @CopyRight Copyright 1991, 1999, Jeffrey + @Edition { Version 3.18 +February, 2000 } + @Publisher { @I { @CopyRight Copyright 1991, 2000, Jeffrey H. Kingston, Basser Department of Computer Science, The University of Sydney 2006, Australia.} } @InitialLanguage { English } diff --git a/doc/expert/det_gall b/doc/expert/det_gall index e68d58f..e5e6e99 100644 --- a/doc/expert/det_gall +++ b/doc/expert/det_gall @@ -325,24 +325,33 @@ enclose.sym @Index @@Enclose meaning: when components of the galley replace a @@Galley or @@ForceGalley symbol, that symbol is first replaced by @@Enclose @@Galley or @@Enclose @@ForceGalley. For example, -@ID @Code { -"def @Enclose" -" right x" -"{" -" @Box x" -"}" +@ID @Code @Verbatim { +def @Figure into @FigurePlace&&following + right @Body +{ + def @Enclose + right x + { + @Box x + } + + @Body +} } -within some galley definition causes each @@Galley or @@ForceGalley -symbol that receives components of the galley to be replaced by -{@Code "@Box @Galley"} or {@Code "@Box @ForceGalley"}, assuming an -appropriate definition of @Code "@Box". This is useful, for example, -when producing multi-page boxed displays, figures, and tables. +causes each @@Galley or @@ForceGalley symbol that receives components of +galley @Code "@Figure" to be replaced by {@Code "@Box @Galley"} or +{@Code "@Box @ForceGalley"}, assuming an appropriate definition of +@Code "@Box". This is useful, for example, when producing multi-page +boxed displays, figures, and tables. @PP An @@Enclose symbol may have only one parameter, which must be a right parameter. It would not make sense to allow more parameters, since there is no suitable value to assign to them. However, the @@Enclose symbol may contain inner definitions, and it may make use -of any symbol that is available at that point, in the usual way. +of any symbol that is available at that point, in the usual way. The +@@Enclose symbol may be a named parameter (itself with a right parameter) +of the galley symbol, rather than an inner definition as shown above, +if desired. @PP A @Code "following" galley may fail to find a first target lying in a following component of the same galley as its invocation point. This is diff --git a/doc/expert/det_lexi b/doc/expert/det_lexi index e0ad9f1..4f98875 100644 --- a/doc/expert/det_lexi +++ b/doc/expert/det_lexi @@ -98,6 +98,8 @@ do so. The complete list of predefined identifiers is @JL "@CurrFace" @JL "@CurrFamily" @JL "@CurrLang" + @JL "@CurrYUnit" + @JL "@CurrZUnit" @JL "@Database" @JL "@End" @JL "@Enclose" @@ -117,9 +119,9 @@ do so. The complete list of predefined identifiers is @JL "@HLimited" @JL "@HScale" @JL "@HShift" - @JL "@HSpan" } |4.4cx { - "@Include" + "@HSpan" + @JL "@Include" @JL "@IncludeGraphic" @JL "@Insert" @JL "@KernShrink" @@ -142,15 +144,16 @@ do so. The complete list of predefined identifiers is @JL "@OneRow" @JL "@Open" @JL "@Optimize" + @JL "@Outline" @JL "@PAdjust" @JL "@PageLabel" @JL "@PlainGraphic" @JL "@Plus" @JL "@PrependGraphic" @JL "@RawVerbatim" - @JL "@Rotate" } |4.4cx { - "@Rump" + "@Rotate" + @JL "@Rump" @JL "@Scale" @JL "@SetColor" @JL "@SetColour" diff --git a/doc/expert/det_size b/doc/expert/det_size index aea894b..56738ac 100644 --- a/doc/expert/det_size +++ b/doc/expert/det_size @@ -26,6 +26,7 @@ measurement (Section {@NumberOf yunit}); } (also defining the @Code v unit); } @ListItem { Whether to permit hyphenation or not; } @ListItem { What colour the object is to appear in; } +@ListItem { Whether @@Outline is in effect; } @ListItem { The language of the object; } @ListItem { Whether @@VAdjust, @@HAdjust and @@PAdjust are in effect. } @EndList @@ -34,16 +35,16 @@ document. For example, the style of a parameter depends on where it is used; the style of a galley is the style of the first target that it attempts to attach itself to. Of course, the style of any object can be changed by using the @@Font, @@Break, @@Space, @@SetColour or -@@SetColor, and @@Language symbols. +@@SetColor, @@Outline, and @@Language symbols. @PP There are no standard default values for style, except that small capitals -are initially off, the interpretation of white space is initially {@Code -lout}, and the values of the @Code y and @Code z units are zero. Therefore -one must ensure that the root galley or each of its components is enclosed -in @@Font, @@Break, @@SetColour or @@SetColor, and @@Language symbols. From -there the style is passed to incoming galleys and the objects within -them. Enclosure in @@Space is not required because the @Code "s" unit -is also set by @@Font (Section {@NumberOf space}). +and outlining are initially off, the interpretation of white space is +initially {@Code lout}, and the values of the @Code y and @Code z units +are zero. Therefore one must ensure that the root galley or each of its +components is enclosed in @@Font, @@Break, @@SetColour or @@SetColor, and +@@Language symbols. From there the style is passed to incoming galleys +and the objects within them. Enclosure in @@Space is not required because +the @Code "s" unit is also set by @@Font (Section {@NumberOf space}). @PP width. @Index { Width of an object } height. @Index { Height of an object } diff --git a/doc/expert/mydefs b/doc/expert/mydefs index e7f0d15..0a4d364 100644 --- a/doc/expert/mydefs +++ b/doc/expert/mydefs @@ -24,6 +24,8 @@ def @@CurrLang { @Code "@CurrLang" } def @@CurrFamily { @Code "@CurrFamily" } def @@CurrFace { @Code "@CurrFace" } + def @@CurrYUnit { @Code "@CurrYUnit" } + def @@CurrZUnit { @Code "@CurrZUnit" } def @@Database { @Code "@Database" } def @@End { @Code "@End" } def @@Enclose { @Code "@Enclose" } @@ -60,9 +62,10 @@ def @@OneOf { @Code "@OneOf" } def @@OneRow { @Code "@OneRow" } def @@Open { @Code "@Open" } + def @@Outline { @Code "@Outline" } def @@PAdjust { @Code "@PAdjust" } def @@PageLabel { @Code "@PageLabel" } - def @@PlainGraphic { @Code "@PlainGraphic" } + def @@PlainGraphic { @Code "@PlainGraphic" } def @@PrependGraphic { @Code "@PrependGraphic" } def @@RawVerbatim { @Code "@RawVerbatim" } def @@Rotate { @Code "@Rotate" } diff --git a/doc/expert/pre b/doc/expert/pre index 72a4fa3..02320cc 100644 --- a/doc/expert/pre +++ b/doc/expert/pre @@ -10,6 +10,7 @@ @Include { pre_spac } @Include { pre_yuni } @Include { pre_colo } +@Include { pre_outl } @Include { pre_lang } @Include { pre_oner } @Include { pre_wide } diff --git a/doc/expert/pre_outl b/doc/expert/pre_outl new file mode 100644 index 0000000..f62ec9f --- /dev/null +++ b/doc/expert/pre_outl @@ -0,0 +1,21 @@ +@Section + @Title { "@Outline" } + @Tag { outline } +@Begin +@PP +The @@Outline symbol +outline.sym @Index { @@Outline symbol } +causes all the words in the right parameter (which may be an +arbitrary object) to be printed in outline, rather than filled as +is usual. For example, +@ID @Code @Verbatim { @Outline @Box 24p @Font HELP } +produces +@ID @Outline @Box 24p @Font HELP +Outlining is part of the style information, in the same way as +colour, font, underlining, and so forth. Outlining can be applied +to any font likely to be used in practice. At the time of writing, +there is no way to control the thickness of the outline, and +@@Outline has no effect in PDF output. The size of outlined +words is taken by Lout to be the same as if they had not been +outlined, even though they are in reality slightly larger. +@End @Section diff --git a/doc/expert/pre_yuni b/doc/expert/pre_yuni index 7b06b5d..cd5dd17 100644 --- a/doc/expert/pre_yuni +++ b/doc/expert/pre_yuni @@ -1,5 +1,5 @@ @Section - @Title { "@YUnit" and "@ZUnit" } + @Title { "@YUnit", "@ZUnit", "@CurrYUnit", and "@CurrZUnit" } @Tag { yunit } @Begin @PP @@ -21,6 +21,13 @@ but it may begin with @Code "+" or @Code "-" to indicate that value is to be added to or subtracted from the current value. Any negative result of using @Code "-" will be silently replaced by zero. @PP +The @@CurrYUnit and @@CurrZUnit symbols report the value of the @Code y +and @Code z units, in points, truncated to the nearest integer. For example, +@ID @Code "1i @YUnit { The current value of the y unit is @CurrYUnit }" +produces +@ID @Code "1i @YUnit { The current value of the y unit is @CurrYUnit }" +since there are 72 points in one inch (at least, Lout thinks there are). +@PP These units are not used internally by Lout. They are supplied as part of the style information for the convenience of application packages. For example, the Eq equation formatting package uses them diff --git a/doc/expert/preface b/doc/expert/preface index 1150929..9e37913 100644 --- a/doc/expert/preface +++ b/doc/expert/preface @@ -21,7 +21,7 @@ This manual presents Version 3 of Basser Lout, publicly released in September 1994 @Cite { $kingston1995lout.program }. This manual was rendered into PostScript postscript @Index { PostScript } -by Version 3.17 of the Basser Lout interpreter, using the symbols +by Version 3.18 of the Basser Lout interpreter, using the symbols described in the User's Guide @Cite { $kingston1995lout.user }. @DP @Heading { Acknowledgment. } Version 3 has benefited from hundreds of |