diff options
author | Jeffrey H. Kingston <jeff@it.usyd.edu.au> | 2010-09-14 20:41:14 +0000 |
---|---|---|
committer | Jeffrey H. Kingston <jeff@it.usyd.edu.au> | 2010-09-14 20:41:14 +0000 |
commit | f7f41daa27e7ccff0aa184cc81e80b9c96e3d761 (patch) | |
tree | 3e81dfa2c263c20d7c9307a175b71ee6b7a5fd39 /doc/user/bgr_clip | |
parent | 26230a416563decd82a0af827c0987b8628c5ef9 (diff) | |
download | lout-f7f41daa27e7ccff0aa184cc81e80b9c96e3d761.tar.gz |
Lout 3.35.
git-svn-id: http://svn.savannah.nongnu.org/svn/lout/trunk@39 9365b830-b601-4143-9ba8-b4a8e2c3339c
Diffstat (limited to 'doc/user/bgr_clip')
-rw-r--r-- | doc/user/bgr_clip | 50 |
1 files changed, 50 insertions, 0 deletions
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 |