Lilypond-book: Implement musicxml support in lilypond-book

Lilypond-book: Implement musicxml support in lilypond-book

This patch adds support for including MusicXML files into 
documents processed by lilypond-book. In particular:
-) HTML: <musicxmlfile options>filename.xml</musicxmlfile>
-) TeX: \musicxmlfile[options]{filename.xml}
-) Texinfo: @musicxmlfile[options]{filename.xml}

Since MusicXML is so verbose, it doesn't make much sense to 
support inline MusicXML.

The snippets are first processed by musicxml2ly and then 
treated like a normal lilypond snippet in lilypond-book.
The only difference is that the original .xml file is linked
in the output rather than the intermediary .ly file.

I have mainly implemented this so that the MusicXML test 
suite can directly link to the .xml file files rather than the 
lilypond files, which are not relevant for xml anyway.

I have also extended lilypond-book to allow additional 
formatters, so the MusicXML test suite can override the 
formatting of the MusicXML snippets in the output (e.g. 
because I want to add some to other renderings in the future, 
too).

[Colin Campbell, 2011-06-25 19:32:49]

If this is still alive, Reinhold, I'd like to give it an entry on the issue
tracker.  I believe James or I could work with you on the documentation, as
well.

cheers,
Colin

[Reinhold, 2011-06-25 19:42:38]

On 2011/06/25 19:32:49, Colin Campbell wrote:
> If this is still alive, Reinhold, I'd like to give it an entry on the issue
> tracker.

Yes, it's still alive. I can't remember what issues I encountered back when I
wrote the patch, though. 

The purpose of this that you can then include musicxml files directly into
texinfo files without having to run musicxml2ly before that. The advantage is
that e.g. in the musicxml regtests (=homepage for my musicxml test suite) you
can then directly link to the .xml files allowing direct download of the
MusicXML files. Currently, all links go to the .ly files produced by
musicxml2ly, which somehow defeats the purpose...

>  I believe James or I could work with you on the documentation, as
> well.

That would be nice. It would only require extending the docs for lilypond-book
with those additional commands and their options.

Cheers,
Reinhold

[pkx166h, 2011-06-25 21:50:08]

On 2011/06/25 19:42:38, Reinhold wrote:
> On 2011/06/25 19:32:49, Colin Campbell wrote: 
> >  I believe James or I could work with you on the documentation, as
> > well.
> 
> That would be nice. It would only require extending the docs for lilypond-book
> with those additional commands and their options.

Could you give an example of (all) the syntax and very brief description - I'll
tidy it up - I can then construct something based on that for the Usage doc.

James

[Reinhold, 2011-06-25 22:01:05]

On 2011/06/25 21:50:08, J_lowe wrote:
> On 2011/06/25 19:42:38, Reinhold wrote:
> > On 2011/06/25 19:32:49, Colin Campbell wrote: 
> > >  I believe James or I could work with you on the documentation, as
> > > well.
> > 
> > That would be nice. It would only require extending the docs for
lilypond-book
> > with those additional commands and their options.
> 
> Could you give an example of (all) the syntax and very brief description -
I'll
> tidy it up - I can then construct something based on that for the Usage doc.

The patch is not yet finished. Once it is ready code-wise, I can tell you
more...

[lemzwerg, 2011-07-26 15:49:50]

LGTM (without testing).

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
File Documentation/usage/lilypond-book.itely (right):

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
Documentation/usage/lilypond-book.itely:207: @item the @code{\lilypond@{...@}}
command, where you can directly enter short lilypond code
Please stay within a width of 80 characters.

[pkx166h, 2011-07-26 21:38:00]

A few minor syntax and doc policy issues

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
File Documentation/usage/lilypond-book.itely (right):

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
Documentation/usage/lilypond-book.itely:206: @itemize @bullet
Please see Contributor's guide

5.3.6 Syntax survey

Lists

We don't use @bullet with @itemize.

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
Documentation/usage/lilypond-book.itely:207: @item the @code{\lilypond@{...@}}
command, where you can directly enter short lilypond code
On 2011/07/26 15:49:50, lemzwerg wrote:
> Please stay within a width of 80 characters.

80?

72 (preferably 66 - see 5.3.5 Text formatting in CG - also see @item in the
various sections)

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
Documentation/usage/lilypond-book.itely:226: @end example
I did this 

