Add two-parameter versions of @ruser etc. to allow specifying the displayed text

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

diff --git a/Documentation/user/converters.itely b/Documentation/user/converters.itely
index 5de5b53399745933f8f8e878a536f5ec5d40481e..f903d84f3e14074bd9e324f2dc090c8e45506da6 100644 (file)
--- a/Documentation/user/converters.itely
+++ b/Documentation/user/converters.itely
@@ -1,4 +1,13 @@
-@c -*- coding: latin-1; mode: texinfo; -*-
+@c -*- coding: utf-8; mode: texinfo; -*-
+@c This file is part of lilypond-program.tely
+@ignore
+    Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
+
+    When revising a translation, copy the HEAD committish of the
+    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


@@ -9,14 +18,21 @@ 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 @command{lilypond} itself, and are run
+on the command-line; see @ref{Command-line usage} for more information.

 
 
 
 

+@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.
+

 @menu
 * Invoking midi2ly::            Importing MIDI.
 @menu
 * Invoking midi2ly::            Importing MIDI.

+* Invoking musicxml2ly::        Importing MusicXML.
+* Invoking abc2ly::             Importing ABC.      

 * Invoking etf2ly::             Importing Finale.
 * Invoking etf2ly::             Importing Finale.

-* Invoking abc2ly::             Importing ABC.          
-* Invoking mup2ly::             Importing MUP. 
-* Generating LilyPond files::   
+* Generating LilyPond files::   GUIs, transcribers, and algorithmic composition programs.

 @end menu
 
 
 @end menu
 
 


@@ -33,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


