Menu

#5034 Fully document the short forms of the mode-changing commands

Verified
Documentation
2017-02-16
2017-01-19
No

Submitted by Thomas Morley (copied from Issue [#5032] ) :

Some general findings testing with:

\displayLilyMusic
<<
   \chords  { c1 }
   \chords { d }
>>

\displayLilyMusic
<<
   \lyrics { foo1 }
   \lyrics { bar }
>>

\displayLilyMusic
<<
   \drums { hh1 }
   \drums { bd }
>>

\displayLilyMusic
<<
   \figures { <6> }
   \figures { <7> }
>>

returning:

<< \new ChordNames { < c' e' g' >1 } \new ChordNames { < d' fis' a' >1 } >>
<< \lyrics { foo } \lyrics { bar } >>
<< \drums { hihat1 } \drums { bassdrum1 } >>
<< \figures { < 6 >1 } \figures { < 7 >1 } >>

This looks ok but inconsistent to me.
In NR I've found:
"\chords { … } is a shortcut notation for \new ChordNames { \chordmode { … } }"
"\figures{ … } is a shortcut notation for \new FiguredBass { \figuremode { … } }"
and
"The simplest way to enter percussion notes is to use the \drums command, which creates the correct context and entry mode for percussion"
Is there any reason for displayLilyMusic returning different?
\lyrics isn't explained at all, afaik.
I'd suggest to explain \drums at the lines of \chords and \figures.
\lyrics should be deprecated or documented properly as already said on Rietveld.

Related

Issues: #5032

Discussion

  • David Kastrup

    David Kastrup - 2017-01-19

    More like \new ChordNames \chordmode { ... } and \new FiguredBass \figuremode { ... }.

    Outputting stuff entered with \chordmode without it potentially loses information relevant to \ChordNames. Tricky decisions.

    All that aside, I think it is likely more educational never to use the shortcuts in \displayLilyMusic.

     
  • Trevor Daniels

    Trevor Daniels - 2017-01-20

    Doc: Issue 5034: Expand documentation of mode-changing commands

    Add general description of long and short forms and clarify
    wording generally.

    Add description of \lyrics

    Fix typos in chords and percussion

    http://codereview.appspot.com/313380043

     
  • Anonymous

    Anonymous - 2017-01-21
    • assigned_to: Trevor Daniels
    • Needs: -->
    • Patch: new --> review
    • Type: --> Documentation
     
  • Anonymous

    Anonymous - 2017-01-21

    Passes make, make check and a full make doc.

     
  • Trevor Daniels

    Trevor Daniels - 2017-01-22

    Respond to Harm's comments

    http://codereview.appspot.com/313380043

     
    • Trevor Daniels

      Trevor Daniels - 2017-01-22

      Trevor Daniels wrote Sunday, January 22, 2017 9:18 PM

      Respond to Harm's comments

      http://codereview.appspot.com/313380043

      Please ignore the incorrect changes above line c. 2000 in the delta from patch set 1. I uploaded a diff against the wrong base, and another of my patches to the same file has been included. The full diff is correct. Sorry.

      Trevor

       
  • Anonymous

    Anonymous - 2017-01-23
    • Needs: -->
    • Patch: new --> review
    • Type: --> Documentation
     
  • Anonymous

    Anonymous - 2017-01-23

    Passes make, make check and a full make doc.

     
  • Anonymous

    Anonymous - 2017-01-24
    • Patch: review --> countdown
     
  • Anonymous

    Anonymous - 2017-01-24

    Patch on countdow for Jan 27th.

     
  • Anonymous

    Anonymous - 2017-01-28
    • Patch: countdown --> push
     
  • Anonymous

    Anonymous - 2017-01-28

    Patch counted down - please push.

     
  • Trevor Daniels

    Trevor Daniels - 2017-01-28

    Pushed to Staging as
    553410afdd9496f7d9f1498e755ea18de8e70596

    Author: Trevor Daniels t.daniels@treda.co.uk 2017-01-22 21:14:35
    Committer: Trevor Daniels t.daniels@treda.co.uk 2017-01-28 21:32:03

    Doc: Issue 5034: Expand documentation of mode-changing commands
    
      Add general description of long and short forms and clarify
      wording generally.
    
      Add description of \lyrics
    
      Fix typos in chords and percussion
    
     
  • Trevor Daniels

    Trevor Daniels - 2017-01-28
    • labels: --> Fixed_2_19_55
    • status: Started --> Fixed
    • Patch: push -->
     
  • Federico Bruni

    Federico Bruni - 2017-02-16
    • status: Fixed --> Verified