From e9cea040855f3f40cb37b21c078ba1c90ea22714 Mon Sep 17 00:00:00 2001 From: Graham Percival Date: Sun, 4 Oct 2009 13:03:19 +0100 Subject: [PATCH] Doc: fix links, add Extending to website. --- Documentation/general/manuals.itexi | 50 +++++++++++++++++++++++++++++ Documentation/learning.tely | 2 -- Documentation/learning/tweaks.itely | 14 ++++---- Documentation/macros.itexi | 41 +++++++++++++++++++++++ Documentation/web-texi2html.init | 2 +- 5 files changed, 99 insertions(+), 10 deletions(-) diff --git a/Documentation/general/manuals.itexi b/Documentation/general/manuals.itexi index 2dd863b2c1..b3c01cf3a0 100644 --- a/Documentation/general/manuals.itexi +++ b/Documentation/general/manuals.itexi @@ -73,6 +73,9 @@ links to the answers of Frequently Asked Questions. @item @ref{Changes}: updates since the last major version. +@item @ref{Extend}: +programming fancy tweaks in lilypond. + @item @ref{Internals}: information about LilyPond's internal structures, which is required for constructing tweaks. @@ -115,6 +118,7 @@ License. * Snippets:: Snippets. * FAQ:: FAQ. * Changes:: NEWS. +* Extend:: Programming. * Internals:: Internals. * Translated:: Translation. * All:: All manuals. @@ -536,6 +540,52 @@ GNU info format for documentation. FIXME, link broken. @divEnd +@node Extend +@unnumberedsec Extend + +@divClass{column-left-top} +@subheading Extend LilyPond + +This manual explains how to write extensions to LilyPond. + +@divEnd + +@divClass{column-right-top} +@subheading Read it now + +@itemize + +@item @rextendnamed{Top,Extend}: +read this manual in the same format as this one. + +@end itemize +@divEnd + +@divClass{column-center-bottom} +@subheading Other formats + +@divClass{keep-bullets} +@itemize + +@item @uref{extending/index.html, Extend (split HTML)}: +the manual is split between many HTML pages. +@emph{(small download for each page)} + +@item @uref{extending-big-page.html, Extend (big HTML)}: +read this manual as one huge HTML page. +@emph{(large single download, around 10? Mb)} + +@item @uref{extending.pdf, extending.pdf}: +download as a PDF file. +@emph{(large single download, 2.8 Mb)} + +@item @uref{FIXME, extending.info}: +GNU info format for documentation. FIXME, link broken. + +@end itemize +@divEnd +@divEnd + @node Internals @unnumberedsec Internals diff --git a/Documentation/learning.tely b/Documentation/learning.tely index adcecb5ece..26719f4a34 100644 --- a/Documentation/learning.tely +++ b/Documentation/learning.tely @@ -51,7 +51,6 @@ by the authors. Appendices * Templates:: Ready-made templates. -* Scheme tutorial:: Programming inside LilyPond. * GNU Free Documentation License:: License of this document. * LilyPond index:: @end menu @@ -72,7 +71,6 @@ Appendices @include learning/tweaks.itely @include learning/templates.itely -@include learning/scheme-tutorial.itely @include fdl.itexi diff --git a/Documentation/learning/tweaks.itely b/Documentation/learning/tweaks.itely index 12158ee87d..9c0b98edba 100644 --- a/Documentation/learning/tweaks.itely +++ b/Documentation/learning/tweaks.itely @@ -816,8 +816,8 @@ LilyPond. Some of them are the names of properties, like @code{thickness} or @code{font-shape}, others are used as values that can be given to properties, like @code{italic}. Note the distinction from arbitrary text strings, which would appear as @code{"a text -string"}; for more details about symbols and strings, see @ref{Scheme -tutorial}. +string"}; for more details about symbols and strings, see +@rextend{Scheme tutorial}. So we see that the @code{\override} command needed to print the lyrics in italics is: @@ -882,7 +882,7 @@ the dot between the context name and the object name.} @seealso -Learning Manual: @ref{Scheme tutorial}. +Extending: @rextend{Scheme tutorial}. @node Types of properties @@ -954,7 +954,7 @@ by apostrophe-hash, @code{'#}. @seealso -Learning Manual: @ref{Scheme tutorial}. +Extending: @rextend{Scheme tutorial}. @node Appearance of objects @@ -3913,7 +3913,7 @@ LilyPond internal operation. Further explanation of these files is currently outside the scope of this manual, as a knowledge of the Scheme language is required. Users should be warned that a substantial amount of technical knowledge or time is required -to understand Scheme and these files (see @ref{Scheme tutorial}). +to understand Scheme and these files (see @rextend{Scheme tutorial}). If you have this knowledge, the Scheme files which may be of interest are: @@ -3974,7 +3974,7 @@ interface to the LilyPond internal operation. Code written in the Scheme programming language can be incorporated directly in the internal operation of LilyPond. Of course, at least a basic knowledge of programming in Scheme is required to do this, and an -introduction is provided in the @ref{Scheme tutorial}. +introduction is provided in the @rextend{Scheme tutorial}. As an illustration of one of the many possibilities, instead of setting a property to a constant it can be set to a Scheme @@ -4019,7 +4019,7 @@ the staff. @end lilypond Further examples showing the use of these programmable interfaces -can be found in @ref{Tweaking with Scheme}. +can be found in @rextend{Tweaking with Scheme}. diff --git a/Documentation/macros.itexi b/Documentation/macros.itexi index 2c923d7208..d580fdf027 100644 --- a/Documentation/macros.itexi +++ b/Documentation/macros.itexi @@ -193,6 +193,7 @@ For LilyPond version @version{} @c @rprogram @c @ruser @c @rchanges +@c @rextend @c @rcontrib @c @c All these also have a @...named version which allows to specify the @@ -240,6 +241,16 @@ For LilyPond version @version{} @ref{\TEXT\,,\DISPLAY\,notation-big-page,Notation Reference} @end macro +@macro rextend{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,extending-big-page,Extending} +@end macro + +@macro rextendnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,extending-big-page,Extending} +@end macro + @macro rchanges{TEXT} @vindex \TEXT\ @ref{\TEXT\,,,changes-big-page,Changes} @@ -357,6 +368,16 @@ For LilyPond version @version{} @ref{\TEXT\,,\DISPLAY\,changes,Changes} @end macro +@macro rextend{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,extending,Extending} +@end macro + +@macro rextendnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,extending,Extending} +@end macro + @macro rcontrib{TEXT} @vindex \TEXT\ @ref{\TEXT\,,,contributor,Contributor's Guide} @@ -459,6 +480,16 @@ For LilyPond version @version{} @ref{\TEXT\,,\DISPLAY\,lilypond-changes,Changes} @end macro +@macro rextend{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-extending,Extending} +@end macro + +@macro rextendnamed{TEXT,DISPLAY} +@vindex \TEXT\ +@ref{\TEXT\,,\DISPLAY\,lilypond-extending,Extending} +@end macro + @macro rcontrib{TEXT} @vindex \TEXT\ @ref{\TEXT\,,,lilypond-contributor,Contributor's Guide} @@ -578,6 +609,16 @@ For LilyPond version @version{} @ref{\TEXT\,,\DISPLAY\,changes,Changes} @end macro +@macro rextend{TEXT} +@lilyvindex{\TEXT\} +@ref{\TEXT\,,,extending,Extending} +@end macro + +@macro rextendnamed{TEXT,DISPLAY} +@lilyvindex{\TEXT\} +@ref{\TEXT\,,\DISPLAY\,extending,Extending} +@end macro + @macro rcontrib{TEXT} @lilyvindex{\TEXT\} @ref{\TEXT\,,,contributor,Contributor's Guide} diff --git a/Documentation/web-texi2html.init b/Documentation/web-texi2html.init index 3700107e5e..fb49202c8f 100644 --- a/Documentation/web-texi2html.init +++ b/Documentation/web-texi2html.init @@ -651,7 +651,7 @@ sub generate_ly_toc_entries($$$) my @color_3 = ( "Productions", "Testimonials", "Source", "Old downloads", - "FAQ", "Changes", "Internals", + "FAQ", "Changes", "Extend", "Internals", "Publications", "Old news" ); my @color_4 = ( -- 2.39.2