Fwd: 2.13.3 docs emacs mode documentation AU 2.2.1 out of date?

[Tim McNamara]

On Jul 25, 2009, at 1:56 AM, Paul Scott wrote:

> What I commented on is still the current online docs for the  
> developmental version:
>
> http://lilypond.org/doc/v2.13/Documentation/

Here is the entire text from 2.2.1 for lilypond-mode for Emacs:


***********************
2.2.1 Emacs mode

Emacs has a ‘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 ‘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 ‘elisp’ directory. Do make install to  
install it to elispdir. The file ‘lilypond-init.el’ should be placed  
to load-path‘/site-start.d/’ or appended to your ‘~/.emacs’ or  
‘~/.emacs.el’.

As a user, you may want add your source path (e.g. ‘~/site-lisp/’) to  
your load-path by appending the following line (as modified) to your  
‘~/.emacs’

    (setq load-path (append (list (expand-file-name "~/site-lisp"))  
load-path))

*********************

It *is* a bit terse and seems incomplete, and indeed differs from the  
discussion we just had in which Paul was given different instructions.

For example, from what directory does one do 'make install'?  This is  
not specified in 2.2.1.  There is a file 'GNUmakefile' inside the  
lilypond-mode directory inside the site-lisp directory on my  
computer, but it sounds as though Paul's did not include this.



Here is an alternative set of instructions, which may or may not work  
but has much more detail and might be worth comparing to those in 2.2.1:

http://www.geoffhorton.com/lilymacs.html

*********************

Use the following at your own risk. It worked for me. It might not  
for you.

First, your LilyPond distribution came with some files that emacs  
needs (or at least it should have come with them). Find files with  
the suffix .el in one of the LilyPond subdirectories. Copy them into  
emacs-nn.n/elisp, where "emacs-nn.n" is the directory into which you  
installed emacs.

Second, edit your .emacs file. (If you don't have one or don't know  
where it is, <Ctrl>-x <Ctrl>-f ~/.emacs will load it.) Add the  
following lines to it:

(autoload 'LilyPond-mode "lilypond-mode")
(setq auto-mode-alist
      (cons '("\\.ly$" . LilyPond-mode) auto-mode-alist))

(add-hook 'LilyPond-mode-hook (lambda () (turn-on-font-lock)))

While you're at it, prepare emacs to deal with UTF-8 characters (this  
will allow it to handle accented characters, the copyright symbol,  
and other unusual characters.) Add this to your .emacs file also:

(setq locale-coding-system 'utf-8)
(set-terminal-coding-system 'utf-8)
(set-keyboard-coding-system 'utf-8)
(set-selection-coding-system 'utf-8)
(prefer-coding-system 'utf-8)

Finally, you need to be able to enter those unusual characters. I  
recommend installing leim, which you can probably get from the same  
place you got emacs (and which may even have been installed with it).  
Download the leim file and unpack it into the directory where you  
installed emacs.

To turn leim on, type this: <Ctrl>-x <Ret>  <Ctrl>-\ TeX (note that  
case is significant). Once it's turned on, you can enter accented  
characters like this:

\"a produces ä

\'e produces é

\copyright produces ©

And so forth. Browsing leim/quail/latin-ltx.el will show you the  
whole list.

One drawback is that any use of a \ in LilyPond is likely to be (mis) 
interpreted by leim and mangled. Fortunately, it's easy to turn leim  
on and off once it's been activated. <Ctrl>-\ toggles it. Turn it on  
only when needed, and off again as soon as possible.

*****************************