@example
...
@end example

or

@example
..
@end example

or

@example
...
@end example

Myself a few days ago on another section and Graham, quite rightly, said it was
unnecessary. Can we just use one single

@example
...
@end example for all of these?

[Reinhold, 2011-07-27 14:20:53]

Of course, all comments for the docs apply to HTML/LaTeX/Texinfo as well.

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
File Documentation/usage/lilypond-book.itely (right):

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
Documentation/usage/lilypond-book.itely:206: @itemize @bullet
On 2011/07/26 21:38:00, J_lowe wrote:
> We don't use @bullet with @itemize.

Okay, I don't know anything about docs formatting, so I usually copy things from
the same file. IN this case, the @bullet is copied from a few lines down (line
275 in the unmodified file). I'll remove it.

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
Documentation/usage/lilypond-book.itely:207: @item the @code{\lilypond@{...@}}
command, where you can directly enter short lilypond code
On 2011/07/26 21:38:00, J_lowe wrote:
> On 2011/07/26 15:49:50, lemzwerg wrote:
> > Please stay within a width of 80 characters.
> 
> 80?
> 
> 72 (preferably 66 - see 5.3.5 Text formatting in CG - also see @item in the
> various sections)

Yes, sorry. Plus, I should add the blank lines between the @items

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
Documentation/usage/lilypond-book.itely:226: @end example
On 2011/07/26 21:38:00, J_lowe wrote:
> I did this 
> Myself a few days ago on another section and Graham, quite rightly, said it
was
> unnecessary. Can we just use one single
> 
> @example
> ...
> @end example for all of these?

I have just added one more to the already existing list of @examples. How
exactly should the doc look with 1 @example?

[pkx166h, 2011-07-27 19:20:45]

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
File Documentation/usage/lilypond-book.itely (right):

http://codereview.appspot.com/1659041/diff/5001/Documentation/usage/lilypond-...
Documentation/usage/lilypond-book.itely:226: @end example
On 2011/07/27 14:20:57, Reinhold wrote:
> On 2011/07/26 21:38:00, J_lowe wrote:
> > I did this 
> > Myself a few days ago on another section and Graham, quite rightly, said it
> was
> > unnecessary. Can we just use one single
> > 
> > @example
> > ...
> > @end example for all of these?
> 
> I have just added one more to the already existing list of @examples. How
> exactly should the doc look with 1 @example?

Oh, sorry Reinhold. I got carried away :)

Well if it were me...I'd probably have edited them 'while I was about it' but
then again Doc is all I do.

So in that case.

LGTM

[Reinhold, 2011-08-10 17:16:55]

On 2011/07/26 21:38:00, J_lowe wrote:
> A few minor syntax and doc policy issues

I have now also changed the documentation and uploaded a new patch.

[pkx166h, 2011-08-10 21:38:49]

minor stuff.

http://codereview.appspot.com/1659041/diff/16001/Documentation/usage/lilypond...
File Documentation/usage/lilypond-book.itely (right):

http://codereview.appspot.com/1659041/diff/16001/Documentation/usage/lilypond...
Documentation/usage/lilypond-book.itely:225: In the input file, music is
specified with any of the following commands
Minor nitpick, I just noticed this needs a comma after the word 'command'. We
don't 'run into' the example any more. CG 5.3.7.

http://codereview.appspot.com/1659041/diff/16001/Documentation/usage/lilypond...
Documentation/usage/lilypond-book.itely:439: In the input file, music is
specified with any of the following commands
again a comma needed at the end of this phrase.

http://codereview.appspot.com/1659041/diff/16001/Documentation/usage/lilypond...
Documentation/usage/lilypond-book.itely:516: In the input file, music is
specified with any of the following commands
One more comma here too.

[Carl, 2011-08-10 21:47:15]

LGTM.  Thanks!

Carl

http://codereview.appspot.com/1659041/diff/16001/Documentation/usage/lilypond...
File Documentation/usage/lilypond-book.itely (right):

http://codereview.appspot.com/1659041/diff/16001/Documentation/usage/lilypond...
Documentation/usage/lilypond-book.itely:225: In the input file, music is
specified with any of the following commands
I think a colon is better than a comma in these situations.