Markup command documentation: categories and properties

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

diff --git a/Documentation/user/converters.itely b/Documentation/user/converters.itely
index 6178d9a52ebff74b135a810ae326081d54261fe9..17bc45a9a7876f28be3ba2b62caebca4d5ba04a4 100644 (file)
--- a/Documentation/user/converters.itely
+++ b/Documentation/user/converters.itely
@@ -1,5 +1,5 @@
 @c -*- coding: utf-8; mode: texinfo; -*-
 @c -*- coding: utf-8; mode: texinfo; -*-

-@c This file is part of lilypond.tely
+@c This file is part of lilypond-program.tely

 @ignore
     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
 
 @ignore
     Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
 


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

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


@@ -16,27 +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 lilypond itself, and are run
-on the command-line.  By @q{command-line}, we mean the command
-line in the operating system.  Windows users
-might be more familiar with the terms @q{DOS shell} or
-@q{command shell}; OSX users might be more familiar with the
-terms @q{terminal} or @q{console}.  OSX users should also
-consult @ref{Notes for the MacOS X app}.
-
-Describing how to use
-this part of an operating system is outside the scope of this
-manual; please consult other documentation on this topic if
-you are unfamiliar with the command-line.
+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 etf2ly::             Importing Finale.
-* Invoking musicxml2ly::        
+* Invoking musicxml2ly::        Importing MusicXML.

 * Invoking abc2ly::             Importing ABC.      
 * Invoking abc2ly::             Importing ABC.      

-* Generating LilyPond files::   
+* Invoking etf2ly::             Importing Finale.
+* Generating LilyPond files::   GUIs, transcribers, and algorithmic composition programs.

 @end menu
 
 
 @end menu
 
 


@@ -53,7 +49,7 @@ 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.
 
 @command{midi2ly} converts tracks into @internalsref{Staff} and
 direct format.
 
 @command{midi2ly} converts tracks into @internalsref{Staff} and


@@ -75,7 +71,7 @@ midi2ly [@var{option}]@dots{} @var{midi-file}
 @end example
 
 Note that by @q{command-line}, we mean the command line of the
 @end example
 
 Note that by @q{command-line}, we mean the command line of the

-operating system.  See @ref{Converting from other formats} for
+operating system.  See @ref{Converting from other formats}, for

 more information about this.
 
 The following options are supported by @command{midi2ly}.
 more information about this.
 
 The following options are supported by @command{midi2ly}.


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

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

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


@@ -121,63 +117,24 @@ 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}
-
-@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.
-
-It is invoked from the command-line as follows.
-
-@example
-etf2ly [@var{option}]@dots{} @var{etf-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{etf2ly}:
-
-@table @code
-@item -h,--help
-this help
-@item -o,--output=FILE
-set output filename to FILE
-@item -v,--version
-version information
-@end table
-
-
-@refbugs
-
-The list of articulation scripts is incomplete.  Empty measures
-confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.
-

 @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
+@uref{http://@/www.@/recordare@/.com/xml@/.html,MusicXML} is an XML dialect

 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.
 
 Note that by @q{command-line}, we mean the command line of the
 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.
 
 Note that by @q{command-line}, we mean the command line of the

-operating system.  See @ref{Converting from other formats} for
+operating system.  See @ref{Converting from other formats}, for

 more information about this.
 
 The following options are supported by @command{musicxml2ly}:
 more information about this.
 
 The following options are supported by @command{musicxml2ly}:


@@ -191,6 +148,7 @@ set output filename to @var{file}. (default: print to stdout)
 print version information.
 @end table
 
 print version information.
 @end table
 

+

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


@@ -199,7 +157,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@/.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:


@@ -239,7 +197,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.


@@ -252,6 +210,45 @@ 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 etf2ly
+@section Invoking @command{etf2ly}
+
+@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.
+
+It is invoked from the command-line as follows.
+
+@example
+etf2ly [@var{option}]@dots{} @var{etf-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{etf2ly}:
+
+@table @code
+@item -h,--help
+this help
+@item -o,--output=FILE
+set output filename to FILE
+@item -v,--version
+version information
+@end table
+
+
+@knownissues
+
+The list of articulation scripts is incomplete.  Empty measures
+confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.
+

 
 @node Generating LilyPond files
 @section Generating LilyPond files
 
 @node Generating LilyPond files
 @section Generating LilyPond files


@@ -263,7 +260,7 @@ 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