From f1112707ee87532aa33cc13fbe51938be4e05f59 Mon Sep 17 00:00:00 2001 From: Martyn Jago Date: Tue, 22 Nov 2011 04:55:25 +0000 Subject: [PATCH] Revert ob-lilypond docs commit in an attempt to fix worg build --- org-contrib/babel/languages/ob-doc-lilypond.org | 186 ------------------------ 1 file changed, 186 deletions(-) delete mode 100644 org-contrib/babel/languages/ob-doc-lilypond.org diff --git a/org-contrib/babel/languages/ob-doc-lilypond.org b/org-contrib/babel/languages/ob-doc-lilypond.org deleted file mode 100644 index 0b68bd6..0000000 --- a/org-contrib/babel/languages/ob-doc-lilypond.org +++ /dev/null @@ -1,186 +0,0 @@ -#+OPTIONS: H:3 num:nil toc:2 \n:nil @:t ::t |:t ^:{} -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc -#+STARTUP: align fold nodlcheck hidestars oddeven lognotestate hideblocks -#+SEQ_TODO: TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@) -#+TAGS: Write(w) Update(u) Fix(f) Check(c) noexport(n) -#+TITLE: Org-babel-lilypond -#+AUTHOR: Martyn Jago -#+LANGUAGE: en -#+STYLE: - -#+begin_html -
-

- Org Babel support for - Lilypond (Score Engraving and Arrangement) -

-

- - - -

