Menu

#4761 Doc: NR - Issue 4761 - changing-defaults.itely: Various improvements

Verified
Documentation
2016-03-02
2016-02-01
No

While translating the 5th chapter of Notation Reference I found some minor errors or things to improve.
The last one is probably the most important to be fixed.

a) 5.1.1 Contexts explained
"""
DrumStaff

Handles typesetting for percussion. Can contain DrumVoice
"""

Missing trailing dot.

b) 5.2.3 Determining the grob property
"""
Inserting this command before the Fingering object is created, i.e., before c2, yields the following result:
"""

i.e., before c-2,

c) 5.2.4 Naming conventions
"""
scheme functions: lowercase-with-hyphens (incl. one-word names)
scheme functions: ly:plus-scheme-style
"""

isn't ly:plus-scheme-style a lilypond scheme function? (then different from the first item)

d) 5.3.5 \set vs. \override
"""
In contrast to ordinary context properties, grob definitions have the bookkeeping required to keep track of its parts, the individual grob properties (and even subproperties of them) separately so that it is possible to define those parts in different contexts and have the overall grob definition at the time of grob creation be assembled from pieces provided in different contexts among the current context and its parents.
"""

This sentence is too long and complex.

e) 5.4.1 Input modes
"""
To create fret diagrams above a staff, you have two choices. You can either use the FretBoards context (see Automatic fret diagrams or you can enter them...
"""

missing closing ) --> (see Automatic fret diagrams)

f) 5.4.2 Direction and placement
"""
For more information. See @ref{Multiple voices}.
"""

dot should be replaced with a comma: For more information, see...

g) 5.4.6 Spanners
"""
arrow

Setting this sub-property to #t produces an arrowhead at the end of the line.

"""

Shouldn'be more correct "at the end points of the line"? Because it depends
on the command used:
\override TextSpanner.bound-details.left.arrow = ##t
\override TextSpanner.bound-details.right.arrow = ##t

i) 5.4.7 Visibility of objects
"""
Double percent repeats are either all printed or all suppressed. Use begin-of line-invisible to print and all-invisible to suppress.
"""

--> begin-of-line-invisible (there's a space instead)

j) 5.5.3 Modifying the stencils
"""
Any of the glyphs in the feta Font can be supplied to the \musicglyph markup command
"""

feta Font --> Feta font

k) 5.5.6 unpure-pure containers
"""
In the first measure, without the unpure-pure container, the spacing engine does not know the width of the note head and lets it collide with the accidentals. In the second measure, with unpure-pure containers, the spacing engine knows the width of the note heads and avoids the collision by lengthening the line accordingly.
"""

The collision is present in version 2.16 of manuals, but it seems that LilyPond
is smart enough since version 2.18.
We should find another example of collision...

...

Discussion

  • Anonymous

    Anonymous - 2016-02-19

    Doc: NR - Issue 4761 - changing-defaults.itely: Various improvements

    A variety of nitpicks and
    improvements reported by
    Federico Bruni

    Some spelling corrections
    and typos fixed.

    The section on \set vs.
    \override has been
    edited in an attmpt to
    simplify the explanation
    for the reader.

    Fixed a couple of TODOs.

    Added a @c that references
    an open issue to improve
    the example for pure/unpure
    containers as the example no
    longer illustrates what it
    used to as of LP 2.17.x +

    http://codereview.appspot.com/290270043

     
    • Anonymous

      Anonymous - 2016-02-19

      Note that after I edited the para in the set vs unset section (as it confused Federico), the rest of the section jarred with the two obviously different writing styles. I therefore tried to 'comb' through the 4 or 5 paras of that section in an attempt to make the information flow more smoothly.

      I do not pretend to have more than a very basic level of understanding of contexts and grob properties, so if I have made the section completely inaccurate or have turned some of it into misleading non-sense, I apologise in advance.

       
  • Anonymous

    Anonymous - 2016-02-19
    • summary: several errors in NR chapter 5 --> Doc: NR - Issue 4761 - changing-defaults.itely: Various improvements
    • assigned_to: pkx166h
    • Needs: -->
    • Type: --> Documentation
     
  • Anonymous

    Anonymous - 2016-02-19
    • status: Accepted --> Started
     
  • Anonymous

    Anonymous - 2016-02-19
    • Patch: new --> review
     
  • Anonymous

    Anonymous - 2016-02-19

    Passes make, make check and a full make doc.

     
  • Anonymous

    Anonymous - 2016-02-21

    Patch Set 2 : With Jean-Charles M and Federico B's considerations and corrections addressed.

    http://codereview.appspot.com/290270043

     
  • Anonymous

    Anonymous - 2016-02-21
     
  • Anonymous

    Anonymous - 2016-02-21

    Passes make, make check and a full make doc.

     
  • Anonymous

    Anonymous - 2016-02-24

    Patch on countdown for Feb 27th.

     
  • Anonymous

    Anonymous - 2016-02-24
    • Patch: review --> countdown
     
  • Anonymous

    Anonymous - 2016-02-27
    • Patch: countdown --> push
     
  • Anonymous

    Anonymous - 2016-02-27

    Patch counted down - please push.

     
  • Anonymous

    Anonymous - 2016-02-28
    • labels: --> Fixed_2_19_37
    • status: Started --> Fixed
    • Patch: push -->
     
  • Anonymous

    Anonymous - 2016-02-28

    author James Lowe pkx166h@gmail.com
    Fri, 19 Feb 2016 11:54:25 +0000 (11:54 +0000)
    committer James Lowe pkx166h@gmail.com
    Sun, 28 Feb 2016 09:18:03 +0000 (09:18 +0000)
    commit 4299c96f609f79426a181ffed107d17fa6e1fdbd

     
  • Simon Albrecht

    Simon Albrecht - 2016-03-02
    • status: Fixed --> Verified
     
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.