]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/usage/external.itely
Merge branch 'lilypond/translation'
[lilypond.git] / Documentation / usage / external.itely
index b6b4ae5c636aae556575636ac6e2fc8bfd1b10be..584ce1d0076dc2860560f13bc906e562cab78e82 100644 (file)
@@ -4,16 +4,16 @@
     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.
+    version that you are working on.  For details, see the Contributors'
+    Guide, node Updating translation committishes..
 @end ignore
 
-@c \version "2.12.0"
+@c \version "2.13.36"
 
 @node External programs
 @chapter External programs
 
-FIXME: blah blah
-
+LilyPond can interact with other programs in various ways.
 
 @menu
 * Point and click::
@@ -38,18 +38,18 @@ file.  These hyperlinks are sent to the web-browser, which opens a
 text-editor with the cursor in the right place.
 
 To make this chain work, you should configure your PDF viewer to
-follow hyperlinks using the @file{lilypond-invoke-editor} script
+follow hyperlinks using the @file{lilypond@/-invoke@/-editor} script
 supplied with LilyPond.
 
 For Xpdf on UNIX, the following should be present in
 @file{xpdfrc}@footnote{On UNIX, this file is found either in
-@file{/etc/xpdfrc} or as @file{.xpdfrc} in your home directory.}
+@file{/@/etc/@/xpdfrc} or as @file{@/.xpdfrc} in your home directory.}
 
 @example
 urlCommand     "lilypond-invoke-editor %s"
 @end example
 
-The program @file{lilypond-invoke-editor} is a small helper
+The program @file{lilypond@/-invoke@/-editor} is a small helper
 program.  It will invoke an editor for the special @code{textedit}
 URIs, and run a web browser for others.  It tests the environment
 variable @code{EDITOR} for the following patterns,
@@ -98,7 +98,7 @@ off by issuing
 @end example
 
 @noindent
-in a @file{.ly} file.  Point and click may be explicitly enabled with
+in a @file{@/.ly} file.  Point and click may be explicitly enabled with
 
 @example
 \pointAndClickOn
@@ -135,21 +135,21 @@ There is support for different text editors for LilyPond.
 @node Emacs mode
 @unnumberedsubsec Emacs mode
 
-Emacs has a @file{lilypond-mode}, which provides keyword
+Emacs has a @file{lilypond@/-mode}, which provides keyword
 autocompletion, indentation, LilyPond specific parenthesis matching
 and syntax coloring, handy compile short-cuts and reading LilyPond
-manuals using Info.  If @file{lilypond-mode} is not installed on your
+manuals using Info.  If @file{lilypond@/-mode} is not installed on your
 platform, see below.
 
 An Emacs mode for entering music and running LilyPond is contained in
 the source archive in the @file{elisp} directory.  Do @command{make
-install} to install it to @var{elispdir}.  The file @file{lilypond-init.el}
-should be placed to @var{load-path}@file{/site-start.d/} or appended
-to your @file{~/.emacs} or @file{~/.emacs.el}.
+install} to install it to @var{elispdir}.  The file @file{lilypond@/-init@/.el}
+should be placed to @var{load-path}@file{/@/site@/-start@/.d/@/} or appended
+to your @file{@/~/@/@/.emacs} or @file{@/~/@/@/.emacs@/.el}.
 
-As a user, you may want add your source path (e.g. @file{~/site-lisp/}) to
+As a user, you may want add your source path (e.g. @file{@/~/@/site@/-lisp/@/}) to
 your @var{load-path} by appending the following line (as modified) to your
-@file{~/.emacs}
+@file{@/~/@/@/.emacs}
 
 @c any reason we do not advise:  (push "~/site-lisp" load-path)
 @example
@@ -160,39 +160,21 @@ your @var{load-path} by appending the following line (as modified) to your
 @node Vim mode
 @unnumberedsubsec Vim mode
 
