From: David Kastrup Date: Sat, 25 Sep 2010 09:31:24 +0000 (+0200) Subject: programming-interface.itely: Bring some things more in line with doc standards X-Git-Tag: release/2.13.35-1~27 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=87a9977bbd54e3822338e290716845d8e2e304e3;p=lilypond.git programming-interface.itely: Bring some things more in line with doc standards --- diff --git a/Documentation/extending/programming-interface.itely b/Documentation/extending/programming-interface.itely index 6dec5b0d2a..59364e6ff2 100644 --- a/Documentation/extending/programming-interface.itely +++ b/Documentation/extending/programming-interface.itely @@ -111,7 +111,7 @@ Intermediate substitution functions involve a mix of Scheme code and LilyPond code in the music expression to be returned. Some @code{\override} commands require an argument consisting of -a pair of numbers (called a @code{cons cell} in Scheme). +a pair of numbers (called a @emph{cons cell} in Scheme). The pair can be directly passed into the music function, using a @code{pair?} variable: @@ -401,22 +401,22 @@ New markup commands can be defined using the The arguments are -@table @var -@item command-name +@table @code +@item @var{command-name} the markup command name @item layout the @q{layout} definition. @item props a list of associative lists, containing all active properties. -@item argi +@item @var{argi} @var{i}th command argument -@item argi-type? +@item @var{argi-type?} a type predicate for the i@var{th} argument @end table -If the command uses properties from the @var{props} arguments, the -@code{#:properties} keyword can be used to specify which properties are -used along with their default values. +If the command uses properties from the @code{props} arguments, +the @code{#:properties} keyword can be used to specify which +properties are used along with their default values. Arguments are distinguished according to their type: @itemize @@ -427,17 +427,19 @@ Arguments are distinguished according to their type: @code{list?}, @code{number?}, @code{boolean?}, etc. @end itemize -There is no limitation on the order of arguments (after the standard -@var{layout} and @var{props} arguments). However, markup functions -taking a markup as their last argument are somewhat special as you can -apply them to a markup list, and the result is a markup list where the -markup function (with the specified leading arguments) has been applied -to every element of the original markup list. +There is no limitation on the order of arguments (after the +standard @code{layout} and @code{props} arguments). However, +markup functions taking a markup as their last argument are +somewhat special as you can apply them to a markup list, and the +result is a markup list where the markup function (with the +specified leading arguments) has been applied to every element of +the original markup list. -Since replicating the leading arguments for applying a markup function -to a markup list is cheap mostly for Scheme arguments, you avoid -performance pitfalls by just using Scheme arguments for the leading -arguments of markup functions that take a markup as their last argument. +Since replicating the leading arguments for applying a markup +function to a markup list is cheap mostly for Scheme arguments, +you avoid performance pitfalls by just using Scheme arguments for +the leading arguments of markup functions that take a markup as +their last argument. @node On properties @unnumberedsubsubsec On properties @@ -726,10 +728,10 @@ syntax for this is \applyContext @var{function} @end example -@var{function} should be a Scheme function that takes a single -argument: the context in which the @code{\applyContext} command is -being called. The following code will print the current bar -number on the standard output during the compile: +@code{@var{function}} should be a Scheme function that takes a +single argument: the context in which the @code{\applyContext} +command is being called. The following code will print the +current bar number on the standard output during the compile: @example \applyContext @@ -756,11 +758,11 @@ works by inserting an event into the specified context @end example @noindent -where @var{proc} is a Scheme function, taking three arguments. +where @code{@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} at the current time step, with -the following arguments: +When interpreted, the function @code{@var{proc}} is called for +every layout object found in the context @code{@var{context}} at +the current time step, with the following arguments: @itemize @item the layout object itself, @item the context where the layout object was created, and