lilypond-user
[Top][All Lists]
Advanced
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: HTH w RTFM (Reading The Full Manual)

From: Jeff Olson
Subject: Re: HTH w RTFM (Reading The Full Manual)
Date: Thu, 5 Jan 2023 15:24:16 -0700
User-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.6.1
On 1/5/2023 4:04 AM, Martin Tarenskeen wrote:
Thanks Jeff,
this really helps!
Thanks, Martin.  Glad to hear that!

Attached are similar treatments for the smaller user docs:

   - LearningManual24-SectionChanges.html
   - UsageManual24-SectionChanges.html
   - ExtendingLilypond24-SectionChanges.html


Since I don't have a development environment to produce the machine generated documentation
source, there won't be similar output for the Internals Reference.

But there is one for the Contributor's Guide, which I'll send separately due to size.

Jeff

<< Back to Documentation Index

LilyPond — Learning Manual v2.24.0 (stable-branch).

Learning Manual — Section Changes in 2.24

This page highlights Sections of the Lilypond Learning Manual that are new in 2.24.0 or changed since 2.22.2. Of course, there is a separate official description of the Changes in 2.24 focusing on new features, but documentation can also include new explanations. The idea here is that you will gradually learn what's new through your usual browsing if you see which sections have changed in areas that interest you.

◀   Start your browsing on the left.   This is the usual table of contents except that it is fully expanded to show the hierarchy of all sections. Colors distinguish the New Sections and the Changed Sections. Font sizes show how big the changes are.   Links lead to the official documentation in another tab.

The panel below shows how many lines of Texinfo source were added, changed or deleted in each section that was modified. Sections with the most modifications are listed first. It also uses your browsing history to indicate which new/changed sections you still haven't visited, so you can use it as a reading checklist.
▼

