Issue 3799: New satb.ly built-in template and template framework

Issue 3799: New satb.ly built-in template and template framework

  Add kits as aids for providing built-in templates ("tkits")

  Replace the satb.ly template with one built from the tkits, which
  corrects some errors and extends the facilities:
    - fixes issue 4192
    - Women and Men one-voice staves added
    - Soprano and Tenor music may now be omitted without error
    - midi instruments may be specified
    - midi channel mapping is by instrument
    - midi instruments are by voice, not staff

[Trevor Daniels, 2015-04-07 10:49:56]

This patch is posted for comment and improvement rather than a candidate for
immediate inclusion in the code base.  Some caveats/issues/questions:

\includes are used for testing; later, perhaps after settling on the file names,
these may not be necessary.
 
Indenting is problematic, due to the heavy mixing of Scheme and Lily code.

base-tkit.ly is actually pure Scheme, and perhaps should be recast as
base-tkit.scm and located elsewhere.

There are no regression tests and no documentation at present.  These would need
to be added.

[Dan Eble, 2015-04-08 01:54:02]

To support TTBB, would you generalize this template further, or would you create
something new?

How about factoring out the parts that are used within a \score into their own
file so that they can be included many times in a multi-score book?

How about using the part combiner?  (That reminds me I have some work to do.)

How about supporting (to some extent) alternate lyrics above/below the staff for
the outer voices?

[Trevor Daniels, 2015-04-08 10:13:20]

message: On 2015/04/08 01:54:02, Dan Eble wrote:
Thanks for looking, Dan

> To support TTBB, would you generalize this template further, or would you
create
> something new?

My intention is to add an ssaattbb template once this patch has been installed. 
This would have three staves for each part: s1, s2 and s, etc, with separate
TwoVoicesPerStaff controls for each part.  This would make it easy to produce
TTBB or any other combination of doubled parts.

(Of course you could produce a TTBB score now, with satb.ly, by simply writing
SopranoMusic = TenorOneMusic, with SopranoInstrumentName = "Tenor 1", etc, but
that's a bit clunky.)
  
> How about factoring out the parts that are used within a \score into their own
> file so that they can be included many times in a multi-score book?

Now that's worth considering.  I'll look into that.  My reason for not providing
a score tkit in the present submission was the large number of parameters that
would need to be passed, and I didn't have a convincing use case, but you've
just suggested a better approach and a possible use case.

> How about using the part combiner?  (That reminds me I have some work to do.)

If you mean for the case when TwoVoicesPerStaff is true, it would make it
difficult to associate lyrics with voices.  If you mean for Women or Men voices
or for Piano accompaniment, then of course you can do this yourself within the
provided music, but again the lyric associations would be problematic.
 
> How about supporting (to some extent) alternate lyrics above/below the staff
for
> the outer voices?

I think this would be best accommodated in the future ssaattbb template I
mentioned above, since alternate lyrics usually implies split voices.

Trevor

[Dan Eble, 2015-04-08 22:16:57]

On 2015/04/08 10:13:20, Trevor Daniels wrote:
> message: On 2015/04/08 01:54:02, Dan Eble wrote:
> > How about using the part combiner?  (That reminds me I have some work to
do.)
> 
> If you mean for the case when TwoVoicesPerStaff is true, it would make it
> difficult to associate lyrics with voices.

That's what I mean.  NullVoice works around problems with part-combined lyrics. 
When I have time, I'll show you some stuff from my own templates.

[Dan Eble, 2015-04-09 08:16:30]

On 2015/04/08 22:16:57, Dan Eble wrote:
> When I have time, I'll show you some stuff from my own templates.

... which would be useless to you because I've still got partcombiner
modifications that are not in Lilypond yet.  Never mind.

[Dan Eble, 2015-04-10 11:02:10]

I should probably clarify for James not to take any of my suggestions as
objections.  I've really only glossed over the patch.

[Trevor Daniels, 2015-04-17 20:48:00]

Add regression tests, fix bugs, make improvements

[Trevor Daniels, 2015-04-17 21:03:18]

Patch set 2 contains a number of code improvements as well as four regression
tests and a (minimal) change to the documentation.  The main changes from patch
set 1 are:

- There is now a distinction between Women/Men music variables in their own
right and WomenDivided/MenDivided variables which are used when modifying the
instrument names and midi instruments associated with the two-voice staves.

- There is a distinction between prefixes and names which are hardwired into the
code, such as InstrumentName, Music, TwoVoicesPerStaff, etc and those which may
be modified or extended by the template.  The latter are defined in the template
itself, the former in base-tkit.ly.

I have not in this patch taken up Dan's suggestion to make a score-building
function, mainly because I have not yet found a way of doing this to my
satisfaction.  I'd like this now to be considered as a candidate for updating
the code base.

Trevor

[Trevor Daniels, 2015-04-18 10:40:25]

Fix incorrect regression test file name

[Trevor Daniels, 2015-04-18 15:30:06]

Fix file names of two more regression tests

[Trevor Daniels, 2015-04-18 15:33:37]

On 2015/04/18 15:30:06, Trevor Daniels wrote:
> Fix file names of two more regression tests

Sorry for the extra work James.  Three out of four regression tests had missing
hyphens!  Windows, perhaps unfortunately, is quite happy with file names
containing spaces, so I saw no errors here.

Trevor

[dak, 2015-04-21 19:58:34]

On 2015/04/17 21:03:18, Trevor Daniels wrote:
> Patch set 2 contains a number of code improvements as well as four regression
> tests and a (minimal) change to the documentation.  The main changes from
patch
> set 1 are:
> 
> - There is now a distinction between Women/Men music variables in their own
> right and WomenDivided/MenDivided variables which are used when modifying the
> instrument names and midi instruments associated with the two-voice staves.

Is Women/Men the correct nomenclature or would it rather be female/male [voice
types]?  As an alto I'd prefer the least sexist designation as long as it
matches typical usage.

[Trevor Daniels, 2015-04-21 22:51:49]

On 2015/04/21 19:58:34, dak wrote:
>
> Is Women/Men the correct nomenclature or would it rather be female/male [voice
> types]?  As an alto I'd prefer the least sexist designation as long as it
> matches typical usage.

"Men" is commonly seen in vocal scores, certainly in Oxford and Novello
publications.  "Women" is used rarely, but I have examples in an Oxford
publication.  Usually a change to the S/A line is written as S/A Unis or
similar above the staff, and the staff is left unnamed.  This can be done
easily by a user of the template if that is desired.

I've never seen female/male used, so I'd prefer to keep the names unchanged.

Trevor

[Trevor Daniels, 2015-04-24 10:31:25]

Pushed to staging as
14261eabcc7e9e653ee166b86f0371219fa0c54c

Author: Trevor Daniels <t.daniels@treda.co.uk>  2015-04-18 16:28:55
Committer: Trevor Daniels <t.daniels@treda.co.uk>  2015-04-24 11:25:23

     Issue 3799 : New satb.ly built-in template and template framework
    
      Add kits as aids for providing built-in templates ("tkits")
    
      Replace the satb.ly template with one built from the tkits, which
      corrects some errors and extends the facilities:
        - fixes issue 4192
        - \lyricsmode should be used; never \lyricsto
        - Women and Men one-voice staves added
        - Two-voice staves called MenDivided, WomenDivided
        - Soprano and Tenor music may now be omitted without error
        - midi instruments may be specified
        - midi channel mapping is by instrument
        - midi instruments are by voice, not staff
        - regression tests added
        - documentation minimally updated

Closing ...