-For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied,
-along with syntax coloring tools.  A Vim mode for entering music and
-running LilyPond is contained in the source archive in @code{$VIM}
-directory.
-
-The LilyPond file type is detected if the file
-@file{~/.vim/filetype.vim} has the following content
+For @uref{http://@/www@/.vim@/.org,Vim}, a filetype plugin, indent
+mode, and syntax-highlighting mode are available to use with
+LilyPond.  To enable all of these features, create (or modify)
+your @file{@/$HOME/@/@/.vimrc} to contain these three lines, in order:
 
 @example
-if exists("did_load_filetypes")
-  finish
-endif
-augroup filetypedetect
-  au! BufNewFile,BufRead *.ly,*.ily           setf lilypond
-augroup END
-@end example
-
-Please include this path by appending the following line to your
-@file{~/.vimrc}
-
-@example
-set runtimepath+=/usr/local/share/lilypond/$@{LILYPOND_VERSION@}/vim/
+filetype off
+set runtimepath+=/usr/local/share/lilypond/current/vim/
+filetype on
 @end example
 
 @noindent
-where $@{LILYPOND_VERSION@} is your LilyPond version.  If LilyPond was not
-installed in @file{/usr/local/}, then change this path accordingly.
-The path may differ significantly. In Fedora the path leads to the
-current version of Vim instead of Lilypond:
-
-@example
-set runtimepath+=/usr/share/vim/vim72/
-@end example
+If LilyPond is not installed in the @file{/@/usr/@/local/@/} directory,
+change the path appropriately.  This topic is discussed in
+@rlearning{Other sources of information}.
 
 
 @node Other editors
@@ -201,7 +183,7 @@ set runtimepath+=/usr/share/vim/vim72/
 Other editors (both text and graphical) support LilyPond, but
 their special configuration files are not distributed with
 LilyPond.  Consult their documentation for more information.  Such
-editors are listed in @rweb{Alternate editors}.
+editors are listed in @rweb{Easier editing}.
 
 
 @node Converting from other formats
@@ -255,7 +237,7 @@ 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
-then convert it to @file{.ly}.  However, human players are not
+then convert it to @file{@/.ly}.  However, human players are not
 rhythmically exact enough to make a MIDI to LY conversion trivial.
 When invoked with quantizing (@code{-s} and @code{-d} options)
 @command{midi2ly} tries to compensate for these timing errors, but is not
@@ -331,7 +313,7 @@ to a single duration and add phrase markings or pedal indicators.
 for representing music notation.
 
 @command{musicxml2ly} extracts the notes, articulations, score structure,
-lyrics, etc. from part-wise MusicXML files, and writes them to a .ly
+lyrics, etc. from part-wise MusicXML files, and writes them to a @file{@/.ly}
 file.  It is invoked from the command-line.
 
 
@@ -357,8 +339,7 @@ convert pitches in absolute mode.
 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.
+use LANG for pitch names, e.g. 'deutsch' for note names in German.
 
 @item --lxml
 use the lxml.etree Python package for XML-parsing; uses less memory and cpu time.
@@ -372,8 +353,8 @@ do not convert beaming information, use LilyPond's automatic
 beaming instead.
 
 @item -o,--output=@var{file}
-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
+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
@@ -508,7 +489,7 @@ confuse @command{etf2ly}.  Sequences of grace notes are ended improperly.
 
 LilyPond itself does not come with support for any other formats,
 but some external tools can also generate LilyPond files.  These
-are listed in @rweb{Alternate editors}.
+are listed in @rweb{Easier editing}.
 
 
 
@@ -578,7 +559,11 @@ lilypond -dbackend=eps -dno-gs-load-fonts -dinclude-eps-fonts --png myfile.ly
 @node Independent includes
 @section Independent @code{include}s
 
-FIXME: blah blah
+Some people have written large (and useful!) code that can be
+shared between projects.  This code might eventually make its way
+into LilyPond itself, but until that happens, you must download
+and @code{\include} them manually.
+
 
 @menu
 * MIDI articulation::
@@ -588,6 +573,27 @@ FIXME: blah blah
 @node MIDI articulation
 @subsection MIDI articulation
 
-stub for info about Dr. Peter Chubb's @file{articulate.ly}
+LilyPond can be used to produce MIDI output, for
+@qq{proof-hearing} what has been written.  However, only dynamics,
+explicit tempo markings, and the notes and durations themselves
+are produced in the output.
+
+The @emph{articulate} project is one attempt to get more of the
+information in the score into he MIDI.  It works by shortening
+notes not under slurs, to @q{articulate} the notes.  The amount of
+shortening depends on any articulation markings attached to a
+note: staccato halves the note value, tenuto gives a note its full
+duration, and so on.  The script also realises trills and turns,
+and could be extended to expand other ornaments such as mordents.
+
+@example
+@uref{http://@/www@/.nicta@/.com@/.au/@/people/@/chubbp/@/articulate}
+@end example
+
+@knownissues
+
+Its main limitation is that it can only affect things it knows
+about: anything that is merely textual markup (instead of a note
+property) is still ignored.