Export to GitHub

lilypond - issue #2791

[Doc]Inaccuracies in Learning manual, chapter 4


Posted on Aug 29, 2012 by Happy Rabbit

Reported by Federico Bruni: http://lists.gnu.org/archive/html/bug-lilypond/2012-08/msg00185.html

LM 4.2.1 states:

"This Slur page in the IR tells us first that Slur objects are created by the Slur_engraver. Then it lists the standard settings. Note these are not in alphabetic order."

Actually, they are in alphabetic order. Maybe something is changed since the LM was written?

In the same paragraph, section "Finding the context":

"At the very bottom it tells us that Slur_engraver is part of five Voice contexts, including the standard voice context, Voice, so our guess was correct."

Currently, there are seven Voice contexts.

Comment #1

Posted on Aug 30, 2012 by Massive Bear

I've also seen a typo in 4.2.2:

"Now we see all the user-settable properties which control fonts, including font-shape(symbol), where symbol can be set to upright, italics or caps."

italics should be italic

Comment #2

Posted on Aug 30, 2012 by Massive Bear

Another typo. LM 4.3.2, opening bracket is missing:

"Let us begin by looking again at the earlier example see Nesting music expressions) which showed how to introduce a new temporary staff, as in an ossia."

Comment #3

Posted on Aug 31, 2012 by Massive Bear

LM 4.4.3, section Dynamics:

"Dynamic markings will normally be positioned beneath the staff, but may be positioned above with the dynamicUp command"

I would follow the convention used in the rest of the manual and use the backslash before the command: \dynamicUp

Comment #4

Posted on Sep 5, 2012 by Happy Rabbit

Some more inaccuracies reported by Neil Sands, commented by Graham Percival: http://lists.gnu.org/archive/html/bug-lilypond/2012-09/msg00019.html

I hope this is the right place to point out some errors in the LilyPond Learning Manual.

Thanks for the feedback! Normally this would go to the bug-lilypond mailing list, which I've CC'd.

  1. http://lilypond.org/doc/v2.16/Documentation/learning/building-a-score-from- scratch

On this page, in the variable called 'ManualTwoMusic', we see the text 'e8~ ees16', which seems to mean an E tied to an E flat. A warning about an unterminated tie is given during the compilation process, and the score that results (and the example score in the docs) both show an E natural followed by an E flat at that point. So I think the tilde symbol ~ for the tie is just wrong here.

Yes, that looks like a typo.

  1. http://lilypond.org/doc/v2.16/Documentation/learning/fixing-overlapping- notation

In a few places on this page, we see this sort of thing: '{ e''8 e'' e'' e'' e'' e'' e'' e'' f''2 g'' }' when in the example score in the docs, we see a row of Es all in the same octave. When you compile the code given above, it puts each note up two octaves in relation to the last. The examples on this page are full of this kind of thing.

Hmm. Most examples use \relative c' as stated here: http://lilypond.org/doc/v2.16/Documentation/learning/omitted-material however, some examples use absolute note names. By default, if you write