See below for Details, Caveats, Tips and Old/Obsolete Sections
Track Your Progress
These New/Changed sections change color once you've visited them.
Lines(add,chg,del)                  Parent  >  Section
1.94NEW1. Installing  >  1.3 Graphical setup under macOS
2.79NEW1. Installing  >  1.1 Graphical setup under GNU/Linux
3.75NEW1. Installing  >  1.2 Graphical setup under Windows
4.64(1,6,57)5.4.3 Outside-staff objects  >  The outside-staff-priority property
5.46(38,2,6)2. Tutorial  >  2.1 Compiling a file
6.44(8,35,1)2.2.1 Simple notation  >  Pitches
7.43NEW1. Installing  >  1.4 Command line setup
8.41(14,27,0)2.2 How to write input files  >  2.2.2 Working on input files
9.39(11,27,1)3.3 Songs  >  3.3.2 Aligning lyrics to a melody
10.29(5,23,1)3.1.2 Pitches and key signatures  >  Warning: key signatures and pitches
11.28(14,14,0)3.2 Multiple notes at once  >  3.2.4 Combining notes into chords
12.26NEWLearning Manual  >  1. Installing
13.23(4,17,2)3.1.2 Pitches and key signatures  >  Pitch alterations
14.20(8,4,8)3.1.1 Bar lines and bar checks  >  Bar checks
15.16(2,14,0)3.4 Final touches  >  3.4.3 Absolute note names
16.14(0,10,4)2.4 How to read the manuals  >  2.4.3 Overview of manuals
17.14(0,14,0)3.4 Final touches  >  3.4.4 After the tutorial
18.14(0,1,13)4.3 Contexts and engravers  >  4.3.4 Modifying context properties
19.13(1,12,0)5.1 Tweaking basics  >  5.1.3 Naming conventions of objects and properties
20.12(1,7,4)3.2.1 Music expressions explained  >  Analogy: mathematical expressions
21.11(4,6,1)3.1.3 Ties and slurs  >  Warnings: slurs vs. ties
22.11(1,10,0)3.2 Multiple notes at once  >  3.2.2 Multiple staves
23.10(5,5,0)2.2.1 Simple notation  >  Durations (rhythms)
24.10(3,7,0)3.1.3 Ties and slurs  >  Ties
25.9(2,4,3)3.1.4 Articulations and dynamics  >  Dynamics
26.9(0,7,2)3.2 Multiple notes at once  >  3.2.3 Staff groups
27.9(3,6,0)3.3 Songs  >  3.3.1 Setting simple songs
28.8(3,4,1)2.2.1 Simple notation  >  All together
29.8(1,5,2)2.4 How to read the manuals  >  2.4.1 Omitted material
30.8(1,6,1)3.1 Single staff notation  >  3.1.5 Adding text
31.8(1,1,6)4.3 Contexts and engravers  >  4.3.2 Creating contexts
32.7(1,5,1)3.1.1 Bar lines and bar checks  >  Bar lines
33.7(2,4,1)3.1.4 Articulations and dynamics  >  Fingerings
34.7(2,4,1)3.2.1 Music expressions explained  >  Simultaneous music expressions: multiple staves
35.7(1,5,1)3.3 Songs  >  3.3.3 Lyrics to multiple staves
36.7(1,5,1)3.4 Final touches  >  3.4.1 Organizing pieces with variables
37.6(1,5,0)2.2.1 Simple notation  >  Clef
38.6(1,5,0)3.1.3 Ties and slurs  >  Slurs
39.6(1,4,1)3.1.3 Ties and slurs  >  Phrasing slurs
40.6(2,3,1)3.1.7 Advanced rhythmic commands  >  Partial measure
41.6(1,5,0)4.3 Contexts and engravers  >  4.3.5 Adding and removing engravers
42.5(3,1,1)3.1.2 Pitches and key signatures  >  Key signatures
43.5(2,2,1)3.1.4 Articulations and dynamics  >  Articulations
44.5(1,3,1)3.1 Single staff notation  >  3.1.6 Automatic and manual beams
45.5(3,1,1)3.1.7 Advanced rhythmic commands  >  Tuplets
46.5(2,1,2)3.1.7 Advanced rhythmic commands  >  Grace notes
47.5(1,4,0)3.2 Multiple notes at once  >  3.2.5 Single staff polyphony
48.5(0,5,0)4.4 Extending the templates  >  4.4.4 Saving typing with variables and functions
49.4(1,3,0)3.2 Multiple notes at once  >  3.2.1 Music expressions explained
50.4(0,1,3)5.7 Further tweaking  >  5.7.5 Advanced tweaks with Scheme
51.3(0,3,0)2.2 How to write input files  >  2.2.1 Simple notation
52.3(1,2,0)2.2.1 Simple notation  >  Rests
53.3(2,1,0)2.2.1 Simple notation  >  Time signature
54.3(2,1,0)2.2.1 Simple notation  >  Tempo marks
55.3(0,3,0)Learning Manual  >  3. Common notation
56.3(0,3,0)3. Common notation  >  3.2 Multiple notes at once
57.3(1,2,0)4.1 How LilyPond input files work  >  4.1.2 Score is a (single) compound musical _expression_
58.3(1,2,0)4.2 Voices contain music  >  4.2.1 I’m hearing Voices
59.3(1,2,0)4.3 Contexts and engravers  >  4.3.1 Contexts explained
60.3(0,3,0)5.3.1 Visibility and color of objects  >  The color property
61.2(1,0,1)2. Tutorial  >  2.3 Dealing with errors
62.2(2,0,0)2.4 How to read the manuals  >  2.4.2 Clickable examples
63.2(1,1,0)3.1 Single staff notation  >  3.1.2 Pitches and key signatures
64.2(1,1,0)3.1 Single staff notation  >  3.1.4 Articulations and dynamics
65.2(1,0,1)3.2.1 Music expressions explained  >  Simultaneous music expressions: single staff
66.2(1,1,0)4.2 Voices contain music  >  4.2.3 Voices and vocals
67.2(0,1,1)4.4 Extending the templates  >  4.4.5 Scores and parts
68.2(0,2,0)5.1.4 Tweaking methods  >  The \single prefix
 
