#4582 Document tweaking of StaffSymbol and LedgerLineSpanner

[Simon Albrecht]

It regularly causes confusion that individual ledger line stacks can’t simply be tweaked. I think this should be documented better, but it isn’t easy to find the right place for that. I’d suggest the following:

In LM 4.1.2 http://lilypond.org/doc/v2.19/Documentation/learning/objects-and-interfaces, at the end of the fourth paragraph, (i.e. in Documentation/learning/tweaks.itely, at the end of line 108) insert
"Spanners cannot be tweaked after their creation. This includes @code{StaffSymbol} and @code{LedgerLineSpanner}, which both continue throughout the score except if they are terminated by @code{\stopStaff} and newly created using @code{\startStaff}."

Although perhaps the last half-sentence should be replaced by a reference to a more detailed explanation (necessary anyway), e.g. in NR 5.3.1 http://lilypond.org/doc/v2.19/Documentation/notation/overview-of-modifying-properties (or elsewhere in 5.3).

Another theoretical possibility, which I would deem most helpful to users who encounter the problem, would be a remark at the top of the IR page for LedgerLineSpanner. But unfortunately (?) that would require major changes in the build system, IIUC.

Should we mark this BLOCKEDON: Issue [#3949]?

[Trevor Daniels]

No, I don't think we need to make this blocked by Issue 3949

[Simon Albrecht]

Then a ‘Known issue’ should be added.

[Trevor Daniels]

Simon, I don't understand your remark about a 'Known issue'. I agreed with your suggestion to amend the docs, and changed the status of the issue from New to Accepted. Why do we need a 'known issue'?

[Simon Albrecht]

See issue 3949 (linked above). Using \stopStaff and \startStaff again at the same moment leaves a small gap inbetween. This and the workaround (with a hidden barline) by David should be included in a Known issue.

[Anonymous]

As there is a issue tracker for 3949, we can deal with the 'known issue' (if we need one as opposed to a snippet) there. For now I am just getting the information requested in this issue done.

[Anonymous]

Doc: LM - Document tweaking of StaffSymbol and LedgerLineSpanner

Issue 4582

Document tweaking of StaffSymbol
and LedgerLineSpanner.

Includes an @ruser to NR.

http://codereview.appspot.com/275490043

[Anonymous]

Passes make, make check and a full make doc.

[Anonymous]

Patch on countdown for December the 7th.

[Anonymous]

Patch counted down - please push.

[Anonymous]

author James Lowe pkx166h@gmail.com
Tue, 24 Nov 2015 18:55:21 +0000 (18:55 +0000)
committer James Lowe pkx166h@gmail.com
Mon, 7 Dec 2015 11:38:49 +0000 (11:38 +0000)
commit b6e323a2f6fdac2266a659acf6da008957f0c936

[Simon Albrecht]

It’s strange that I can’t find the commit via searching for the committish. But it is there: http://git.savannah.gnu.org/gitweb/?p=lilypond.git;a=commit;h=b6e323a2f6fdac2266a659acf6da008957f0c936. So – verified.

[David Kastrup]

That's a terrible reason to verify. The commit being in the repository just means that it was present at some point in the last three months in any branch. That's not verification.

However,

git log release/2.19.34-1..b6e323a2f6fdac2266a659acf6da008957f0c936

returns without either output or error, so the commit is indeed part of the tagged release. What did you try that failed to find the commit?

[Simon Albrecht]

I tried both http://philholmes.net/lilypond/git and http://git.savannah.gnu.org/gitweb/?p=lilypond.git&a=search&h=HEAD&st=commit&s=b6e323a2f6fdac2266a659acf6da008957f0c936, i.e. the search in the savannah web interface, top right.