From 3357772d4e9da87c1bcd99855d9b4055f590c806 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Sun, 4 Oct 2009 13:02:23 +0100 Subject: [PATCH] Doc: add Extending manual. --- Documentation/GNUmakefile | 5 +- Documentation/extending.tely | 71 +++++++++++++++++++ Documentation/extending/GNUmakefile | 7 ++ .../scheme-tutorial.itely | 6 +- 4 files changed, 84 insertions(+), 5 deletions(-) create mode 100644 Documentation/extending.tely create mode 100644 Documentation/extending/GNUmakefile rename Documentation/{learning => extending}/scheme-tutorial.itely (98%) diff --git a/Documentation/GNUmakefile b/Documentation/GNUmakefile index d748db860a..9d3928558d 100644 --- a/Documentation/GNUmakefile +++ b/Documentation/GNUmakefile @@ -9,7 +9,8 @@ depth = .. NAME = documentation LANGS = $(shell $(PYTHON) $(top-src-dir)/python/langdefs.py) -MANUALS_SUBDIRS = usage automated-engraving contributor essay general learning notation +MANUALS_SUBDIRS = usage automated-engraving contributor essay \ + general learning notation extending SUBDIRS = $(MANUALS_SUBDIRS) snippets logo pictures misc po css topdocs $(LANGS) STEPMAKE_TEMPLATES = documentation texinfo tex omf LOCALSTEPMAKE_TEMPLATES = lilypond ly @@ -74,7 +75,7 @@ OUT_HTML_FILES += $(HTML_PAGE_NAMES:%=$(outdir)/%.html) MAIN_INFO_DOC = lilypond-notation INFO_DOCS = lilypond-usage lilypond-changes lilypond-contributor lilypond-internals \ lilypond-essay lilypond-learning lilypond-notation music-glossary \ - lilypond-general + lilypond-general lilypond-extending ifeq ($(out),www) INFO_DOCS += lilypond-snippets endif diff --git a/Documentation/extending.tely b/Documentation/extending.tely new file mode 100644 index 0000000000..5f374fc465 --- /dev/null +++ b/Documentation/extending.tely @@ -0,0 +1,71 @@ +\input texinfo @c -*- coding: utf-8; mode: texinfo; -*- +@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 + +@setfilename lilypond-extending.info +@settitle Extending LilyPond +@documentencoding UTF-8 +@documentlanguage en +@afourpaper + +@macro manualIntro +This file explains how to extend the functionality of +LilyPond version @version{}. +@end macro + +@macro copyrightDeclare +Copyright @copyright{} +1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 +by the authors. +@end macro + +@set FDL +@include macros.itexi + + +@c don't remove this comment. +@ignore +@omfcreator Han-Wen Nienhuys, Jan Nieuwenhuizen and Graham Percival +@omfdescription Programming extensions for the LilyPond music engraving system +@omftype program usage +@omfcategory Applications|Publishing +@omflanguage English +@end ignore + + +@lilyTitlePage{Extending} + + +@c TOC -- non-tex +@ifnottex + +@menu +* Scheme tutorial:: Programming inside LilyPond. + +Appendices + +* GNU Free Documentation License:: License of this document. +* LilyPond index:: +@end menu + +@docMain +@end ifnottex + + +@contents + + +@include extending/scheme-tutorial.itely + +@include fdl.itexi + +@node LilyPond index +@appendix LilyPond index + +@printindex cp + +@bye diff --git a/Documentation/extending/GNUmakefile b/Documentation/extending/GNUmakefile new file mode 100644 index 0000000000..cab24d6a17 --- /dev/null +++ b/Documentation/extending/GNUmakefile @@ -0,0 +1,7 @@ +depth = ../.. + +LOCALSTEPMAKE_TEMPLATES = ly + +include $(depth)/make/stepmake.make + + diff --git a/Documentation/learning/scheme-tutorial.itely b/Documentation/extending/scheme-tutorial.itely similarity index 98% rename from Documentation/learning/scheme-tutorial.itely rename to Documentation/extending/scheme-tutorial.itely index 20455abcc5..fbd8879a11 100644 --- a/Documentation/learning/scheme-tutorial.itely +++ b/Documentation/extending/scheme-tutorial.itely @@ -10,7 +10,7 @@ @c \version "2.12.0" @node Scheme tutorial -@appendix Scheme tutorial +@chapter Scheme tutorial @funindex # @cindex Scheme @@ -40,7 +40,7 @@ opening a terminal window and typing @q{guile}. On some systems, notably Windows, you may need to set the environment variable @code{GUILE_LOAD_PATH} to the directory @code{../usr/shr/guile/1.8} in the LilyPond installation (for the full path to this directory -see @ref{Other sources of information}). Alternatively, Windows +see @rlearning{Other sources of information}). Alternatively, Windows users may simply choose @q{Run} from the Start menu and enter @q{guile}. @@ -262,7 +262,7 @@ respectively, @end menu @node Tweaking with Scheme -@appendixsec Tweaking with Scheme +@section Tweaking with Scheme We have seen how LilyPond output can be heavily modified using commands like -- 2.39.2