Details
"How much is there to read in the Learning Manual?"
  • 176 total sections, averaging 66 lines each (totaling 11541 lines or ~206 pdf pages)
  • 5 New sections, averaging 63 lines each (totaling 317 lines or ~6 pdf pages)
  • 63 Changed* sections, averaging 11 modified lines each (totaling 672 lines or ~12 pdf pages)
  • in all,   ~39%   of the Learning Manual sections have been modified.
*  Not counting/highlighting 19 sections with only 1 modified line.
Top
 
Caveats
  • Documentation sections that are generated automatically by the lilypond build process (typically lists in an appendix) are not available to this analysis, which is based on static source files. Such sections are colored gray in the table of contents but brighten when hovered over.
  • Very large changes may be due to extensive reformatting without significant change in content.
  • Division of a huge section into a several subsections (e.g. by promoting simple headings into subsection declarations) may appear as a huge deletion in that section, followed by the addition of several large new subsections, even though only a few lines of source were changed. Consulting the "(add,chg,del)" statistics will reveal such cases.
  • Simple changes to the name of a section are usually detected, but more complex changes may cause a mismatch, causing those sections to be listed as New in the new release and Old/Obsolete in the old release. Check the list of Old/Obsolete section names if you suspect such a mismatch.
Top
 
Tips
  • Use your browser's "find in page" (e.g. "Ctrl-F") to search the fully expanded table of contents. All your matches will be highlighted until you do another search, making it easy to scroll or step through the results.
  • Searches will cover both the table of contents on the left and the main page on the right. So it's also a way to find the details on the right for sections you've found on the left.
  • Clicking on a link will bring up the official documentation for that section in another tab. Alternatively, you can usually right click to open in a new window, allowing you to still see the expanded table of contents in the original window as a visual guide.
Top
 
Old/Obsolete
"Wasn't there a section named ... ?"
  • These section names no longer appear in 2.24. Their contents might be included in other sections, but these names are gone.
  • Links lead to 2.22 so you can see what's missing.
1.1 Compiling a file  >  1.1.1 Entering input
1.1.1 Entering input  >  Producing output
1.1 Compiling a file  >  1.1.2 MacOS X
1.1 Compiling a file  >  1.1.3 Windows
1.1 Compiling a file  >  1.1.4 Command-line
4.1.4 Tweaking methods  >  The \overrideProperty command
Top
This unofficial page was generated for other Lilypond users by ly-mandiff.pl version 2023-01-01.

 

<< Back to Documentation Index

LilyPond — Usage v2.24.0 (stable-branch).

Usage Manual — Section Changes in 2.24

This page highlights Sections of the Lilypond Usage Manual that are new in 2.24.0 or changed since 2.22.2. Of course, there is a separate official description of the Changes in 2.24 focusing on new features, but documentation can also include new explanations. The idea here is that you will gradually learn what's new through your usual browsing if you see which sections have changed in areas that interest you.

◀   Start your browsing on the left.   This is the usual table of contents except that it is fully expanded to show the hierarchy of all sections. Colors distinguish the New Sections and the Changed Sections. Font sizes show how big the changes are.   Links lead to the official documentation in another tab.

The panel below shows how many lines of Texinfo source were added, changed or deleted in each section that was modified. Sections with the most modifications are listed first. It also uses your browsing history to indicate which new/changed sections you still haven't visited, so you can use it as a reading checklist.
▼

