From: Jan Nieuwenhuizen Date: Sun, 3 Apr 2005 12:03:06 +0000 (+0000) Subject: * GNUmakefile.in: Include symlinks in webball. X-Git-Tag: release/2.4.6~11 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=73d05256d5059393f4103de6f26d902c9e0e28b7;p=lilypond.git * GNUmakefile.in: Include symlinks in webball. * Documentation/user/GNUmakefile (source-links): Add symlinks to source dir for split and non-split manuals. * stepmake/bin/add-html-footer.py (do_file): Remove info's annoying's indication of referencing external document. --- diff --git a/ChangeLog b/ChangeLog index 4589431fb3..cfc7f4c38d 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2005-04-03 Jan Nieuwenhuizen + + * GNUmakefile.in: Include symlinks in webball. + + * Documentation/user/GNUmakefile (source-links): Add symlinks to + source dir for split and non-split manuals. + + * Documentation/user/*y: Fix @uref/@inputfile links for + split/non-split HTML documents. + + * stepmake/bin/add-html-footer.py (do_file): Remove info's + annoying's indication of referencing external document. + 2005-04-02 Jan Nieuwenhuizen * buildscripts/install-info-html.sh: Fix link. diff --git a/Documentation/user/GNUmakefile b/Documentation/user/GNUmakefile index 3d6452e5b5..1720b33374 100644 --- a/Documentation/user/GNUmakefile +++ b/Documentation/user/GNUmakefile @@ -185,8 +185,24 @@ DEEP_HTML_FILES =\ $(outdir)/lilypond/index.html\ $(outdir)/lilypond-internals/index.html +# Symlinks to refer to external source documents from split and non-split HTML +source-links = $(outdir)/source $(outdir)/lilypond/source # $(outdir)/music-glossary/source + +$(outdir)/source: + @rm -f $(@) + ln -sf ../../../ $(@) + +$(outdir)/lilypond/source: + @rm -f $(@) + ln -sf ../../../../ $(@) + +# not available in 2.4 as split document +#$(outdir)/music-glossary/source: +# @rm -f $(@) +# ln -sf ../../../../ $(@) + local-WWW: $(HTML_FILES) $(DEEP_HTML_FILES)\ - $(datafiles) $(PDF_FILES) $(PS_GZ_FILES) info info-dir + $(datafiles) $(PDF_FILES) $(PS_GZ_FILES) $(source-links) info info-dir local-WWW-clean: deep-WWW-clean diff --git a/Documentation/user/introduction.itely b/Documentation/user/introduction.itely index 99cb884078..529716a9ae 100644 --- a/Documentation/user/introduction.itely +++ b/Documentation/user/introduction.itely @@ -715,7 +715,7 @@ available in a big HTML page, @end ifnothtml @ifhtml -@uref{../lilypond.html, a big HTML page} +@uref{source/Documentation/user/out-www/lilypond.html, one big page}, @end ifhtml which can be searched easily using the search facility of a web browser. @@ -729,7 +729,7 @@ If you are not familiar with music notation or music terminology to consult the glossary as well. The glossary explains musical terms, and includes translations to various languages. It is a @ifhtml -@uref{../music-glossary.html,separate document}. +@uref{source/Documentation/user/out-www/music-glossary.html,separate document}. @end ifhtml @ifnothtml separate document, available in HTML and PDF. @@ -749,7 +749,7 @@ documentation package for your platform: @item Program reference @ifhtml -(available @uref{../lilypond-internals/lilypond-internals.html,here}) +(available @uref{source/Documentation/user/out-www/lilypond-internals.html,here}) @end ifhtml The program reference is a set of heavily cross linked HTML pages, @@ -767,9 +767,13 @@ the generated documentation. In the HTML document, these subsections have clickable links. @item -Various input examples +@ifnothtml +Various input examples. +@end ifnothtml @ifhtml -(available @uref{../../../../input/test/out-www/collated-files.html,here}) +@c Works, but link name is not so nice; so write-out macro +@c @inputfileref{input/test,Various input examples}. +@uref{source/input/test/out-www/collated-files.html,Various input examples}. @end ifhtml @cindex snippets @@ -778,9 +782,13 @@ available as a big HTML document, with pictures and explanatory texts included. @item -The regression tests +@ifnothtml +The regression tests. +@end ifnothtml @ifhtml -(available @uref{../../../../input/regression/out-www/collated-files.html,here}) +@c Works, but link name is not so nice; so write-out macro +@c @inputfileref{input/regression,The regression tests}. +@uref{source/input/regression/out-www/collated-files.html,The regression tests}. @end ifhtml This collection of files tests each notation and engraving feature of diff --git a/Documentation/user/invoking.itely b/Documentation/user/invoking.itely index d3feb6b4a7..680277fd41 100644 --- a/Documentation/user/invoking.itely +++ b/Documentation/user/invoking.itely @@ -350,7 +350,7 @@ and syntax coloring, handy compile short-cuts and reading LilyPond manuals using Info. If @file{lilypond-mode} is not installed on your platform, then read the @ifhtml -@uref{../../../topdocs/out-www/INSTALL.html,installation instructions}. +@uref{source/Documentation/topdocs/out-www/INSTALL.html,installation instructions}. @end ifhtml @ifnothtml installation instructions. @@ -361,7 +361,7 @@ installation instructions. For @uref{http://@/www@/.vim@/.org,VIM}, a @file{vimrc} is supplied, along with syntax coloring tools. For more information, refer to the @ifhtml -@uref{../../../topdocs/out-www/INSTALL.html,installation instructions}. +@uref{source/Documentation/topdocs/out-www/INSTALL.html,installation instructions}. @end ifhtml @ifnothtml installation instructions. diff --git a/Documentation/user/lilypond.tely b/Documentation/user/lilypond.tely index f9e2510520..245e794937 100644 --- a/Documentation/user/lilypond.tely +++ b/Documentation/user/lilypond.tely @@ -150,8 +150,8 @@ HINTS FOR STYLE @end ignore @ifhtml -This document is also available in @uref{../lilypond.ps.gz,gzipped -PostScript} and @uref{../lilypond.pdf,PDF}. +This document is also available in @uref{source/Documentation/user/out-www/lilypond.ps.gz,gzipped +PostScript} and @uref{source/Documentation/user/out-www/lilypond.pdf,PDF}. @end ifhtml diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 242628d9e0..6bec5f561d 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -60,12 +60,9 @@ -@c dup? @ifhtml +@c ***** HTML ***** - @c ***** HTML ***** - -@macro internalsref{NAME}@c @c makeinfo-4.7 encodes html names, which means that nodes that @c contain nonalphanum characters will be broken links on the website. @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c @@ -73,44 +70,39 @@ @c better than a broken link. @c @inforef{\NAME\,,lilypond-internals}@c @c using @ref without punctuation is OK without for formats other than info + +@macro internalsref{NAME}@c +@c annoying parentheses stripped by add-html-footer.py @ref{\NAME\,,,lilypond-internals}@c -@c should we do this? @findex \NAME\ @end macro - - @macro inputfileref{DIR,NAME} - @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c - @end macro +@c usage: @inputfileref{input@/regression,FILE@/-NAME.ly} +@macro inputfileref{DIR,NAME} +@uref{source/\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c +@end macro @end ifhtml -@c dup? -@ifdocbook - @c ***** DOCBOOK-XML ***** +@ifdocbook +@c ***** DOCBOOK-XML ***** - @macro internalsref{NAME} - @c makeinfo-4.7 encodes html names - @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c - @inforef{\NAME\,,lilypond-internals}@c - @c should we do this? - @findex @code{\NAME\} - @end macro +@macro internalsref{NAME} +@ref{\NAME\,,,lilypond-internals}@c +@findex @code{\NAME\} +@end macro - @macro usermanref{NAME} - @inforef{\NAME\,,lilypond}@c - @end macro - - @macro inputfileref{DIR,NAME} - @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c - @end macro +@macro inputfileref{DIR,NAME} +@uref{source/\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c +@end macro @end ifdocbook -@ifinfo +@ifinfo @c **** INFO **** + @macro internalsref{NAME} @inforef{\NAME\,,lilypond/lilypond-internals}@c @findex \NAME\@c @@ -126,8 +118,9 @@ @end ifinfo -@c **** TEX **** + @iftex +@c **** TEX **** @macro internalsref{NAME}@c @findex \NAME\ @c diff --git a/Documentation/user/music-glossary.tely b/Documentation/user/music-glossary.tely index eb2fe604b2..66113190f5 100644 --- a/Documentation/user/music-glossary.tely +++ b/Documentation/user/music-glossary.tely @@ -9,8 +9,8 @@ @end direntry @ifhtml -This document is also available in @uref{music-glossary.ps.gz,gzipped -PostScript} and @uref{music-glossary.pdf,PDF}. +This document is also available in @uref{source/Documentation/user/out-www/music-glossary.ps.gz,gzipped +PostScript} and @uref{source/Documentation/user/out-www/music-glossary.pdf,PDF}. @end ifhtml @titlepage diff --git a/GNUmakefile.in b/GNUmakefile.in index 41ca6d4e35..56b48ac591 100644 --- a/GNUmakefile.in +++ b/GNUmakefile.in @@ -74,7 +74,7 @@ local-WWW-post: cd $(builddir) && $(footify) `$(FIND) . -name '*.html' -print` cd $(builddir) && rm -f `find . -name \*.html~ -print` cd $(builddir) && find Documentation input \ - $(web-ext:%=-path '*/out-www/*.%' -or) -false \ + $(web-ext:%=-path '*/out-www/*.%' -or) -type l \ > $(outdir)/weblist echo '' > $(builddir)/index.html echo 'Redirecting to the documentation index...' >> $(builddir)/index.html diff --git a/stepmake/bin/add-html-footer.py b/stepmake/bin/add-html-footer.py index 3946a73780..e188495a76 100644 --- a/stepmake/bin/add-html-footer.py +++ b/stepmake/bin/add-html-footer.py @@ -279,6 +279,10 @@ def do_file (f): s = remove_self_ref (s) + # remove info's annoying's indication of referencing external document + s = re.sub (' \((lilypond|lilypond-internals|music-glossary)\)', + '', s) + open (f, 'w').write (s)