-
-#+end_html - -* Introduction - -An /Emacs Org Babel language/ - provided to allow [[http://lilypond.org][LilyPond]] Music Score generation, complete -with optional auditioning via Midi, whilst leveraging the full power of Org mode, and [[http://en.wikipedia.org/wiki/Literate_programming][Literate Programming]]. - -* Usage - -There are two modes available with ob-lilypond - - - *basic-mode* (default) - - - *arrange-mode* - -Which you use depends on what you intend to do. -(A quick way to switch modes is via `*M-x ly-toggle-arrange-mode*'). - -*basic-mode* (the default) allows you to embed LilyPond snippets into an org mode file, and -compile and export them using typical Org mode commands (such as *C-c -C-e d* for pdf export). This is useful if you want to mix -blocks of Lilypond-generated score with text, and perhaps other images for export to Latex, -Docbook, pdf, or HTML. In other words, *basic-mode* could be used as a -very flexible replacement to *lilypond-book*. - -*Warning!* in *basic-mode* a Lilypond source block requires to be passed - a *:file* parameter as shown below, as failure to do so will result - in an error message. - -: #+begin_src lilypond :file Mixolydian.png -: -: \relative c’ { -: g a b c d e f g f e d c b a g a b c d e f g f e d c b a g1 -: } - -The previous block will produce an image file in .png format, which -would be suitable for exporting to HTML for instance. See -[[file:../examples/lilypond-examples/html-example.org][html-example.org]] for a more complete example. - -To generate a nice image for embedding into a pdf or Latex document, -you might consider using the .eps format as shown in the example -below. - -: #+begin_src lilypond :file Mixolydian.eps -: -: \relative c’ { -: g a b c d e f g f e d c b a g a b c d e f g f e d c b a g1 -: } - -See [[file:../examples/lilypond-examples/pdf-example.org][pdf-example.org]] for a more complete example. - -* Examples - -Following are some examples generated in ob-lilypond Basic Mode... - - - [[file:../examples/lilypond-examples/html-example.org][and the org file]] that compiled the LilyPond snippets and exported - the HTML page (using the sequence *C-c C-e b*). - -* Compiling LilyPond Blocks -In *basic-mode* the key sequence *C-c C-c* within a Lilypond block -will compile the block. Exporting of all blocks and org file contents -is initialted with the sequence *C-c C-e* (standard org mode export keys). - -* Arrange Mode -*arrange-mode* allows you to develop complete pieces of score, whilst -organising sections of the piece using typical Org-mode techniques. And because -you are in Org-mode, you are free to use Literate Programming -techniques to generate things programatically - store information in -tables etc. - -In addition, there are automated features to automatically audition -the piece (via MIDI) and or display the resultant pdf output. - -To change the default mode to Arrange Mode, put the following in your emacs init file: - -: (setq ly-arrange-mode t) - -...or to temporarily switch between modes use the following command: - -: *M-x ly-toggle-arrange-mode* - -Following are examples generated using ob-lilypond in Arrange Mode... - - - [[file:../examples/lilypond-examples/modal-cycles.pdf][Modal Cycles (Utilises org-babel and noweb to generate notes)]] (pdf) - - [[file:../examples/lilypond-examples/modal-cycle.midi][Generated Midi File]] - - [[file:../examples/lilypond-examples/modal-cycle.org][Source Org File]] - - - [[file:../examples/lilypond-examples/modal-cycle-2.pdf][Modal Cycles 2 (Utilises org-babel and noweb to generate notes)]] (pdf) - - [[file:../examples/lilypond-examples/modal-cycle-2.midi][Generated Midi File]] - - [[file:../examples/lilypond-examples/modal-cycle-2.org][Source Org File]] - - [[file:../examples/lilypond-examples/arrange-mode/Modal-Cycle-2.mp3][A sound file produced with minor tinkering of the sounds triggered by the Lilypond-generated MIDI]] - - [[file:../examples/lilypond-examples/modes-in-key-of-c.pdf][Modes in the Key of C (another example of polyglot lilypond - programming)]] (pdf) - - [[file:../examples/lilypond-examples/modes-in-key-of-c.midi][Generated Midi File]] - - [[file:../examples/lilypond-examples/modes-in-key-of-c.org][Source Org File]] - -* Tangling and Compiling LilyPond Blocks -In *arrange-mode*, the key sequence *C-c C-c* within a Lilypond block -initiates `ly-tangle' (tangling of all Lilypond blocks within the -current Org file). Depending on the feature settings, ob-lilypond will -then either /display a pdf/ of the score, /play the generated MIDI -file/, both, or neither. - -The command *M-x ly-tangle* can also be called from anywhere in the file -and could be tied to a function key with something like... - -: (global-set-key [f8] 'ly-tangle) - -Some commands are included in arrange-mode to quickly enable / disable certain post-tangle -activities, including: - - - *ly-toggle-midi-play* (toggle whether midi will be played following a successful compilation) - - *ly-toggle-pdf-display* (toggle whether pdf will be displayed following a successful compilation) - -*NOTE:-* If using [[http://timidity.sourceforge.net/][Timidity]] for MIDI playback, kill the MIDI stream with C-g in Emacs - -* Setup -To use *ob-lilypond*, you must be on a *very recent* version of -org-mode, (since it relies on a command that has been changed very -recently) and will break on older versions (ob-lilypond is also -included in the latest Org-mode by default). - -For information on obtaining the latest org-mode follow this link -to the [[http://orgmode.org/manual/Installation.html][Org-mode Manual]] and follow the instructions. - -Then, add lilypond to your list of babel languages (in your init -file): - -: (org-babel-do-load-languages -: 'org-babel-load-languages -: '( -: (emacs-lisp . t) -: (sh t) -: (org t) -: (lilypond t))) - -Alternatively you may *require* the ob-lilypond babel language directly: - -: (require 'lilypond) - -To ensure all is correct consider *running the tests* (see below). - -* Requirements - -** Mac OS X - - LilyPond may be [[http://lilypond.org/][downloaded here]] - -** Nix - - LilyPond is [[http://lilypond.org/][available here]] or via the the system-relevant package manager. - - For MIDI, *Timidity* is [[http://timidity.sourceforge.net/][available here]] or via the system-relevant package manager. - - For pdf, *Evince* is [[http://live.gnome.org/Evince/Downloads][available here]] or via package manager. - -** Win32 - - Currently untested, although it should be made to work with minimal fuss. - -* Testing -Tests are provided and can be executed by running the following commands... -(for more help and information on testing see [[file:../../../org-tests/index.html][Testing Org]]. - -: M-x load-file RET testing/lisp/test-ob-lilypond.el -: M-x ert t - -* Issues -Any issues should be reported to the [[http://orgmode.org][Org-mode Mailing-list]] - -- 2.11.4.GIT