See below for Details, Caveats, Tips and Old/Obsolete Sections
Track Your Progress
These New/Changed sections change color once you've visited them.
Lines(add,chg,del)                  Parent  >  Section
1.137(21,18,98)1.2 Command-line usage  >  Advanced command line options for LilyPond
2.88(70,18,0)3. Running lilypond-book  >  3.3 Music fragment options
3.62(17,43,2)3. Running lilypond-book  >  3.4 Invoking lilypond-book
4.45(30,11,4)3. Running lilypond-book  >  3.1 An example of a musicological document
5.45(4,32,9)3.2 Integrating music and text  >  3.2.1 LaTeX
6.40(7,23,10)3.2 Integrating music and text  >  3.2.3 HTML
7.29(13,16,0)1.2 Command-line usage  >  Basic command line options for LilyPond
8.27(4,21,2)3.2 Integrating music and text  >  3.2.2 Texinfo
9.25(3,22,0)3.2 Integrating music and text  >  3.2.4 DocBook
10.8(3,5,0)1.4 Common errors  >  Warning this voice needs a \voiceXx or \shiftXx setting
11.8(1,7,0)4.1.1 Configuring the system  >  Using GNOME
12.6(0,4,2)4.1 Point and click  >  4.1.1 Configuring the system
13.5(0,3,2)5. Suggestions for writing files  >  5.5 Make and Makefiles
14.4(0,2,2)Usage Manual  >  3. Running lilypond-book
15.4(0,2,2)4. External programs  >  4.3 Converting from other formats
16.4(0,4,0)4.4 LilyPond output in other programs  >  4.4.1 LuaTeX
17.3(3,0,0)1.2 Command-line usage  >  Invoking lilypond
18.2(0,1,1)1. Running lilypond  >  1.2 Command-line usage
19.2(0,1,1)Relocation  >  Relocation files
20.2(0,2,0)1. Running lilypond  >  1.3 Error messages
21.2(1,1,0)3. Running lilypond-book  >  3.2 Integrating music and text
22.2(0,2,0)3. Running lilypond-book  >  3.5 Filename extensions
23.2(0,2,0)3. Running lilypond-book  >  3.7 Sharing the table of contents
24.2(0,2,0)5. Suggestions for writing files  >  5.2 Typesetting existing music
 
Details
"How much is there to read in the Usage Manual?"
  • 76 total sections, averaging 70 lines each (totaling 5336 lines or ~95 pdf pages)
  • no new sections found
  • 24 Changed* sections, averaging 23 modified lines each (totaling 554 lines or ~10 pdf pages)
  • in all,   ~32%   of the Usage Manual sections have been modified.
*  Not counting/highlighting 10 sections with only 1 modified line.
Top
 
Caveats
  • Documentation sections that are generated automatically by the lilypond build process (typically lists in an appendix) are not available to this analysis, which is based on static source files. Such sections are colored gray in the table of contents but brighten when hovered over.
  • Very large changes may be due to extensive reformatting without significant change in content.
  • Division of a huge section into a several subsections (e.g. by promoting simple headings into subsection declarations) may appear as a huge deletion in that section, followed by the addition of several large new subsections, even though only a few lines of source were changed. Consulting the "(add,chg,del)" statistics will reveal such cases.
  • Simple changes to the name of a section are usually detected, but more complex changes may cause a mismatch, causing those sections to be listed as New in the new release and Old/Obsolete in the old release. Check the list of Old/Obsolete section names if you suspect such a mismatch.
Top
 
Tips
  • Use your browser's "find in page" (e.g. "Ctrl-F") to search the fully expanded table of contents. All your matches will be highlighted until you do another search, making it easy to scroll or step through the results.
  • Searches will cover both the table of contents on the left and the main page on the right. So it's also a way to find the details on the right for sections you've found on the left.
  • Clicking on a link will bring up the official documentation for that section in another tab. Alternatively, you can usually right click to open in a new window, allowing you to still see the expanded table of contents in the original window as a visual guide.
Top
 
Old/Obsolete
"Wasn't there a section named ... ?"
  • These section names no longer appear in 2.24. Their contents might be included in other sections, but these names are gone.
  • Links lead to 2.22 so you can see what's missing.
4.1.1 Configuring the system  >  Using Xpdf
4.1.1 Configuring the system  >  Using GNOME 2
Top
This unofficial page was generated for other Lilypond users by ly-mandiff.pl version 2023-01-01.

 

<< Back to Documentation Index

LilyPond — Extending v2.24.0 (stable-branch).

Extending Lilypond — Section Changes in 2.24

This page highlights Sections of Extending Lilypond that are new in 2.24.0 or changed since 2.22.2. Of course, there is a separate official description of the Changes in 2.24 focusing on new features, but documentation can also include new explanations. The idea here is that you will gradually learn what's new through your usual browsing if you see which sections have changed in areas that interest you.