@@ -54,6 +70,9 @@ It is invoked from the command-line as follows,
 midi2ly [@var{option}]@dots{} @var{midi-file}
 @end example
 
 midi2ly [@var{option}]@dots{} @var{midi-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.

 
 The following options are supported by @command{midi2ly}.
 
 
 The following options are supported by @command{midi2ly}.
 


@@ -73,7 +92,7 @@ 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

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

 
 @item -o, --output=@var{file}
 Write output to @var{file}.
 
 @item -o, --output=@var{file}
 Write output to @var{file}.


@@ -98,49 +117,38 @@ 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
 to a single duration and add phrase markings or pedal indicators.
 
 
 
 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
 to a single duration and add phrase markings or pedal indicators.
 
 

-@node Invoking etf2ly
-@section Invoking @command{etf2ly}
+@node Invoking musicxml2ly
+@section Invoking @code{musicxml2ly}

 
 

-@cindex ETF
-@cindex enigma
-@cindex Finale
-@cindex Coda Technology
+@uref{http://@/www.@/recordare@/.com/xml@/.html,MusicXML} is an XML dialect
+for representing music notation.

 
 

-ETF (Enigma Transport Format) is a format used by Coda Music
-Technology's Finale product.  @command{etf2ly} will convert part of an ETF
-file to a ready-to-use LilyPond file.
+@command{musicxml2ly} extracts the notes from part-wise MusicXML
+files, and writes it to a .ly file.  It is invoked from the command-line.

 
 

-It is invoked from the command-line as follows.
+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.

 
 

-@example
-etf2ly [@var{option}]@dots{} @var{etf-file}
-@end example
-
-The following options are supported by @command{etf2ly}:
+The following options are supported by @command{musicxml2ly}:

 
 @table @code
 @item -h,--help
 
 @table @code
 @item -h,--help

-this help
-@item -o,--output=FILE
-set output filename to FILE
+print usage and option summary.
+@item -o,--output=@var{file}
+set output filename to @var{file}. (default: print to stdout)

 @item -v,--version
 @item -v,--version

-version information
+print version information.

 @end table
 
 
 @end table
 
 

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

 @node Invoking abc2ly
 @section Invoking @code{abc2ly}
 
 @node Invoking abc2ly
 @section Invoking @code{abc2ly}
 


@@ -149,7 +157,7 @@ confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.
 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@/.gre@/.ac@/.uk/@/~c.walshaw/@/abc2mtex/@/abc@/.txt}.
+@uref{http://@/www@/.walshaw@/.plus@/.com/@/abc/@/abc2mtex/@/abc@/.txt}.

 @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:


@@ -176,7 +184,7 @@ source file.  If you say:
 %%LY voices \set autoBeaming = ##f
 @end example
 
 %%LY voices \set autoBeaming = ##f
 @end example
 

-This will cause the text following the keyword ``voices'' to be inserted 
+This will cause the text following the keyword @q{voices} to be inserted

 into the current voice of the LilyPond output file.
 
 Similarly,
 into the current voice of the LilyPond output file.
 
 Similarly,


@@ -185,14 +193,14 @@ Similarly,
 %%LY slyrics more words
 @end example
 
 %%LY slyrics more words
 @end example
 

-will cause the text following the ``slyrics'' keyword to be inserted
+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 ``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.

 
 Multiple tunes in one file cannot be converted.
 
 
 Multiple tunes in one file cannot be converted.
 


@@ -202,45 +210,44 @@ ABC synchronizes words and notes at the beginning of a line;
 @command{abc2ly} ignores the ABC beaming.
 
 
 @command{abc2ly} ignores the ABC beaming.
 
 

-@node Invoking mup2ly
-@section Invoking @command{mup2ly}
+@node Invoking etf2ly
+@section Invoking @command{etf2ly}

 
 

-Mup (Music Publisher) is a shareware music notation program by Arkkra
-Enterprises.  @command{mup2ly} will convert part of a Mup file to LilyPond
-format.  It is invoked from the command-line as follows:
+@cindex ETF
+@cindex enigma
+@cindex Finale
+@cindex Coda Technology
+
+ETF (Enigma Transport Format) is a format used by Coda Music
+Technology's Finale product.  @command{etf2ly} will convert part of an ETF
+file to a ready-to-use LilyPond file.

 
 

-@cindex Music Publisher
-@cindex Mup
-@cindex Arkkra
+It is invoked from the command-line as follows.

 
 @example
 
 @example

-mup2ly [@var{option}]@dots{} @var{mup-file}
+etf2ly [@var{option}]@dots{} @var{etf-file}

 @end example
 
 @end example
 

-The following options are supported by @command{mup2ly}:
+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.
+
+The following options are supported by @command{etf2ly}:

 
 @table @code
 
 @table @code

-@item -d,--debug
-show what constructs are not converted, but skipped.
-@item -D, --define=@var{name}[=@code{exp}]
-define macro @var{name} with opt expansion @code{exp}
-@item -E,--pre-process
-only run the pre-processor

 @item -h,--help
 @item -h,--help

-print help
-@item -o,--output=@var{file}
-write output to @var{file}
+this help
+@item -o,--output=FILE
+set output filename to FILE

 @item -v,--version
 version information
 @item -v,--version
 version information

-@item -w,--warranty
-print warranty and copyright. 

 @end table
 
 
 @end table
 
 

-@refbugs
+@knownissues

 
 

-Only plain notes (pitches, durations), voices, and staves are
-converted.
+The list of articulation scripts is incomplete.  Empty measures
+confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.

 
 
 @node Generating LilyPond files
 
 
 @node Generating LilyPond files


@@ -253,13 +260,15 @@ there are some external tools that also generate LilyPond files.
 
 These tools include
 
 
 These tools include
 

-@itemize @bullet
+@itemize

 @item
 @uref{http://@/denemo@/.sourceforge@/.net/,Denemo}, a graphical score editor.
 @item
 @item
 @uref{http://@/denemo@/.sourceforge@/.net/,Denemo}, a graphical score editor.
 @item

-@uref{http://www@/.volny@/.cz/smilauer/rumor/rumor@/.html,Rumor}, a realtime monophonic MIDI to LilyPond converter.
+@uref{http://www@/.volny@/.cz/smilauer/rumor/rumor@/.html,Rumor}, a realtime
+monophonic MIDI to LilyPond converter.

 @item
 @item

-@uref{http://nicolas@/.sceaux@/.free@/.fr/lilypond/lyqi@/.html,lyqi}, an Emacs major mode.
+@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@/.musicxml@/.com/xml@/.html,MusicXML}
 @item
 @uref{http://@/www@/.nongnu@/.org/@/xml2ly/, xml2ly}, which imports
 @uref{http://@/www@/.musicxml@/.com/xml@/.html,MusicXML}


@@ -269,5 +278,15 @@ which imports @uref{http://@/www@/.musicxml@/.com/xml@/.html,MusicXML}
 @item
 @uref{http://@/www@/.rosegardenmusic@/.com,Rosegarden},
 which imports MIDI
 @item
 @uref{http://@/www@/.rosegardenmusic@/.com,Rosegarden},
 which imports MIDI

+@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