X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fprogramming-interface.itely;h=47d671b86f682930ede34550b40e0d8b3d8af273;hb=ca70c381bd4e926e704565d725406e88f80cc180;hp=537da3bc4e167f0b3dc614ec50c0a7c6e9fac3d3;hpb=c14fbcd481f9f637b2cfe8318ff818c01892214a;p=lilypond.git diff --git a/Documentation/user/programming-interface.itely b/Documentation/user/programming-interface.itely index 537da3bc4e..47d671b86f 100644 --- a/Documentation/user/programming-interface.itely +++ b/Documentation/user/programming-interface.itely @@ -7,6 +7,8 @@ version that you are working on. See TRANSLATION for details. @end ignore +@c \version "2.11.38" + @node Interfaces for programmers @chapter Interfaces for programmers @@ -230,7 +232,7 @@ turning off Point and Click). To do this, we return a @code{void} music expression. That is why the form -that is returned is the @code{(make-music ...)}. With the +that is returned is the @code{(make-music ...)}. With the @code{'void} property set to @code{#t}, the parser is told to actually disregard this returned music expression. Thus the important part of the void music function is the @@ -251,7 +253,7 @@ noPointAndClick = @subsection Functions without arguments In most cases a function without arguments should be written -with an identifier, +with an variable, @example dolce = \markup@{ \italic \bold dolce @} @@ -263,13 +265,13 @@ without arguments, @example displayBarNum = #(define-music-function (parser location) () - (if (eq? #t (ly:get-option display-bar-numbers)) + (if (eq? #t (ly:get-option 'display-bar-numbers)) #@{ \once \override Score.BarNumber #'break-visibility = ##f #@} #@{#@})) @end example To actually display bar numbers where this function is called, -invoke lilypond with +invoke @command{lilypond} with @example lilypond -d display-bar-numbers FILENAME.ly @@ -359,7 +361,7 @@ traLaLa = { c'4 d'4 } Due to parser lookahead In this example, the assignment happens after parser has verified that -nothing interesting happens after @code{traLaLa = @{ ... @}}. Without +nothing interesting happens after @code{traLaLa = @{ ... @}}. Without the dummy statement in the above example, the @code{newLa} definition is executed before @code{traLaLa} is defined, leading to a syntax error. @@ -389,9 +391,9 @@ define some Scheme code in a macro (to be called later), use @end example -@refbugs +@knownissues -Mixing Scheme and LilyPond identifiers is not possible with the +Mixing Scheme and LilyPond variables is not possible with the @code{--safe} option. @@ -404,12 +406,12 @@ it takes up time. Time is a rational number that measures the length of a piece of music in whole notes. A music object has three kinds of types: -@itemize @bullet +@itemize @item music name: Each music expression has a name. For example, a note leads to a @internalsref{NoteEvent}, and @code{\simultaneous} leads to a @internalsref{SimultaneousMusic}. A list of all expressions -available is in the Program reference manual, under +available is in the Internals Reference manual, under @internalsref{Music expressions}. @item @@ -417,7 +419,7 @@ available is in the Program reference manual, under interfaces, for example, a note is an @code{event}, but it is also a @code{note-event}, a @code{rhythmic-event}, and a @code{melodic-event}. All classes of music are listed in the -Program reference, under +Internals Reference, under @internalsref{Music classes}. @item @@ -589,7 +591,7 @@ d' @subsection Doubling a note with slurs (example) Suppose we want to create a function which translates -input like @samp{a} into @samp{a( a)}. We begin +input like @code{a} into @code{a( a)}. We begin by examining the internal representation of the music we want to end up with. @@ -895,7 +897,7 @@ useful when defining new markup commands (see @ref{New markup command definition}). -@refbugs +@knownissues The markup-list argument of commands such as @code{#:line}, @code{#:center}, and @code{#:column} cannot be a variable or @@ -1112,7 +1114,7 @@ to the @code{interpret-markup} function, with the @code{layout} and Note: there is now an internal command @code{\smallCaps} which can be used to set text in small caps. See -@ref{Overview of text markup commands}, for details. +@ref{Text markup commands}, for details. @node New markup list command definition @@ -1143,8 +1145,8 @@ First, the function gets the indent width, a property here named is not found, the default value is @code{2}. Then, a list of justified lines is made using the @code{make-justified-lines-markup-list} function, which is related to the @code{\justified-lines} -built-in markup list command. An horizontal space is added at the -begining using the @code{make-hspace-markup} function. Finally, the +built-in markup list command. An horizontal space is added at the +beginning using the @code{make-hspace-markup} function. Finally, the markup list is interpreted using the @code{interpret-markup-list} function. @@ -1159,8 +1161,8 @@ This new markup list command can be used as follows: @} \override-lines #'(par-indent . 4) \paragraph @{ The plate would be inked, the depressions caused by the cutting - and stamping would hold ink. An image was formed by pressing paper - to the plate. The stamping and cutting was completely done by + and stamping would hold ink. An image was formed by pressing paper + to the plate. The stamping and cutting was completely done by hand. @} @} @@ -1219,7 +1221,7 @@ where @var{proc} is a Scheme function, taking three arguments. When interpreted, the function @var{proc} is called for every layout object found in the context @var{context}, with the following arguments: -@itemize @bullet +@itemize @item the layout object itself, @item the context where the layout object was created, and @item the context where @code{\applyOutput} is processed. @@ -1299,8 +1301,8 @@ can be inserted with a grob closure. Here is a setting from @noindent In this example, both @code{ly:self-alignment-interface::x-aligned-on-self} and @code{ly:self-alignment-interface::centered-on-x-parent} are called -with the grob as argument. The results are added with the @code{+} -function. To ensure that this addition is properly executed, the whole +with the grob as argument. The results are added with the @code{+} +function. To ensure that this addition is properly executed, the whole thing is enclosed in @code{ly:make-simple-closure}. In fact, using a single procedure as property value is equivalent to