From a54eded7c9ae0fa7dd70bfd2fbdb506502513c17 Mon Sep 17 00:00:00 2001 From: Han-Wen Nienhuys Date: Mon, 7 Apr 2003 17:26:01 +0000 Subject: [PATCH] * Documentation/user/macros.itexi: @inputfileref macro. * buildscripts/lys-to-tely.py (name2line): add tags for each file. --- ChangeLog | 7 ++++ Documentation/user/introduction.itely | 2 +- Documentation/user/invoking.itexi | 2 +- Documentation/user/macros.itexi | 55 ++++++--------------------- Documentation/user/refman.itely | 24 ++++++------ Documentation/user/tutorial.itely | 10 ++--- buildscripts/lys-to-tely.py | 10 ++++- make/lysdoc-rules.make | 2 +- 8 files changed, 49 insertions(+), 63 deletions(-) diff --git a/ChangeLog b/ChangeLog index f93c62a9a7..8f5ea677bd 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2003-04-07 Han-Wen Nienhuys + + * Documentation/user/macros.itexi: @fileref macro. + + * buildscripts/lys-to-tely.py (name2line): add tags for + each file. + 2003-04-04 Juergen Reuter * lily/include/custos.hh, make/lilypond.suse.spec.in, diff --git a/Documentation/user/introduction.itely b/Documentation/user/introduction.itely index 0bced56bc1..d7f01e21b1 100644 --- a/Documentation/user/introduction.itely +++ b/Documentation/user/introduction.itely @@ -229,7 +229,7 @@ pitch relations, and there is no universal agreement on how to do this. Fortunately, we have a concrete application, so we don't run the risk -of loosing ourselves in philosophical arguments over the essence of +of losing ourselves in philosophical arguments over the essence of music. We want to produce a printed score from a music representation, so this gives us a nice guide for designing a format: we need a format containing mainly musical elements, such as pitch and diff --git a/Documentation/user/invoking.itexi b/Documentation/user/invoking.itexi index 297386dacd..ab2b5bd1ab 100644 --- a/Documentation/user/invoking.itexi +++ b/Documentation/user/invoking.itexi @@ -314,7 +314,7 @@ Show the warranty with which GNU LilyPond comes. (It comes with Ly2dvi extracts the following header fields from the LY files to generate titling. An example demonstrating all these fields is in -@file{input/test/ly2dvi-testpage.ly}. +@inputfileref{input/test,ly2dvi-testpage.ly}. @table @code @item title diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index e9b28b4749..b1435de21c 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -11,49 +11,6 @@ @end macro -@c Reference ENGraver description -@ifnottex -@macro reng {word} -@ref{ (lilypond-internals)\word\, \word\ } - -@end macro -@end ifnottex - -@iftex -@macro reng {word} -\word\ -@end macro -@end iftex - - -@c Reference GROB description -@ifnottex -@macro rgrob {word} -@ref{ (lilypond-internals)\word\, \word\ } - -@end macro -@end ifnottex - -@iftex -@macro rgrob {word} -\word\ -@end macro -@end iftex - - -@c Reference INTernals document -@ifnottex -@macro rint {word} -@ref{ (lilypond-internals)\word\, \word\ } - -@end macro -@end ifnottex - -@iftex -@macro rint {word} -\word\ -@end macro -@end iftex @c Reference GLOSsary @@ -133,6 +90,10 @@ $\\flat$% @uref{../lilypond-internals/\NAME\.html,\NAME\} @cindex \NAME\ @end macro + +@macro fileref{DIR,NAME} +@uref{../../../\DIR\/out-www/collated-files.html#\NAME\} +@end macro @end ifhtml @ifinfo @@ -140,6 +101,11 @@ $\\flat$% @inforef{\NAME\,,lilypond-internals} @cindex \NAME\ @end macro + +@macro fileref{DIR,NAME} +@file{\DIR\/\NAME\} +@end macro + @end ifinfo @iftex @@ -147,6 +113,9 @@ $\\flat$% @cindex \NAME\ @code{\NAME\} @end macro +@macro fileref{DIR,NAME} +@file{\DIR\/\NAME\} +@end macro @end iftex diff --git a/Documentation/user/refman.itely b/Documentation/user/refman.itely index d29d152889..735060e0ae 100644 --- a/Documentation/user/refman.itely +++ b/Documentation/user/refman.itely @@ -12,6 +12,8 @@ @end macro + + @c .{Reference Manual} @node Reference Manual @@ -968,7 +970,7 @@ property. Setting it to @code{#'()} uses fraction style for 4/4 and The object for this symbol is @internalsref{TimeSignature}. There are many more options for its layout. They are selected through the -@code{style} object property. See @file{input/test/time.ly} for more +@code{style} object property. See @inputfileref{input/test,time.ly} for more examples. This command sets the property @code{timeSignatureFraction}, @@ -1621,7 +1623,7 @@ Each rule cosists of @end table As described in the internal documentation of -@reng{Accidental_engraver}, the properties @code{autoAccidentals} and +@internalsref{Accidental_engraver}, the properties @code{autoAccidentals} and @code{autoCautionaries} contain lists of rule descriptions. Notice that the contexts must be listed from in to out - that is @internalsref{Thread} before @internalsref{Voice}, @@ -2009,7 +2011,7 @@ effect on the MIDI rendering of the music. Unfortunately, there is no support for adding fingering instructions or ornaments to individual note heads. Some hacks exist, though. See -@file{input/test/script-horizontal.ly}. +@inputfileref{input/test,script-horizontal.ly}. @c . {Text scripts} @@ -2321,7 +2323,7 @@ alternative endings (voltas) are printed, left to right. @item fold Alternative endings are written stacked. This has limited use but may be used to typeset two lines of lyrics in songs with repeats, see -@file{input/star-spangled-banner.ly}. +@inputfileref{input,star-spangled-banner.ly}. @item tremolo Make tremolo beams. @@ -2402,7 +2404,7 @@ the specified number of repeats. @cindex expanding repeats For instructions on how to unfoldi repeats for MIDI output, see -the example file @file{input/test/unfold-all-repeats.ly}. +the example file @inputfileref{input/test,unfold-all-repeats.ly}. @refbugs @@ -2862,7 +2864,7 @@ other pianistic peculiarities. There is no support for putting chords across staves. You can get this result by increasing the length of the stem in the lower stave so it reaches the stem in the upper stave, or vice versa. An example is -included with the distribution as @file{input/test/stem-cross-staff.ly}. +included with the distribution as @inputfileref{input/test,stem-cross-staff.ly}. @cindex cross staff stem @cindex stem, cross staff @@ -2961,7 +2963,7 @@ c''4 \sostenutoDown d''4 e''4 c'4 f'4 g'4 a'4 \sostenutoUp For fine-tuning of the appearance of a pedal bracket, the properties @code{edge-width}, @code{edge-height}, and @code{shorten-pair} of @code{PianoPedalBracket} objects (see the detailed documentation of -@rgrob{PianoPedalBracket}) can be modified. For example, the bracket +@internalsref{PianoPedalBracket}) can be modified. For example, the bracket may be extended to the end of the note head. @lilypond[fragment,verbatim] @@ -3662,7 +3664,7 @@ As you can see, the mark is incremented automatically if you use @code{\mark \default}. The value to use is stored in the property @code{rehearsalMark} is used and automatically incremented. The object is @internalsref{RehearsalMark} in @internalsref{Score} context. See -@code{input/test/boxed-molecule.ly} if you need boxes around the +@inputfileref{input/test,boxed-molecule.ly} if you need boxes around the marks. The @code{\mark} command can also be used to put signs like coda, @@ -3985,8 +3987,8 @@ may set the property @var{soloADue} to false. There are a number of other properties that you can use to tweak the behavior of part combining, refer to the automatically generated -documentation of @reng{Thread_devnull_engraver} and -@reng{Voice_devnull_engraver}. Look at the documentation of the +documentation of @internalsref{Thread_devnull_engraver} and +@internalsref{Voice_devnull_engraver}. Look at the documentation of the responsible engravers, @code{Thread_devnull_engraver}, @code{Voice_devnull_engraver} and @code{A2_engraver}. @@ -5054,7 +5056,7 @@ changed by setting the @code{fontSize} property for that context: This command will not change the size of variable symbols, such as beams or slurs. You can use this command to get smaller symbol for cue notes, but that involves some more subtleties. An elaborate -example of those is in @file{input/test/cue-notes.ly}. +example of those is in @inputfileref{input/test,cue-notes.ly}. @cindex cue notes @cindex font size diff --git a/Documentation/user/tutorial.itely b/Documentation/user/tutorial.itely index 4018352846..62d6ed556a 100644 --- a/Documentation/user/tutorial.itely +++ b/Documentation/user/tutorial.itely @@ -1094,7 +1094,7 @@ The complete file is listed here: [TODO: show how to do fixed 4 measures to the line] In this section we show how to typeset a melody with chord -accompaniment. This file is included as @file{input/tutorial/flowing.ly}. +accompaniment. This file is included as @inputfileref{input/tutorial,flowing.ly}. @example \include "paper16.ly" @@ -1684,7 +1684,7 @@ latest lily version. Our eighth subject is a piece of piano music. The fragment in the input file is a piano reduction of the G major Sinfonia by Giovanni Battista Sammartini, composed around 1740. It's in the source -package under the name @file{input/tutorial/sammartini.ly}. +package under the name @inputfileref{input/tutorial,sammartini.ly}. @lilypondfile[smallverbatim]{sammartini.ly} @@ -2065,7 +2065,7 @@ produce the desired effect: @end example If you ran the previous example, you have unknowingly already used -this kind of command. The @file{ly/property-init.ly} contains the +this kind of command. The @inputfileref{ly,property-init.ly} contains the definition of @code{\stemUp}: @example stemUp = \property Voice.Stem \set #'direction = #1 @@ -2341,8 +2341,8 @@ for transposing instruments. @subsection The full score -The second file, @file{input/tutorial/os-score.ly}, reads the -definitions of the first (@file{input/tutorial/os-music.ly}), and +The second file, @inputfileref{input/tutorial,os-score.ly}, reads the +definitions of the first (@inputfileref{input/tutorial,os-music.ly}), and defines the @code{\score} block for the full conductor's score. @example diff --git a/buildscripts/lys-to-tely.py b/buildscripts/lys-to-tely.py index c07524cfb6..35adbabbf3 100644 --- a/buildscripts/lys-to-tely.py +++ b/buildscripts/lys-to-tely.py @@ -73,7 +73,15 @@ if files: def name2line (n): # UGR - s = "@lilypondfile[printfilename]{%s}" % n + s = r""" +@ifhtml +@html + +@end html +@end ifhtml +""" % n + + s += "@lilypondfile[printfilename]{%s}" % n return s s = s + string.join (map (lambda x: name2line (x), files), "\n") diff --git a/make/lysdoc-rules.make b/make/lysdoc-rules.make index b41e4c7892..4918481d47 100644 --- a/make/lysdoc-rules.make +++ b/make/lysdoc-rules.make @@ -2,5 +2,5 @@ $(outdir)/$(NAME).tely: $(LY_FILES) - $(PYTHON) ../../buildscripts/lys-to-tely.py --name=$(outdir)/$(NAME) --title="$(TITLE)" $(LY_FILES) + $(PYTHON) ../../buildscripts/lys-to-tely.py --name=$(outdir)/collated-files.html --title="$(TITLE)" $(LY_FILES) -- 2.39.2