]> git.donarmstrong.com Git - lilypond.git/commitdiff
Doc: Issue 4168: Add 'Dimensions' to Useful concepts
authorTrevor Daniels <t.daniels@treda.co.uk>
Fri, 24 Oct 2014 13:50:48 +0000 (14:50 +0100)
committerTrevor Daniels <t.daniels@treda.co.uk>
Thu, 30 Oct 2014 22:13:28 +0000 (22:13 +0000)
Documentation/notation/changing-defaults.itely
Documentation/notation/text.itely

index 6d6b724cff20a1d7b6c745218af1cf12ef46b854..da68bf2a2b1f5f7e9f01daae20d0c70e9ce74f12 100644 (file)
@@ -2585,6 +2585,7 @@ modified by completely re-defining them as alists.}
 * Input modes::
 * Direction and placement::
 * Distances and measurements::
+* Dimensions::
 * Staff symbol properties::
 * Spanners::
 * Visibility of objects::
@@ -2844,6 +2845,35 @@ Notation Reference:
 @ref{Setting the staff size}.
 
 
+@node Dimensions
+@subsection Dimensions
+
+@cindex dimensions
+@cindex bounding box
+
+The dimensions of a graphical object specify the positions of the left
+and right edges and the bottom and top edges of the objects' bounding
+box as distances from the objects' reference point in units of
+staff-spaces.  These positions are usually coded as two Scheme pairs.
+For example, the text markup command @code{\with-dimensions} takes
+three arguments, the first two of which are a Scheme pair giving the
+left and right edge positions and a Scheme pair giving the bottom and
+top edge positions:
+
+@example
+\with-dimensions #'(-5 . 10) #'(-3 . 15) @var{arg}
+@end example
+
+This specifies a bounding box for @var{arg} with its left edge at -5,
+its right edge at 10, its bottom edge at -3 and its top edge at 15,
+all measured from the objects' reference point in units of
+staff-spaces.
+
+@seealso
+Notation Reference:
+@ref{Distances and measurements}.
+
+
 @node Staff symbol properties
 @subsection Staff symbol properties
 
index 739abbdf4956a1dd25d75fe6f1188b7b85e52f92..ac5436b94b6fcde8e9119c01396a6e4aef43f745 100644 (file)
@@ -1122,9 +1122,10 @@ An exhaustive list of graphics-specific commands can be found in
 
 @seealso
 Notation Reference:
-@ref{Graphic},
+@ref{Align},
+@ref{Dimensions},
 @ref{Editorial annotations},
-@ref{Align}.
+@ref{Graphic}.
 
 Installed Files:
 @file{scm/define-markup-commands.scm},