Docs: add info about (not) translating "Compiling from source"

[lilypond.git] / Documentation / user / converters.itely

diff --git a/Documentation/user/converters.itely b/Documentation/user/converters.itely
index f843f2e9780089ef9a6af7e69005e899823168ff..b779ef42859eef00bab8407d4ebde6ae14e809cc 100644 (file)
--- a/Documentation/user/converters.itely
+++ b/Documentation/user/converters.itely
@@ -7,6 +7,8 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 

+@c \version "2.11.51"
+

 @node Converting from other formats
 @chapter Converting from other formats
 
 @node Converting from other formats
 @chapter Converting from other formats
 


@@ -16,11 +18,11 @@ There are other tools that produce LilyPond input, for example GUI
 sequencers and XML converters.  Refer to the
 @uref{http://@/lilypond@/.org,website} for more details.
 
 sequencers and XML converters.  Refer to the
 @uref{http://@/lilypond@/.org,website} for more details.
 

-These are separate programs from lilypond itself, and are run
+These are separate programs from @command{lilypond} itself, and are run

 on the command-line; see @ref{Command-line usage} for more information.
 
 
 on the command-line; see @ref{Command-line usage} for more information.
 
 

-@refbugs
+@knownissues

 We unfortunately do not have the resources to maintain these
 programs; please consider them @qq{as-is}.  Patches are appreciated, but
 bug reports will almost certainly not be resolved.
 We unfortunately do not have the resources to maintain these
 programs; please consider them @qq{as-is}.  Patches are appreciated, but
 bug reports will almost certainly not be resolved.


@@ -47,11 +49,11 @@ MIDI (Music Instrument Digital Interface) is a standard for digital
 instruments: it specifies cabling, a serial protocol and a file
 format.  The MIDI file format is a de facto standard format for
 exporting music from other programs, so this capability may come in
 instruments: it specifies cabling, a serial protocol and a file
 format.  The MIDI file format is a de facto standard format for
 exporting music from other programs, so this capability may come in

-useful when importing files from a program that has a convertor for a
+useful when importing files from a program that has a converter for a

 direct format.
 
 direct format.
 

-@command{midi2ly} converts tracks into @internalsref{Staff} and
-channels into @internalsref{Voice} contexts.  Relative mode is used
+@command{midi2ly} converts tracks into @rinternals{Staff} and
+channels into @rinternals{Voice} contexts.  Relative mode is used

 for pitches, durations are only written when necessary.
 
 It is possible to record a MIDI file using a digital keyboard, and
 for pitches, durations are only written when necessary.
 
 It is possible to record a MIDI file using a digital keyboard, and


@@ -90,21 +92,21 @@ Show summary of usage.
 @item -k, --key=@var{acc}[:@var{minor}]
 Set default key.  @math{@var{acc} > 0} sets number of sharps;
 @math{@var{acc} < 0} sets number of flats.  A minor key is indicated by
 @item -k, --key=@var{acc}[:@var{minor}]
 Set default key.  @math{@var{acc} > 0} sets number of sharps;
 @math{@var{acc} < 0} sets number of flats.  A minor key is indicated by

-@samp{:1}.
+@code{:1}.

 
 @item -o, --output=@var{file}
 Write output to @var{file}.
 
 @item -s, --start-quant=@var{DUR}
 
 @item -o, --output=@var{file}
 Write output to @var{file}.
 
 @item -s, --start-quant=@var{DUR}

-Quantize note starts on DUR.
+Quantize note starts on @var{DUR}.

 
 @item -t, --allow-tuplet=@var{DUR}*@var{NUM}/@var{DEN}
 Allow tuplet durations @var{DUR}*@var{NUM}/@var{DEN}.
 
 
 @item -t, --allow-tuplet=@var{DUR}*@var{NUM}/@var{DEN}
 Allow tuplet durations @var{DUR}*@var{NUM}/@var{DEN}.
 

-@item -V, --verbose
+@item -v, --verbose

 Be verbose.
 
 Be verbose.
 

-@item -v, --version
+@item -V, --version

 Print version number.
 
 @item -w, --warranty
 Print version number.
 
 @item -w, --warranty


@@ -115,7 +117,7 @@ Treat every text as a lyric.
 @end table
 
 
 @end table
 
 

-@refbugs
+@knownissues

 
 Overlapping notes in an arpeggio will not be correctly rendered.  The
 first note will be read and the others will be ignored.  Set them all
 
 Overlapping notes in an arpeggio will not be correctly rendered.  The
 first note will be read and the others will be ignored.  Set them all


@@ -125,25 +127,68 @@ to a single duration and add phrase markings or pedal indicators.
 @node Invoking musicxml2ly
 @section Invoking @code{musicxml2ly}
 
 @node Invoking musicxml2ly
 @section Invoking @code{musicxml2ly}
 

-@uref{http://@/www.@/recordarde@/.com/xml@/.html,MusicXML} is an XML dialect
+@cindex MusicXML
+
+@uref{http://@/www.@/musicxml@/.org/,MusicXML} is an XML dialect

 for representing music notation.
 
 for representing music notation.
 

-@command{musicxml2ly} extracts the notes from part-wise MusicXML
-files, and writes it to a .ly file.  It is invoked from the command-line.
+@command{musicxml2ly} extracts the notes, articulations, score structure,
+lyrics, etc. from part-wise MusicXML files, and writes them to a .ly
+file.  It is invoked from the command-line.
+
+
+It is invoked from the command-line as follows,
+@example
+musicxml2ly [@var{option}]@dots{} @var{xml-file}
+@end example

 
 Note that by @q{command-line}, we mean the command line of the
 operating system.  See @ref{Converting from other formats}, for
 more information about this.
 
 
 Note that by @q{command-line}, we mean the command line of the
 operating system.  See @ref{Converting from other formats}, for
 more information about this.
 

+If the given filename is @file{-}, @command{musicxml2ly} reads input 
+from the command line.
+

 The following options are supported by @command{musicxml2ly}:
 
 @table @code
 The following options are supported by @command{musicxml2ly}:
 
 @table @code

+@item -a, --absolute
+convert pitches in absolute mode.
+

 @item -h,--help
 print usage and option summary.
 @item -h,--help
 print usage and option summary.

+
+@item -l, --language=LANG
+use a different language file 'LANG.ly' and corresponding pitch names,
+e.g. 'deutsch' for deutsch.ly and German note names.
+
+@item --lxml
+use the lxml.etree Python package for XML-parsing; uses less memory and cpu time.
+
+@item --nd --no-articulation-directions
+do not convert directions (@code{^}, @code{_} or @code{-}) for
+articulations, dynamics, etc.
+
+@item --no-beaming
+do not convert beaming information, use LilyPond's automatic 
+beaming instead.
+

 @item -o,--output=@var{file}
 @item -o,--output=@var{file}

-set output filename to @var{file}. (default: print to stdout)
-@item -v,--version
+set output filename to @var{file}.  If @var{file} is @file{-}, the output
+will be printed on stdout.  If not given, @var{xml-file}@file{.ly} will
+be used.
+
+@item -r,--relative
+convert pitches in relative mode (default).
+
+@item -v,--verbose
+be verbose.
+
+@item --version

 print version information.
 print version information.

+
+@item -z,--compressed
+input file is a zip-compressed MusicXML file.

 @end table
 
 
 @end table
 
 


@@ -155,7 +200,7 @@ print version information.
 ABC is a fairly simple ASCII based format.  It is described at the ABC site:
 
 @quotation
 ABC is a fairly simple ASCII based format.  It is described at the ABC site:
 
 @quotation

-@uref{http://@/www@/.walshaw@/.plus@/.com/@/abc/@/abc2mtex/@/abc@/.txt}.
+@uref{http://@/www@/.walshaw@/.plus@/.com/@/abc/@/learn@/.html}.

 @end quotation
 
 @command{abc2ly} translates from ABC to LilyPond.  It is invoked as follows:
 @end quotation
 
 @command{abc2ly} translates from ABC to LilyPond.  It is invoked as follows:


@@ -167,11 +212,15 @@ abc2ly [@var{option}]@dots{} @var{abc-file}
 The following options are supported by @command{abc2ly}:
 
 @table @code
 The following options are supported by @command{abc2ly}:
 
 @table @code

+@item -b,--beams=None
+preserve ABC's notion of beams

 @item -h,--help
 this help
 @item -o,--output=@var{file}
 set output filename to @var{file}.
 @item -h,--help
 this help
 @item -o,--output=@var{file}
 set output filename to @var{file}.

-@item -v,--version
+@item -s,--strict
+be strict about success
+@item --version

 print version information.
 @end table
 
 print version information.
 @end table
 


@@ -195,7 +244,7 @@ will cause the text following the @q{slyrics} keyword to be inserted
 into the current line of lyrics.
 
 
 into the current line of lyrics.
 
 

-@refbugs
+@knownissues

 
 The ABC standard is not very @q{standard}.  For extended features
 (e.g., polyphonic music) different conventions exist.
 
 The ABC standard is not very @q{standard}.  For extended features
 (e.g., polyphonic music) different conventions exist.


@@ -235,14 +284,14 @@ The following options are supported by @command{etf2ly}:
 @table @code
 @item -h,--help
 this help
 @table @code
 @item -h,--help
 this help

-@item -o,--output=FILE
-set output filename to FILE
-@item -v,--version
+@item -o,--output=@var{FILE}
+set output filename to @var{FILE}
+@item --version

 version information
 @end table
 
 
 version information
 @end table
 
 

-@refbugs
+@knownissues

 
 The list of articulation scripts is incomplete.  Empty measures
 confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.
 
 The list of articulation scripts is incomplete.  Empty measures
 confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.


@@ -268,7 +317,7 @@ monophonic MIDI to LilyPond converter.
 @uref{http://nicolas@/.sceaux@/.free@/.fr/lilypond/lyqi@/.html,lyqi}, an
 Emacs major mode.
 @item
 @uref{http://nicolas@/.sceaux@/.free@/.fr/lilypond/lyqi@/.html,lyqi}, an
 Emacs major mode.
 @item

-@uref{http://@/www@/.nongnu@/.org/@/xml2ly/, xml2ly}, which imports
+@uref{http://@/www@/.nongnu@/.org/@/xml2ly/,xml2ly}, which imports

 @uref{http://@/www@/.musicxml@/.com/xml@/.html,MusicXML}
 @item
 @uref{http://@/noteedit@/.berlios@/.de,NoteEdit}
 @uref{http://@/www@/.musicxml@/.com/xml@/.html,MusicXML}
 @item
 @uref{http://@/noteedit@/.berlios@/.de,NoteEdit}


@@ -279,5 +328,12 @@ which imports MIDI
 @item
 @uref{http://@/common-lisp@/.net/project/fomus/,FOMUS},
 a LISP library to generate music notation 
 @item
 @uref{http://@/common-lisp@/.net/project/fomus/,FOMUS},
 a LISP library to generate music notation 

+@item
+@uref{http://vsr.informatik.tu-chemnitz.de/staff/jan/nted/nted.xhtml},
+has experimental export for LilyPond.
+@item
+@uref{http://www.tuxguitar.com.ar/}, can export to LilyPond.
+@item
+@uref{http://musescore.org} can also export to LilyPond.

 @end itemize
 
 @end itemize