◀   Start your browsing on the left.   This is the usual table of contents except that it is fully expanded to show the hierarchy of all sections. Colors distinguish the New Sections and the Changed Sections. Font sizes show how big the changes are.   Links lead to the official documentation in another tab.

The panel below shows how many lines of Texinfo source were added, changed or deleted in each section that was modified. Sections with the most modifications are listed first. It also uses your browsing history to indicate which new/changed sections you still haven't visited, so you can use it as a reading checklist.
▼

See below for Details, Caveats, Tips and Old/Obsolete Sections
Track Your Progress
These New/Changed sections change color once you've visited them.
Lines(add,chg,del)                  Parent  >  Section
1.119NEW2. Interfaces for programmers  >  2.8 Unpure-pure containers
2.104NEW2.5.3 New markup command definition  >  Converting markups to strings
3.31NEW1.2 Scheme in LilyPond  >  1.2.3 Debugging Scheme code
4.15(2,6,7)2. Interfaces for programmers  >  2.9 Difficult tweaks
5.10(0,1,9)1.1 Introduction to Scheme  >  1.1.1 Scheme sandbox
6.7(0,6,1)1.3 Building complicated functions  >  1.3.4 Adding articulation to notes (example)
7.5(0,0,5)1.2 Scheme in LilyPond  >  1.2.5 Importing Scheme in LilyPond
8.3(0,3,0)Extending Lilypond  >  1. Scheme tutorial
9.3(3,0,0)2.3 Music functions  >  2.3.2 Music function usage
10.2(1,0,1)2.2 Scheme functions  >  2.2.1 Scheme function definitions
11.2(2,0,0)2.2 Scheme functions  >  2.2.2 Scheme function usage
12.2(0,2,0)2.5 Markup functions  >  2.5.1 Markup construction in Scheme
13.2(0,2,0)2.5.3 New markup command definition  >  On properties
 
Details
"How much is there to read in Extending Lilypond?"
  • 71 total sections, averaging 53 lines each (totaling 3735 lines or ~67 pdf pages)
  • 3 New sections, averaging 85 lines each (totaling 254 lines or ~5 pdf pages)
  • 10 Changed* sections, averaging 5 modified lines each (totaling 51 lines or ~1 pdf pages)
  • in all,   ~18%   of the Extending Lilypond sections have been modified.
*  Not counting/highlighting 10 sections with only 1 modified line.
Top
 
Caveats
  • Documentation sections that are generated automatically by the lilypond build process (typically lists in an appendix) are not available to this analysis, which is based on static source files. Such sections are colored gray in the table of contents but brighten when hovered over.
  • Very large changes may be due to extensive reformatting without significant change in content.
  • Division of a huge section into a several subsections (e.g. by promoting simple headings into subsection declarations) may appear as a huge deletion in that section, followed by the addition of several large new subsections, even though only a few lines of source were changed. Consulting the "(add,chg,del)" statistics will reveal such cases.
  • Simple changes to the name of a section are usually detected, but more complex changes may cause a mismatch, causing those sections to be listed as New in the new release and Old/Obsolete in the old release. Check the list of Old/Obsolete section names if you suspect such a mismatch.
Top
 
Tips
  • Use your browser's "find in page" (e.g. "Ctrl-F") to search the fully expanded table of contents. All your matches will be highlighted until you do another search, making it easy to scroll or step through the results.
  • Searches will cover both the table of contents on the left and the main page on the right. So it's also a way to find the details on the right for sections you've found on the left.
  • Clicking on a link will bring up the official documentation for that section in another tab. Alternatively, you can usually right click to open in a new window, allowing you to still see the expanded table of contents in the original window as a visual guide.
Top
 
Old/Obsolete
"Wasn't there a section named ... ?"
  • These section names no longer appear in 2.24. Their contents might be included in other sections, but these names are gone.
  • Links lead to 2.22 so you can see what's missing.
(no obsolete section names found)
Top
This unofficial page was generated for other Lilypond users by ly-mandiff.pl version 2023-01-01.

 
reply via email to
[Prev in Thread] Current Thread [Next in Thread]