Re: Doc: improve doc on markup command writing (issue157133)

[nicolas . sceaux]

Thank you Ian for the careful review.

Nicolas



http://codereview.appspot.com/157133/diff/1/2
File Documentation/extending/programming-interface.itely (right):

http://codereview.appspot.com/157133/diff/1/2#newcode1045
Documentation/extending/programming-interface.itely:1045: The
@code{layout} and @code{props} arguments of markup commands bring a
On 2009/11/22 16:59:50, Ian Hulin wrote:
> The @code{layout} and @code{props} arguments to markup commands
provide a

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1046
Documentation/extending/programming-interface.itely:1046: context to the
markup interpretation: font size, line width, etc.
On 2009/11/22 16:59:50, Ian Hulin wrote:
> context for interpretation by the markup: e.g. font size line width
etc.

context for the markup interpretation
(it is the markup that is interpreted, to build a stencil).

http://codereview.appspot.com/157133/diff/1/2#newcode1048
Documentation/extending/programming-interface.itely:1048: Properties
defined in @code{paper} blocks are accessible through the
On 2009/11/22 16:59:50, Ian Hulin wrote:
> The @code{layout} argument allows access to properties defined in

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1049
Documentation/extending/programming-interface.itely:1049: @code{layout}
argument, using the @code{ly:output-def-lookup} function.
On 2009/11/22 16:59:50, Ian Hulin wrote:
> @code{paper} blocks, using the @code{ly:output-def-lookup} function.

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1060
Documentation/extending/programming-interface.itely:1060: title,
composer, etc.  It is also a way to configure a markup command
On 2009/11/22 16:59:50, Ian Hulin wrote:
> title, composer, etc.  It is also the way to configure the behaviour

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1061
Documentation/extending/programming-interface.itely:1061: behavior: when
a command uses e.g. the font size in its processings,
On 2009/11/22 16:59:50, Ian Hulin wrote:
> of a markup command: for example, when a command uses font size during
> processing,

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1062
Documentation/extending/programming-interface.itely:1062: instead of
having a @code{font-size} argument, the font size is read
On 2009/11/22 16:59:50, Ian Hulin wrote:
> the font size is read from @code{props} rather than having a
@code{font-size}

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1063
Documentation/extending/programming-interface.itely:1063: from
@code{props}, and the caller of a markup command may change the
On 2009/11/22 16:59:50, Ian Hulin wrote:
> argument.  The caller of a markup command may change the value

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1064
Documentation/extending/programming-interface.itely:1064: value of the
font size property to change the behavior. Property values
On 2009/11/22 16:59:50, Ian Hulin wrote:
> of the font size property in order to change the behaviour.  Use the

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1065
Documentation/extending/programming-interface.itely:1065: are read from
the @code{props} argument using the @code{chain-assoc-get}
On 2009/11/22 16:59:50, Ian Hulin wrote:
> @code{chain-assoc-get} function to read property values from the
@code{props} .

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1066
Documentation/extending/programming-interface.itely:1066: function.
On 2009/11/22 16:59:50, Ian Hulin wrote:
> argument.

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1074
Documentation/extending/programming-interface.itely:1074: As an example,
a markup command which draws a double box around a piece
On 2009/11/22 16:59:50, Ian Hulin wrote:
> The following example defines a markup command to draw a double box

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1075
Documentation/extending/programming-interface.itely:1075: of text will
be defined.
On 2009/11/22 16:59:50, Ian Hulin wrote:
> around a piece of text.

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1077
Documentation/extending/programming-interface.itely:1077: First, one
should try to build an approximative result using markups.
On 2009/11/22 16:59:50, Ian Hulin wrote:
> Firstly, we need to build an approximate result using markups.

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1078
Documentation/extending/programming-interface.itely:1078: By consulting
the builtin @ruser{Text markup commands}, we find that the
On 2009/11/22 16:59:50, Ian Hulin wrote:
> Consulting the @ruser{Text markup commands} shows us the

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1103
Documentation/extending/programming-interface.itely:1103: taking one
argument (the text), and draws the two boxes, with some
On 2009/11/22 16:59:50, Ian Hulin wrote:
> taking one argument (the text).  This draws the two boxes, with some

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1129
Documentation/extending/programming-interface.itely:1129: changed by the
user.  Moreover, it would be better to distinguish
On 2009/11/22 16:59:50, Ian Hulin wrote:
> changed by the user. Also, it would be better to distinguish

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1130
Documentation/extending/programming-interface.itely:1130: between the
padding between the two boxes, from the padding between the
On 2009/11/22 16:59:50, Ian Hulin wrote:
> the padding between the two boxes, from the padding between the

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1131
Documentation/extending/programming-interface.itely:1131: inner box and
the text.  We introduce a new property,
On 2009/11/22 16:59:50, Ian Hulin wrote:
> inner box and the text. So we will introduce a new property,

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1134
Documentation/extending/programming-interface.itely:1134: as follow:
On 2009/11/22 16:59:50, Ian Hulin wrote:
> now as follows:

Done.

http://codereview.appspot.com/157133/diff/1/2#newcode1152
Documentation/extending/programming-interface.itely:1152: the comma in
the @code{\override} argument: they allow to introduce a
On 2009/11/22 16:59:50, Ian Hulin wrote:
> the comma in the @code{\override} argument: they allow you to
introduce a

Done.

http://codereview.appspot.com/157133