{ c'4 } then it will be interpreted as written with absolute note names.

I personally wish that we had explicit \absolute{} for such cases, but it will be tricky to figure out exactly what to do about this.

  1. http://lilypond.org/doc/v2.16/Documentation/learning/style-sheets

In the code immediately under this text... 'Let’s copy the current ‘definitions.ily’ to ‘web-publish.ily’ and modify that. Since this music is aimed at producing a pdf which will be displayed on the screen, we’ll also increase the overall size of the output.' ... the first line of code has the comment '%%% definitions.ily', when actually it should be '%%% web-publish.ily' (as that's the name of the file people following the text have been instructed to edit).

That looks like the correct fix.

  1. http://lilypond.org/doc/v2.16/Documentation/learning/other-sources-of- information

In the GNU/Linux information, the path name INSTALLDIR/lilypond/usr/share/lilypond/current/ is given. In fact, it should begin INSTALLDIR/LilyPond/... (i.e. LilyPond in mixed case).

Hmm, are you sure? On my system, I see /lilypond/ address@hidden:~ $ ls .usr/lilypond/usr/ bin etc lib share var

Do you have it installed in /usr/local/ ? maybe it uses that capitalization when in /usr/local/ but not when it's in a different directory?

  • Graham

Comment #5

Posted on Sep 5, 2012 by Quick Bear

Re Graham's replies to me in Comment 4:

  1. I had forgotten all about the absolute pitches option. This is a document for novices, after all! If the \relative is sometimes going to be absent in this doc because the example uses absolute pitches, and other times it's absent because it's implied, and omitted only for brevity, there is scope for confusion with beginners. How can you tell the difference between it being absent and it being merely omitted?

  2. I got this completely wrong. Sorry for the false alarm. I withdraw my scandalous accusation.

Thanks folks Neil

Comment #6

Posted on Sep 8, 2012 by Massive Bear

Another typo in LM 4.3.1, section "color":

"Finally, there is also a grey scale available as part of the X11 set of colors. These range from black, 'grey0', to white, 'grey100, in steps of 1."

it should be 'grey0

Comment #7

Posted on Sep 8, 2012 by Massive Bear

A request: at the beginning of chapter 4.4.2 you may want to add a link to the section where \voiceOne was first introduced, that is 3.2.2 Explicitly instantiating voices

Comment #8

Posted on Sep 8, 2012 by Massive Bear

another typo:

4.4.3 The command to revert to the default behavior is \textLengthOff. Remember \once only works with \override, \set, \revert or unset, so cannot be used with \textLengthOn.

unset --> \unset

Comment #9

Posted on Sep 8, 2012 by Quick Kangaroo

@Comment 1. The LM is indicating the value of the parameters not what they look like (else why not say 'caps' should be in capitals?). This looks fine to me.

Comment #10

Posted on Sep 8, 2012 by Quick Kangaroo

Doc: Typos to LM - Fundamental and tweaks.itely

Issue 2791

Minor typos and clarifications.

Including an additional @ref{} and removal of (now) incorrect information.

http://codereview.appspot.com/6497103

Comment #11

Posted on Sep 8, 2012 by Quick Kangaroo

(No comment was entered for this change.)

Comment #12

Posted on Sep 9, 2012 by Massive Bear

I'm reviewing my translation and I found a sentence which doesn't sound good to me:

LM 4.1.3

"As we shall see shortly, the properties of different types of object are modified by different commands, so it is useful to be able to recognize the type of object from the names of its properties."

Actually, you can recognize the type of object or property from its own name "format". Yes, this is not quite accurate. I think it should be changed to:

"As we shall see shortly, the properties of different types of object are modified by different commands, so it is useful to be able to recognize the types of objects and properties from their names."

Comment #13

Posted on Sep 9, 2012 by Massive Bear

4.5.2, force-hshift property

"In the second chord we prefer the F to line up with the A and the lowest note to be positioned slightly right to avoid a collision of stems."

A should be A-flat.

I've completed my review of chapter 4, I won't bother you anymore ;-)

Comment #14

Posted on Sep 9, 2012 by Grumpy Dog

I've completed my review of chapter 4

Many thanks, Federico!

Comment #15

Posted on Sep 9, 2012 by Quick Kangaroo

Doc: Typos to LM - Fundamental and tweaks.itely

Issue 2791

Minor typos and clarifications.

Including an additional @ref{} and removal of (now) incorrect information.

http://codereview.appspot.com/6497103

Comment #16

Posted on Sep 9, 2012 by Quick Lion

Patchy the autobot says: passes tests.

Comment #17

Posted on Sep 10, 2012 by Happy Camel

(No comment was entered for this change.)

Comment #18

Posted on Sep 12, 2012 by Happy Camel

Counted down to 20120911, please push.

Comment #19

Posted on Sep 12, 2012 by Quick Kangaroo

(No comment was entered for this change.)

Comment #20

Posted on Sep 19, 2012 by Happy Wombat

(No comment was entered for this change.)

Comment #21

Posted on Sep 24, 2012 by Happy Camel

(No comment was entered for this change.)

Comment #22

Posted on Oct 19, 2012 by Quick Lion

Could people please remember to specify the commit id under which a patch has been pushed? And if they forgot, could the bug squad fix that omission when they verify the issue? They need to find the commit for that anyway.

This has apparently been pushed as commit 4c33251402e969f15fa796363fe646dff07b2798 Author: James Lowe Date: Sat Sep 8 19:22:06 2012 +0100

Doc: Typos to LM - Fundamental and tweaks.itely

Issue 2791

Minor typos and clarifications.

Including an additional @ref{} and removal of (now) incorrect
information.

Comment #23

Posted on Oct 19, 2012 by Quick Lion

Pushed to stable/2.16 as commit 6da27f9b294c385ff8fc75876e152d67f0b4794e Author: James Lowe Date: Sat Sep 8 19:22:06 2012 +0100

Doc: Typos to LM - Fundamental and tweaks.itely

Issue 2791

Minor typos and clarifications.

Including an additional @ref{} and removal of (now) incorrect
information.

Status: Verified

Labels:
Type-Documentation Fixed_2_17_3 Fixed_2_16_1