From: Reinhold Kainhofer Date: Sun, 16 Nov 2008 18:59:46 +0000 (+0100) Subject: Docs: Rework the way collated-files.html is generated. X-Git-Tag: release/2.11.65-1~51^2~7 X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=dba74005fde4b6aa018041e159a0bb770b8fb2ac;p=lilypond.git Docs: Rework the way collated-files.html is generated. -) List the files to be collated in a makefile variable COLLATED_FILES (will default to $(sort $(TEXINFO_SOURCES) $(LY_FILES) $(OUT_LY_FILES) ) if unset) -) Get rid of AAA-intro-regression.ly hack and instead include a .tely file. --- diff --git a/input/regression/AAA-intro-regression.ly b/input/regression/AAA-intro-regression.ly deleted file mode 100644 index 1ebe40a5f5..0000000000 --- a/input/regression/AAA-intro-regression.ly +++ /dev/null @@ -1,31 +0,0 @@ -\version "2.11.51" -%% +.ly: Be the first .ly file for lys-to-tely.py. -%% Better to make lys-to-tely.py include "introduction.texi" or -%% other .texi documents too? - - -\header{ -texidoc = - -#(string-append "@unnumbered Introduction - -This document presents proofs for -LilyPond " (lilypond-version) ". When the -text corresponds with the shown notation, we consider LilyPond Officially -BugFree (tm). This document is intended for finding bugs and for -documenting bugfixes. - -In the web version of this document, you can click on the file name -or figure for each example to see the corresponding input file. - -TODO: order of tests (file names!), test only one feature per test. -Smaller and neater tests. -") - -} - -% -% make sure the .png is generated. -% -\lyrics { "(left blank intentionally)" } - diff --git a/input/regression/AAA-intro-regression.tely b/input/regression/AAA-intro-regression.tely new file mode 100644 index 0000000000..0353678e9e --- /dev/null +++ b/input/regression/AAA-intro-regression.tely @@ -0,0 +1,16 @@ +@unnumbered Introduction + +This document presents proofs for +LilyPond @lilypondversion). When the +text corresponds with the shown notation, we consider LilyPond Officially +BugFree (tm). This document is intended for finding bugs and for +documenting bugfixes. + +In the web version of this document, you can click on the file name +or figure for each example to see the corresponding input file. + +TODO: order of tests (file names!), test only one feature per test. +Smaller and neater tests. + +@unnumbered Regression test cases + diff --git a/input/regression/musicxml/0-Introduction.itexi b/input/regression/musicxml/0-Introduction.itexi new file mode 100644 index 0000000000..f8567aa077 --- /dev/null +++ b/input/regression/musicxml/0-Introduction.itexi @@ -0,0 +1,40 @@ +@unnumberedsec Introduction + +This document presents proofs for the musicxml2ly script provided with +LilyPond @lilypondversion. The files don't have a description yet, so +there is no official indication when the output is wrong. +These snippets are provided as unit test files in MusicXML, converted to +a .ly file by musicxml2ly and then processed by lilypond as usual. + +If something does not seem wright in the output, it might either be that this +feature has not been implemented yet, has been wrongly implemented, or a regression +has crept in recently... +This document is intended for finding bugs and for documenting bugfixes. + +In the web version of this document, you can click on the file name +or figure for each example to see the corresponding .ly intermediary file. + +TODO: Find a way to add a description to the .ly files for texinfo. + +The files are categorized by their first two digits with the following meaning: +@itemize +@item 00 ... Basics: Pitches, durations, rests, clefs, keys, time sigs, ties, etc. +@item 01 ... Chords +@item 02 ... MusicXML notations and articulations (articulations, ornaments, technicals, text markup) +@item 03 ... MusicXML directions (dynamics; single symbols, not spanners like hairpins) +@item 04 ... Spanners (hairpin, octave shift, trill, glissando, etc.) +@item 05 ... Header information (title, composer, poet, etc.) +@item 06 ... Lyrics +@item 08 ... Multiple parts (staves) +@item 09 ... Measure issues: Repeats, barlines, pickup measures, mid-measure barlines/repeats +@item 10 ... Multiple voices per staff +@item 12 ... Triplets, Tuplets +@item 13 ... Grace notes +@item 14 ... Multi-staff parts (one voice on multiple staves, e.g. PianoStaff) +@item 15 ... Percussion +@item 17 ... Guitar notation: Chord names, Fretboards, Tablature notation +@item 18 ... Figured bass +@item 19 ... Page layout: font/paper size, margins, spacing +@item 20 ... Compressed MusicXML files +@item 99 ... Compatibility modes with broken MusicXML exporters (i.e. ignore beams for Sibelius 5) +@end itemize diff --git a/input/regression/musicxml/AAA-intro-regression.ly b/input/regression/musicxml/AAA-intro-regression.ly deleted file mode 100644 index 5e4914fc97..0000000000 --- a/input/regression/musicxml/AAA-intro-regression.ly +++ /dev/null @@ -1,57 +0,0 @@ -\version "2.10.0" -%% +.ly: Be the first .ly file for lys-to-tely.py. -%% Better to make lys-to-tely.py include "introduction.texi" or -%% other .texi documents too? - - -\header{ -texidoc = - -#(string-append "@unnumbered MusicXML regression and coverage test - -This document presents proofs for the musicxml2ly script provided with -LilyPond " (lilypond-version) ". The files don't have a description yet, so -there is no official indication when the output is wrong. -These snippets are provided as unit test files in MusicXML, converted to -a .ly file by musicxml2ly and then processed by lilypond as usual. - -If something does not seem wright in the output, it might either be that this -feature has not been implemented yet, has been wrongly implemented, or a regression -has crept in recently... -This document is intended for finding bugs and for documenting bugfixes. - -In the web version of this document, you can click on the file name -or figure for each example to see the corresponding .ly intermediary file. - -TODO: Find a way to add a description to the .ly files for texinfo. - -The files are categorized by their first two digits with the following meaning: -@itemize -@item 00 ... Basics: Pitches, durations, rests, clefs, keys, time sigs, ties, etc. -@item 01 ... Chords -@item 02 ... MusicXML notations and articulations (articulations, ornaments, technicals, text markup) -@item 03 ... MusicXML directions (dynamics; single symbols, not spanners like hairpins) -@item 04 ... Spanners (hairpin, octave shift, trill, glissando, etc.) -@item 05 ... Header information (title, composer, poet, etc.) -@item 06 ... Lyrics -@item 08 ... Multiple parts (staves) -@item 09 ... Measure issues: Repeats, barlines, pickup measures, mid-measure barlines/repeats -@item 10 ... Multiple voices per staff -@item 12 ... Triplets, Tuplets -@item 13 ... Grace notes -@item 14 ... Multi-staff parts (one voice on multiple staves, e.g. PianoStaff) -@item 15 ... Percussion -@item 17 ... Guitar notation: Chord names, Fretboards, Tablature notation -@item 18 ... Figured bass -@item 19 ... Page layout: font/paper size, margins, spacing -@item 20 ... Compressed MusicXML files -@item 99 ... Compatibility modes with broken MusicXML exporters (i.e. ignore beams for Sibelius 5) -@end itemize -") - -} - -% -% make sure the .png is generated. -% -\lyrics { "(left blank intentionally)" } \ No newline at end of file diff --git a/input/regression/musicxml/GNUmakefile b/input/regression/musicxml/GNUmakefile index 9d1411b78e..24ccf2bc32 100644 --- a/input/regression/musicxml/GNUmakefile +++ b/input/regression/musicxml/GNUmakefile @@ -6,21 +6,13 @@ LOCALSTEPMAKE_TEMPLATES=lilypond ly lysdoc musicxml TITLE=Lilypond musicxml2ly Regression Tests -ILY_FILES = $(call src-wildcard,*.ily) -EXTRA_OUT_LY_FILES = ${ILY_FILES:%.ily=$(outdir)/%.ly} -EXTRA_DIST_FILES += $(ILY_FILES) +OUT_ITEXI_FILES = ${ITEXI_FILES:%.itexi=$(outdir)/%.itexi} -ITEXI_FILES = $(call src-wildcard,*.itexi) -EXTRA_OUT_LY_FILES = ${ITEXI_FILES:%.itexi=$(outdir)/%.itexi} -EXTRA_DIST_FILES += $(ITEXI_FILES) +COLLATED_FILES = $(sort $(OUT_LY_FILES) $(OUT_ITEXI_FILES) ) include $(depth)/make/stepmake.make TITLE=Lilypond musicxml2ly Regression Tests -.SUFFIXES: .ily -$(outdir)/%.ly: %.ily - ln -f $< $@ - $(outdir)/%.itexi: %.itexi ln -f $< $@ diff --git a/make/lysdoc-rules.make b/make/lysdoc-rules.make index ab16b1ec29..6dfa8e6f0b 100644 --- a/make/lysdoc-rules.make +++ b/make/lysdoc-rules.make @@ -1,3 +1,3 @@ -$(outdir)/collated-files.tely: $(LY_FILES) $(OUT_LY_FILES) +$(outdir)/collated-files.tely: $(COLLATED_FILES) $(PYTHON) $(LYS_TO_TELY) --name=$(outdir)/collated-files.tely --title="$(TITLE)" $^ diff --git a/make/lysdoc-vars.make b/make/lysdoc-vars.make index 96d44b12f3..a2874b271b 100644 --- a/make/lysdoc-vars.make +++ b/make/lysdoc-vars.make @@ -1,2 +1,6 @@ TITLE=LYs Doc + +ifeq ($(COLLATED_FILES),) +COLLATED_FILES = $(sort $(TEXINFO_SOURCES) $(LY_FILES) $(OUT_LY_FILES) ) +endif diff --git a/make/musicxml-vars.make b/make/musicxml-vars.make index 55cb25b75b..9ee895afa2 100644 --- a/make/musicxml-vars.make +++ b/make/musicxml-vars.make @@ -2,7 +2,7 @@ MUSICXML_FILES = $(call src-wildcard,*.xml) MUSICMXL_FILES = $(call src-wildcard,*.mxl) # Allow .mxl for compressed files -OUT_LY_FILES = $(sort ${MUSICXML_FILES:%.xml=$(outdir)/%.ly} ${MUSICMXL_FILES:%.mxl=$(outdir)/%.ly} ${EXTRA_OUT_LY_FILES}) +OUT_LY_FILES = $(sort ${MUSICXML_FILES:%.xml=$(outdir)/%.ly} ${MUSICMXL_FILES:%.mxl=$(outdir)/%.ly}) OUT_FILES = $(OUT_LY_FILES) EXTRA_DIST_FILES += $(MUSICXML_FILES) $(MUSICMXL_FILES)