From: Jean-Charles Malahieude Date: Sat, 15 Jun 2013 09:44:05 +0000 (+0200) Subject: Doc: Use @dots{} instead of ... in Extending X-Git-Tag: release/2.17.21-1~15^2~4 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=fc43a05568a1be2fc78bd7a16a42e474d239aac8;p=lilypond.git Doc: Use @dots{} instead of ... in Extending --- diff --git a/Documentation/extending/programming-interface.itely b/Documentation/extending/programming-interface.itely index b2b13cbbc8..3b5e147664 100644 --- a/Documentation/extending/programming-interface.itely +++ b/Documentation/extending/programming-interface.itely @@ -270,7 +270,7 @@ noPointAndClick = (parser location) () (ly:set-option 'point-and-click #f)) -... +@dots{} \noPointAndClick % disable point and click @end example @@ -635,11 +635,12 @@ Scheme-only solution. @multitable @columnfractions .3 .3 @item @b{LilyPond} @tab @b{Scheme} @item @code{\markup markup1} @tab @code{(markup markup1)} -@item @code{\markup @{ markup1 markup2 ... @}} @tab - @code{(markup markup1 markup2 ... )} +@item @code{\markup @{ markup1 markup2 @dots{} @}} @tab + @code{(markup markup1 markup2 @dots{} )} @item @code{\markup-command} @tab @code{#:markup-command} @item @code{\variable} @tab @code{variable} -@item @code{\center-column @{ ... @}} @tab @code{#:center-column ( ... )} +@item @code{\center-column @{ @dots{} @}} @tab + @code{#:center-column ( @dots{} )} @item @code{string} @tab @code{"string"} @item @code{#scheme-arg} @tab @code{scheme-arg} @end multitable @@ -726,11 +727,11 @@ New markup commands can be defined using the @code{define-markup-command} Scheme macro, at top-level. @lisp -(define-markup-command (@var{command-name} @var{layout} @var{props} @var{arg1} @var{arg2} ...) - (@var{arg1-type?} @var{arg2-type?} ...) +(define-markup-command (@var{command-name} @var{layout} @var{props} @var{arg1} @var{arg2} @dots{}) + (@var{arg1-type?} @var{arg2-type?} @dots{}) [ #:properties ((@var{property1} @var{default-value1}) - ...) ] - ..command body..) + @dots{}) ] + @dots{}command body@dots{}) @end lisp The arguments are @@ -949,7 +950,7 @@ follow (documentation stripped): (number-pair?) #:category graphic #:properties ((thickness 1)) - "..documentation.." + "@dots{}documentation@dots{}" (let ((th (* (ly:output-def-lookup layout 'line-thickness) thickness)) (x (car dest)) @@ -966,7 +967,7 @@ documentation, and is of no use for user-defined markup commands. (define-markup-command (draw-double-line layout props dest) (number-pair?) #:properties ((thickness 1)) - "..documentation.." + "@dots{}documentation@dots{}" (let ((th (* (ly:output-def-lookup layout 'line-thickness) thickness)) (x (car dest)) @@ -982,8 +983,8 @@ Then, a property for setting the gap between two lines is added, called (number-pair?) #:properties ((thickness 1) (line-gap 0.6)) - "..documentation.." - ... + "@dots{}documentation@dots{}" + @dots{} @end lisp Finally, the code for drawing two lines is added. Two calls to diff --git a/Documentation/extending/scheme-tutorial.itely b/Documentation/extending/scheme-tutorial.itely index f944a053e5..56cbd58b21 100644 --- a/Documentation/extending/scheme-tutorial.itely +++ b/Documentation/extending/scheme-tutorial.itely @@ -258,7 +258,7 @@ Scheme procedures @code{car} and @code{cdr}, respectively. @lisp guile> (define mypair (cons 123 "hello there") -... ) +@dots{} ) guile> (car mypair) 123 guile> (cdr mypair) @@ -574,7 +574,7 @@ statement in the let block: @lisp guile> (let ((x 2) (y 3) (z 4)) (display (+ x y)) (display (- z 4)) -... (+ (* x y) (/ z x))) +@dots{} (+ (* x y) (/ z x))) 508 @end lisp @@ -615,7 +615,7 @@ Another conditional procedure in scheme is @code{cond}: @example (cond (test-expression-1 result-expression-sequence-1) (test-expression-2 result-expression-sequence-2) - ... + @dots{} (test-expression-n result-expression-sequence-n)) @end example @@ -820,7 +820,7 @@ traLaLa = @{ c'4 d'4 @} is internally converted to a Scheme definition: @example -(define traLaLa @var{Scheme value of `@code{... }'}) +(define traLaLa @var{Scheme value of `@code{@dots{}}'}) @end example This means that LilyPond variables and Scheme variables may be freely @@ -862,7 +862,7 @@ Instead of defining @code{\twice}, the example above could also have been written as @example -... +@dots{} $(make-sequential-music newLa) @end example @@ -885,7 +885,7 @@ context. Using those, the last part of the example could have been written as @example -... +@dots{} @{ #@@newLa @} @end example @@ -905,7 +905,7 @@ If you need it to be executed at a later point of time, check out #(define (nopc) (ly:set-option 'point-and-click #f)) -... +@dots{} #(nopc) @{ c'4 @} @end example @@ -1166,12 +1166,12 @@ A bit of reformatting makes the above information easier to read: 'pitch (ly:make-pitch 0 0 0)))) @end example -A @code{@{ ... @}} music sequence has the name @code{SequentialMusic}, -and its inner expressions are stored as a list in its @code{'elements} -property. A note is represented as a @code{NoteEvent} object (storing -the duration and pitch properties) with attached information (in this -case, an @code{AbsoluteDynamicEvent} with a @code{"f"} text property) -stored in its @code{articulations} property. +A @code{@{ @dots{} @}} music sequence has the name +@code{SequentialMusic}, and its inner expressions are stored as a list +in its @code{'elements} property. A note is represented as a +@code{NoteEvent} object (storing the duration and pitch properties) with +attached information (in this case, an @code{AbsoluteDynamicEvent} with +a @code{"f"} text property) stored in its @code{articulations} property. @funindex{\void} @code{\displayMusic} returns the music it displays, so it will get @@ -1348,7 +1348,7 @@ function to add an articulation (like a fingering instruction) to a single note inside of a chord which is not possible if we just merge independent music. -A @code{$variable} inside the @code{#@{...#@}} notation is like +A @code{$variable} inside the @code{#@{@dots{}#@}} notation is like a regular @code{\variable} in classical LilyPond notation. We know that @@ -1420,7 +1420,7 @@ from its name. (this is good practice in other programming languages, too!) @example -"Add an accent..." +"Add an accent@dots{}" @end example @noindent