* doc/tutorial/tutorial.tex, * doc/technical/technical.tex, * doc/ref_guide/ref_guide.tex, * doc/white_paper/white_paper.tex: Move... * doc/tutorial.tex, * doc/technical.tex, * doc/ref-guide.tex, * doc/white-paper.tex: ...here. * doc/graphicx.hva: New. * doc/technical/figures/file_layout.pdf, * doc/technical/figures/file_layout.png, * doc/white_paper/figures/house.png, * doc/white_paper/figures/house_rag.png, * doc/white_paper/figures/house_wshed.png, * doc/white_paper/figures/house_wshed_mean_colors.png: Move... * doc/figures/technical/file_layout.pdf, * doc/figures/technical/file_layout.png, * doc/figures/house.png, * doc/figures/house_rag.png, * doc/figures/house_wshed.png, * doc/figures/house_wshed_mean_colors.png: ...here. * doc/technical.tex: Adjust paths. * doc/technical/designs/, * doc/tutorial/designs/, * doc/tutorial/doxyfile_tuto.local, * doc/tutorial/image_types.txt, * doc/tutorial/image_values.txt, * doc/tutorial/images_tour.txt, * doc/tutorial/slides.tex: Rename as... * doc/technical.old/designs/, * doc/tutorial.old/design/, * doc/tutorial.old/doxyfile_tuto.local, * doc/tutorial.old/image_types.txt, * doc/tutorial.old/image_values.txt, * doc/tutorial.old/images_tour.txt, * doc/tutorial.old/slides.tex: ...this. * tutorial/headers.stamp: Remove. * doc/Makefile.am (REFMAN_deps): Rename as... (refman_dependencies): ...this. Adjust paths. ($(srcdir)/user-refman.stamp, $(srcdir)/devel-refman.stamp): Adjust. (PNGS, EPSS): Remove. (.png.eps): Remove rule. (TECHNICAL_FIGURES, WHITE_PAPER_FIGURES): New. (MORE_FIGURES): Add $(TECHNICAL_FIGURES) and $(WHITE_PAPER_FIGURES). (technical_dir, tutorial_dir, white_paper_dir, ref_guide_dir): Remove. (TECHNICAL, TUTORIAL, WHITE_PAPER, REF_GUIDE): New. (TECHNICAL_PDF, TUTORIAL_PDF, WHITE_PAPER_PDF, REF_GUIDE_PDF) (TUTORIAL_HH, REF_GUIDE_HH) (EXTRA_DIST, MAINTAINERCLEANFILES): Adjust. Remove (EPSS). (EXTRA_DIST): Remove $(PNGS). Add graphicx.hva. (technical_dependencies) (tutorial_dependencies) (ref_guide_dependencies): Rename as... (TECHNICAL_deps) (TUTORIAL_deps) (REF_GUIDE_deps): ...this. (TECHNICAL_deps): Add $(TECHNICAL_FIGURES). (WHITE_PAPER_deps): New. ($(TECHNICAL_PDF)) ($(TUTORIAL_PDF)) ($(WHITE_PAPER_PDF)) ($(REF_GUIDE_PDF)): Adjust. (TECHNICAL_HTML, TECHNICAL_HTML_OUTPUTS) (TUTORIAL_HTML, TUTORIAL_HTML_OUTPUTS) (WHITE_PAPER_HTML, WHITE_PAPER_HTML_OUTPUTS) (REF_GUIDE_HTML, REF_GUIDE_HTML_OUTPUTS): Remove. (all-local): Depend on $(srcdir)/$(TECHNICAL).stamp, $(srcdir)/$(TUTORIAL).stamp, $(srcdir)/$(WHITE_PAPER).stamp and $(srcdir)/$(REF_GUIDE).stamp. ($(TECHNICAL_HTML).stamp) ($(TUTORIAL_HTML).stamp) ($(WHITE_PAPER_HTML).stamp) ($(REF_GUIDE_HTML).stamp): Turn targets into... ($(srcdir)/$(TECHNICAL).stamp) ($(srcdir)/$(TUTORIAL).stamp) ($(srcdir)/$(WHITE_PAPER).stamp) ($(srcdir)/$(REF_GUIDE).stamp): ...this. Adjust rules to generate outputs in a subdirectory. ($(TECHNICAL_HTML_OUTPUTS)) ($(TUTORIAL_HTML_OUTPUTS)) ($(WHITE_PAPER_HTML_OUTPUTS)) ($(REF_GUIDE_HTML_OUTPUTS)): Turn targets into... ($(srcdir)/$(TECHNICAL)) ($(srcdir)/$(TUTORIAL)) ($(srcdir)/$(WHITE_PAPER)) ($(srcdir)/$(REF_GUIDE)): ...this. Adjust. ($(TUTORIAL_HH)): Depend on $(srcdir)/$(TUTORIAL).stamp. Adjust rule. ($(REF_GUIDE_HH)): Depend on (srcdir)/$(REF_GUIDE).stamp. Adjust rule. (dist_html_DATA): Remove. (DATA_html_dirs): New. (EXTRA_DIST): Add $(DATA_html_dirs). --- milena/ChangeLog | 121 ++++++++ milena/doc/.gitignore | 33 +-- milena/doc/Makefile.am | 309 ++++++++++---------- milena/doc/{white_paper => }/figures/house.png | Bin 26653 -> 26653 bytes milena/doc/{white_paper => }/figures/house_rag.png | Bin 9454 -> 9454 bytes .../doc/{white_paper => }/figures/house_wshed.png | Bin 27668 -> 27668 bytes .../figures/house_wshed_mean_colors.png | Bin 6618 -> 6618 bytes .../figures => figures/technical}/file_layout.pdf | Bin 26680 -> 26680 bytes .../figures => figures/technical}/file_layout.png | Bin 117801 -> 117801 bytes milena/doc/graphicx.hva | 3 + .../doc/{ref_guide/ref_guide.tex => ref-guide.tex} | 0 .../designs/properties/values.txt | 0 .../designs/site_psite_piter/README | 0 milena/doc/{technical => }/technical.tex | 6 +- .../doc/{tutorial => tutorial.old}/design/Makefile | 0 .../{tutorial => tutorial.old}/design/design.tex | 0 .../design/include/imagetours.tex | 0 .../design/include/properties.tex | 0 .../{tutorial => tutorial.old}/doxyfile_tuto.local | 0 .../doc/{tutorial => tutorial.old}/image_types.txt | 0 .../{tutorial => tutorial.old}/image_values.txt | 0 .../doc/{tutorial => tutorial.old}/images_tour.txt | 0 milena/doc/{tutorial => tutorial.old}/slides.tex | 0 milena/doc/{tutorial => }/tutorial.tex | 0 .../white_paper.tex => white-paper.tex} | 0 25 files changed, 291 insertions(+), 181 deletions(-) rename milena/doc/{white_paper => }/figures/house.png (100%) rename milena/doc/{white_paper => }/figures/house_rag.png (100%) rename milena/doc/{white_paper => }/figures/house_wshed.png (100%) rename milena/doc/{white_paper => }/figures/house_wshed_mean_colors.png (100%) rename milena/doc/{technical/figures => figures/technical}/file_layout.pdf (100%) rename milena/doc/{technical/figures => figures/technical}/file_layout.png (100%) create mode 100644 milena/doc/graphicx.hva rename milena/doc/{ref_guide/ref_guide.tex => ref-guide.tex} (100%) rename milena/doc/{technical => technical.old}/designs/properties/values.txt (100%) rename milena/doc/{technical => technical.old}/designs/site_psite_piter/README (100%) rename milena/doc/{technical => }/technical.tex (96%) rename milena/doc/{tutorial => tutorial.old}/design/Makefile (100%) rename milena/doc/{tutorial => tutorial.old}/design/design.tex (100%) rename milena/doc/{tutorial => tutorial.old}/design/include/imagetours.tex (100%) rename milena/doc/{tutorial => tutorial.old}/design/include/properties.tex (100%) rename milena/doc/{tutorial => tutorial.old}/doxyfile_tuto.local (100%) rename milena/doc/{tutorial => tutorial.old}/image_types.txt (100%) rename milena/doc/{tutorial => tutorial.old}/image_values.txt (100%) rename milena/doc/{tutorial => tutorial.old}/images_tour.txt (100%) rename milena/doc/{tutorial => tutorial.old}/slides.tex (100%) rename milena/doc/{tutorial => }/tutorial.tex (100%) delete mode 100644 milena/doc/tutorial/headers.stamp rename milena/doc/{white_paper/white_paper.tex => white-paper.tex} (100%) diff --git a/milena/ChangeLog b/milena/ChangeLog index 3d0cd69..0f53ae2 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,124 @@ +2010-03-30 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + + Move LaTeX sources at the root of doc/; generate HTML in subdirs. + + * doc/tutorial/tutorial.tex, + * doc/technical/technical.tex, + * doc/ref_guide/ref_guide.tex, + * doc/white_paper/white_paper.tex: + Move... + * doc/tutorial.tex, + * doc/technical.tex, + * doc/ref-guide.tex, + * doc/white-paper.tex: + ...here. + * doc/graphicx.hva: New. + * doc/technical/figures/file_layout.pdf, + * doc/technical/figures/file_layout.png, + * doc/white_paper/figures/house.png, + * doc/white_paper/figures/house_rag.png, + * doc/white_paper/figures/house_wshed.png, + * doc/white_paper/figures/house_wshed_mean_colors.png: + Move... + * doc/figures/technical/file_layout.pdf, + * doc/figures/technical/file_layout.png, + * doc/figures/house.png, + * doc/figures/house_rag.png, + * doc/figures/house_wshed.png, + * doc/figures/house_wshed_mean_colors.png: + ...here. + * doc/technical.tex: Adjust paths. + * doc/technical/designs/, + * doc/tutorial/designs/, + * doc/tutorial/doxyfile_tuto.local, + * doc/tutorial/image_types.txt, + * doc/tutorial/image_values.txt, + * doc/tutorial/images_tour.txt, + * doc/tutorial/slides.tex: + Rename as... + * doc/technical.old/designs/, + * doc/tutorial.old/design/, + * doc/tutorial.old/doxyfile_tuto.local, + * doc/tutorial.old/image_types.txt, + * doc/tutorial.old/image_values.txt, + * doc/tutorial.old/images_tour.txt, + * doc/tutorial.old/slides.tex: + ...this. + * tutorial/headers.stamp: Remove. + * doc/Makefile.am (REFMAN_deps): Rename as... + (refman_dependencies): ...this. + Adjust paths. + ($(srcdir)/user-refman.stamp, $(srcdir)/devel-refman.stamp): + Adjust. + (PNGS, EPSS): Remove. + (.png.eps): Remove rule. + (TECHNICAL_FIGURES, WHITE_PAPER_FIGURES): New. + (MORE_FIGURES): Add $(TECHNICAL_FIGURES) and + $(WHITE_PAPER_FIGURES). + (technical_dir, tutorial_dir, white_paper_dir, ref_guide_dir): + Remove. + (TECHNICAL, TUTORIAL, WHITE_PAPER, REF_GUIDE): New. + (TECHNICAL_PDF, TUTORIAL_PDF, WHITE_PAPER_PDF, REF_GUIDE_PDF) + (TUTORIAL_HH, REF_GUIDE_HH) + (EXTRA_DIST, MAINTAINERCLEANFILES): Adjust. + Remove (EPSS). + (EXTRA_DIST): Remove $(PNGS). + Add graphicx.hva. + (technical_dependencies) + (tutorial_dependencies) + (ref_guide_dependencies): + Rename as... + (TECHNICAL_deps) + (TUTORIAL_deps) + (REF_GUIDE_deps): + ...this. + (TECHNICAL_deps): Add $(TECHNICAL_FIGURES). + (WHITE_PAPER_deps): New. + ($(TECHNICAL_PDF)) + ($(TUTORIAL_PDF)) + ($(WHITE_PAPER_PDF)) + ($(REF_GUIDE_PDF)): + Adjust. + (TECHNICAL_HTML, TECHNICAL_HTML_OUTPUTS) + (TUTORIAL_HTML, TUTORIAL_HTML_OUTPUTS) + (WHITE_PAPER_HTML, WHITE_PAPER_HTML_OUTPUTS) + (REF_GUIDE_HTML, REF_GUIDE_HTML_OUTPUTS): + Remove. + (all-local): Depend on + $(srcdir)/$(TECHNICAL).stamp, + $(srcdir)/$(TUTORIAL).stamp, + $(srcdir)/$(WHITE_PAPER).stamp and + $(srcdir)/$(REF_GUIDE).stamp. + ($(TECHNICAL_HTML).stamp) + ($(TUTORIAL_HTML).stamp) + ($(WHITE_PAPER_HTML).stamp) + ($(REF_GUIDE_HTML).stamp): + Turn targets into... + ($(srcdir)/$(TECHNICAL).stamp) + ($(srcdir)/$(TUTORIAL).stamp) + ($(srcdir)/$(WHITE_PAPER).stamp) + ($(srcdir)/$(REF_GUIDE).stamp): + ...this. + Adjust rules to generate outputs in a subdirectory. + ($(TECHNICAL_HTML_OUTPUTS)) + ($(TUTORIAL_HTML_OUTPUTS)) + ($(WHITE_PAPER_HTML_OUTPUTS)) + ($(REF_GUIDE_HTML_OUTPUTS)): + Turn targets into... + ($(srcdir)/$(TECHNICAL)) + ($(srcdir)/$(TUTORIAL)) + ($(srcdir)/$(WHITE_PAPER)) + ($(srcdir)/$(REF_GUIDE)): + ...this. + Adjust. + ($(TUTORIAL_HH)): Depend on $(srcdir)/$(TUTORIAL).stamp. + Adjust rule. + ($(REF_GUIDE_HH)): Depend on (srcdir)/$(REF_GUIDE).stamp. + Adjust rule. + (dist_html_DATA): Remove. + (DATA_html_dirs): New. + (EXTRA_DIST): Add $(DATA_html_dirs). + 2010-03-26 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; No longer generate doc/technical/technical.hh. diff --git a/milena/doc/.gitignore b/milena/doc/.gitignore index 506bfa4..3c88ad7 100644 --- a/milena/doc/.gitignore +++ b/milena/doc/.gitignore @@ -8,29 +8,16 @@ /figures/*.png -/ref_guide/ref_guide.css -/ref_guide/ref_guide.hh -/ref_guide/ref_guide.html -/ref_guide/ref_guide.pdf -/ref_guide/ref_guide0x.png +/ref-guide.hh +/ref-guide.pdf +/ref-guide/ -/technical/technical.css -/technical/technical.html -/technical/technical.pdf +/technical.pdf +/technical/ -/tutorial/tutorial.css -/tutorial/tutorial.hh -/tutorial/tutorial.html -/tutorial/tutorial.pdf +/tutorial.hh +/tutorial.pdf +/tutorial/ -/white_paper/figures/house.eps -/white_paper/figures/house_rag.eps -/white_paper/figures/house_wshed.eps -/white_paper/figures/house_wshed_mean_colors.eps -/white_paper/white_paper.css -/white_paper/white_paper.html -/white_paper/white_paper.pdf -/white_paper/white_paper0x.png -/white_paper/white_paper1x.png -/white_paper/white_paper2x.png -/white_paper/white_paper3x.png +/white-paper.pdf +/white-paper/ diff --git a/milena/doc/Makefile.am b/milena/doc/Makefile.am index 25116c1..dcdca5a 100644 --- a/milena/doc/Makefile.am +++ b/milena/doc/Makefile.am @@ -95,8 +95,21 @@ MAINTAINERCLEANFILES += $(PNG_FIGURES) # Other figures. # # --------------- # +TECHNICAL_FIGURES = \ + figures/technical/file_layout.pdf \ + figures/technical/file_layout.png +MORE_FIGURES = $(TECHNICAL_FIGURES) + +WHITE_PAPER_FIGURES = \ + $(srcdir)/figures/house.png \ + $(srcdir)/figures/house_rag.png \ + $(srcdir)/figures/house_wshed.png \ + $(srcdir)/figures/house_wshed_mean_colors.png +MORE_FIGURES += $(WHITE_PAPER_FIGURES) + # This image seems to be used nowhere. -MORE_FIGURES = figures/accu_image_morpher_big_picture.pdf +MORE_FIGURES += figures/accu_image_morpher_big_picture.pdf + EXTRA_DIST += $(MORE_FIGURES) @@ -172,10 +185,10 @@ regen-split-examples-mk: ## Doxygen documentation. ## ## ----------------------- ## -refman_dependencies = \ +REFMAN_deps = \ $(PNG_FIGURES) \ - $(srcdir)/tutorial/tutorial.hh \ - $(srcdir)/ref_guide/ref_guide.hh + $(srcdir)/tutorial.hh \ + $(srcdir)/ref-guide.hh # ----------------------- # # User reference manual. # @@ -220,7 +233,7 @@ $(srcdir)/$(USER_REFMAN_PDF): $(srcdir)/$(USER_REFMAN) EXTRA_DIST += $(srcdir)/user-refman.stamp MAINTAINERCLEANFILES += $(srcdir)/user-refman.stamp -$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) +$(srcdir)/user-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp -rm -rf $(USER_REFMAN).tmp @@ -289,7 +302,7 @@ $(srcdir)/$(DEVEL_REFMAN_PDF): $(srcdir)/$(DEVEL_REFMAN) cp -f $(srcdir)/$(DEVEL_REFMAN)/latex/refman.pdf $@ MAINTAINERCLEANFILES += $(srcdir)/devel-refman.stamp -$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(refman_dependencies) +$(srcdir)/devel-refman.stamp: $(srcdir)/$(DOXYFILE).in $(REFMAN_deps) @rm -f $@.tmp @touch $@.tmp -rm -rf $(DEVEL_REFMAN).tmp @@ -318,57 +331,59 @@ maintainer-clean-local: ## ------------------------- ## -## Technical Documentation. ## +## Technical documentation. ## ## ------------------------- ## -technical_dir = $(srcdir)/technical +EXTRA_DIST += technical.tex -technical_dependencies = \ +TECHNICAL_deps = \ + $(TECHNICAL_FIGURES) \ $(TECHNICAL_EXAMPLES) \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -TECHNICAL_HTML = $(technical_dir)/technical.html -TECHNICAL_HTML_OUTPUTS = $(TECHNICAL_HTML) $(technical_dir)/technical.css +# PDF. +TECHNICAL_PDF = $(srcdir)/technical.pdf +dist_pdf_DATA += $(TECHNICAL_PDF) +$(TECHNICAL_PDF): $(TECHNICAL_deps) -EXTRA_DIST += $(TECHNICAL_HTML).stamp -MAINTAINERCLEANFILES += $(TECHNICAL_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(TECHNICAL_HTML).stamp: $(technical_dir)/technical.tex $(technical_dependencies) +# HTML. +TECHNICAL = technical +all-local: $(srcdir)/$(TECHNICAL).stamp +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(TECHNICAL).stamp: $(srcdir)/technical.tex $(TECHNICAL_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(TECHNICAL_HTML) $< + rm -rf $(TECHNICAL).tmp + mkdir $(TECHNICAL).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(TECHNICAL).tmp/$(TECHNICAL).html $< + rm -rf $(srcdir)/$(TECHNICAL) +## FIXME: moving directories between file systems is not portable. + mv $(TECHNICAL).tmp $(srcdir)/$(TECHNICAL) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(TECHNICAL).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(TECHNICAL).stamp -$(TECHNICAL_HTML_OUTPUTS): $(TECHNICAL_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(TECHNICAL): $(srcdir)/$(TECHNICAL).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi - -dist_html_DATA = $(TECHNICAL_HTML_OUTPUTS) - -# Final product. -TECHNICAL_PDF = $(technical_dir)/technical.pdf -# Extra dependencies. -$(TECHNICAL_PDF): $(technical_dependencies) - -dist_pdf_DATA = $(TECHNICAL_PDF) - -EXTRA_DIST += $(technical_dir)/technical.tex +DATA_html_dirs = $(TECHNICAL) ## ---------- ## ## Tutorial. ## ## ---------- ## -tutorial_dir = $(srcdir)/tutorial +EXTRA_DIST += tutorial.tex -tutorial_dependencies = \ +TUTORIAL_deps = \ $(EXAMPLES) \ $(SPLIT_EXAMPLES) \ $(OUTPUTS) \ @@ -376,58 +391,57 @@ tutorial_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -TUTORIAL_HTML = $(tutorial_dir)/tutorial.html -TUTORIAL_HTML_OUTPUTS = $(TUTORIAL_HTML) $(tutorial_dir)/tutorial.css +# PDF. +TUTORIAL_PDF = $(srcdir)/tutorial.pdf +dist_pdf_DATA += $(TUTORIAL_PDF) +$(TUTORIAL_PDF): $(TUTORIAL_deps) -EXTRA_DIST += $(TUTORIAL_HTML).stamp -MAINTAINERCLEANFILES += $(TUTORIAL_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(TUTORIAL_HTML).stamp: $(tutorial_dir)/tutorial.tex $(tutorial_dependencies) +# HTML. +TUTORIAL = tutorial +all-local: $(srcdir)/$(TUTORIAL).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(TUTORIAL).stamp: $(srcdir)/tutorial.tex $(TUTORIAL_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(TUTORIAL_HTML) $< + rm -rf $(TUTORIAL).tmp + mkdir $(TUTORIAL).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(TUTORIAL).tmp/$(TUTORIAL).html $< + rm -rf $(srcdir)/$(TUTORIAL) +## FIXME: moving directories between file systems is not portable. + mv $(TUTORIAL).tmp $(srcdir)/$(TUTORIAL) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(TUTORIAL).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(TUTORIAL).stamp -$(TUTORIAL_HTML_OUTPUTS): $(TUTORIAL_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(TUTORIAL): $(srcdir)/$(TUTORIAL).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi +DATA_html_dirs += $(TUTORIAL) -dist_html_DATA += $(TUTORIAL_HTML_OUTPUTS) - -# Intermediate product for the various doc targets of the parent -# directory. +# Intermediate product for the (Doxygen) User Reference Manual. # # This is not a bug: TUTORIAL_HH is meant to have a `.hh' extension, # since it is later parsed by Doxygen, which complains about `.html' # files. -TUTORIAL_HH = $(tutorial_dir)/tutorial.hh -$(TUTORIAL_HH): $(TUTORIAL_HTML) $(srcdir)/tools/todoxygen.sh +TUTORIAL_HH = $(srcdir)/tutorial.hh +$(TUTORIAL_HH): $(srcdir)/$(TUTORIAL).stamp $(srcdir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it # again. The solution is to use a temporary file as output and rename # it if the script succeeds. rm -f $@.tmp - $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) + $(srcdir)/tools/todoxygen.sh \ + $(srcdir)/$(TUTORIAL)/$(TUTORIAL).html $@.tmp $(srcdir) mv -f $@.tmp $@ - - -# Final product. -TUTORIAL_PDF = $(tutorial_dir)/tutorial.pdf -# Extra dependencies. -$(TUTORIAL_PDF): $(tutorial_dependencies) - -dist_pdf_DATA += $(TUTORIAL_PDF) - -EXTRA_DIST += \ - $(tutorial_dir)/tutorial.tex \ - $(TUTORIAL_HH) - +EXTRA_DIST += $(TUTORIAL_HH) MAINTAINERCLEANFILES += $(TUTORIAL_HH) @@ -435,70 +449,58 @@ MAINTAINERCLEANFILES += $(TUTORIAL_HH) ## White Paper. ## ## ------------- ## -white_paper_dir = $(srcdir)/white_paper - -PNGS = \ - $(white_paper_dir)/figures/house.png \ - $(white_paper_dir)/figures/house_rag.png \ - $(white_paper_dir)/figures/house_wshed.png \ - $(white_paper_dir)/figures/house_wshed_mean_colors.png - -EPSS = $(PNGS:png=eps) - -.png.eps: - convert $< $@ - -# Final product. -WHITE_PAPER_HTML = $(white_paper_dir)/white_paper.html -WHITE_PAPER_HTML_OUTPUTS = \ - $(WHITE_PAPER_HTML) \ - $(white_paper_dir)/white_paper.css \ - $(white_paper_dir)/white_paper0x.png \ - $(white_paper_dir)/white_paper1x.png \ - $(white_paper_dir)/white_paper2x.png \ - $(white_paper_dir)/white_paper3x.png - -EXTRA_DIST += $(WHITE_PAPER_HTML).stamp -MAINTAINERCLEANFILES += $(WHITE_PAPER_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(WHITE_PAPER_HTML).stamp: $(white_paper_dir)/white_paper.tex $(EPSS) +EXTRA_DIST += white-paper.tex graphicx.hva + +WHITE_PAPER_deps = \ + $(WHITE_PAPER_FIGURES) \ + graphicx.hva + +# PDF. +WHITE_PAPER_PDF = $(srcdir)/white-paper.pdf +dist_pdf_DATA += $(WHITE_PAPER_PDF) +$(WHITE_PAPER_PDF): $(WHITE_PAPER_deps) + +# HTML. +WHITE_PAPER = white-paper +all-local: $(srcdir)/$(WHITE_PAPER).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(WHITE_PAPER).stamp: $(srcdir)/white-paper.tex $(WHITE_PAPER_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(WHITE_PAPER_HTML) $< + rm -rf $(WHITE_PAPER).tmp + mkdir $(WHITE_PAPER).tmp +## Copy images. + mkdir $(WHITE_PAPER).tmp/figures + cp $(WHITE_PAPER_FIGURES) $(WHITE_PAPER).tmp/figures + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(WHITE_PAPER).tmp/$(WHITE_PAPER).html $< + rm -rf $(srcdir)/$(WHITE_PAPER) +## FIXME: moving directories between file systems is not portable. + mv $(WHITE_PAPER).tmp $(srcdir)/$(WHITE_PAPER) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(WHITE_PAPER).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(WHITE_PAPER).stamp -$(WHITE_PAPER_HTML_OUTPUTS): $(WHITE_PAPER_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(WHITE_PAPER): $(srcdir)/$(WHITE_PAPER).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi - -dist_html_DATA += $(WHITE_PAPER_HTML_OUTPUTS) - -WHITE_PAPER_PDF = $(white_paper_dir)/white_paper.pdf -# Extra dependencies. -$(WHITE_PAPER_PDF): $(PNGS) - -dist_pdf_DATA += $(WHITE_PAPER_PDF) - -EXTRA_DIST += \ - $(white_paper_dir)/white_paper.tex \ - $(PNGS) \ - $(EPSS) - -MAINTAINERCLEANFILES += $(EPSS) +DATA_html_dirs += $(WHITE_PAPER) ## ----------------- ## ## Reference Guide. ## ## ----------------- ## -ref_guide_dir = $(srcdir)/ref_guide +EXTRA_DIST += ref-guide.tex -ref_guide_dependencies = \ +REF_GUIDE_deps = \ $(EXAMPLES) \ $(SPLIT_EXAMPLES) \ $(OUTPUTS) \ @@ -506,61 +508,57 @@ ref_guide_dependencies = \ $(PNG_FIGURES) \ $(DOC_PACKAGES) -# Final product. -REF_GUIDE_HTML = $(ref_guide_dir)/ref_guide.html -REF_GUIDE_HTML_OUTPUTS = \ - $(REF_GUIDE_HTML) \ - $(ref_guide_dir)/ref_guide.css \ - $(ref_guide_dir)/ref_guide0x.png - -EXTRA_DIST += $(REF_GUIDE_HTML).stamp -MAINTAINERCLEANFILES += $(REF_GUIDE_HTML).stamp -# HTML outputs contains several files (the HTML file itself, its CSS -# style sheet, possibly some images). Therefore, we cannot rely on a -# simple suffix rule to produce them. -$(REF_GUIDE_HTML).stamp: $(ref_guide_dir)/ref_guide.tex $(ref_guide_dependencies) +# PDF. +REF_GUIDE_PDF = $(srcdir)/ref-guide.pdf +dist_pdf_DATA += $(REF_GUIDE_PDF) +$(REF_GUIDE_PDF): $(REF_GUIDE_deps) + +# HTML. +REF_GUIDE = ref-guide +all-local: $(srcdir)/$(REF_GUIDE).stamp + +# The HTML output contains several files (the HTML file itself, its +# CSS style sheet, possibly some images). Therefore, we cannot rely +# on a simple suffix rule to produce them. Instead, put the products +# in a directory and use a time stamp. +$(srcdir)/$(REF_GUIDE).stamp: $(srcdir)/ref-guide.tex $(REF_GUIDE_deps) @rm -f $@.tmp @touch $@.tmp - $(TEXI2HTML) $(TEXI2HTML_FLAGS) -o $(REF_GUIDE_HTML) $< + rm -rf $(REF_GUIDE).tmp + mkdir $(REF_GUIDE).tmp + $(TEXI2HTML) $(TEXI2HTML_FLAGS) \ + -o $(REF_GUIDE).tmp/$(REF_GUIDE).html $< + rm -rf $(srcdir)/$(REF_GUIDE) +## FIXME: moving directories between file systems is not portable. + mv $(REF_GUIDE).tmp $(srcdir)/$(REF_GUIDE) @mv -f $@.tmp $@ +EXTRA_DIST += $(srcdir)/$(REF_GUIDE).stamp +MAINTAINERCLEANFILES += $(srcdir)/$(REF_GUIDE).stamp -$(REF_GUIDE_HTML_OUTPUTS): $(REF_GUIDE_HTML).stamp -## Recover from the removal of $@ - @if test -f $@; then :; else \ +$(srcdir)/$(REF_GUIDE): $(srcdir)/$(REF_GUIDE).stamp +## Recover from the removal of $@. + @if test -d $@; then :; else \ rm -f $<; \ $(MAKE) $(AM_MAKEFLAGS) $<; \ fi +DATA_html_dirs += $(REF_GUIDE) -dist_html_DATA += $(REF_GUIDE_HTML_OUTPUTS) - -# Intermediate product for the various doc targets of the parent -# directory. +# Intermediate product for the (Doxygen) User Reference Manual. # # This is not a bug: REF_GUIDE_HH is meant to have a `.hh' extension, # since it is later parsed by Doxygen, which complains about `.html' # files. -REF_GUIDE_HH = $(ref_guide_dir)/ref_guide.hh -$(REF_GUIDE_HH): $(REF_GUIDE_HTML) $(srcdir)/tools/todoxygen.sh +REF_GUIDE_HH = $(srcdir)/ref-guide.hh +$(REF_GUIDE_HH): $(srcdir)/$(REF_GUIDE).stamp $(srcdir)/tools/todoxygen.sh # The script `todoxygen.sh' may fail and still create a (partial and # invalid) file, thus preventing Make from trying to generate it # again. The solution is to use a temporary file as output and rename # it if the script succeeds. rm -f $@.tmp - $(srcdir)/tools/todoxygen.sh $< $@.tmp $(srcdir) + $(srcdir)/tools/todoxygen.sh \ + $(srcdir)/$(REF_GUIDE)/$(REF_GUIDE).html $@.tmp $(srcdir) mv -f $@.tmp $@ - - -# Final product. -REF_GUIDE_PDF = $(ref_guide_dir)/ref_guide.pdf -# Extra dependencies. -$(REF_GUIDE_PDF): $(ref_guide_dependencies) - -dist_pdf_DATA += $(REF_GUIDE_PDF) - -EXTRA_DIST += \ - $(ref_guide_dir)/ref_guide.tex \ - $(REF_GUIDE_HH) - +EXTRA_DIST += $(REF_GUIDE_HH) MAINTAINERCLEANFILES += $(REF_GUIDE_HH) @@ -720,6 +718,7 @@ MAINTAINERCLEANFILES += $(dist_html_DATA) $(dist_pdf_DATA) EXTRA_DIST += \ + $(DATA_html_dirs) \ $(DOXYFILE).in \ groups/accu.hh \ groups/graph.hh \ diff --git a/milena/doc/white_paper/figures/house.png b/milena/doc/figures/house.png similarity index 100% rename from milena/doc/white_paper/figures/house.png rename to milena/doc/figures/house.png diff --git a/milena/doc/white_paper/figures/house_rag.png b/milena/doc/figures/house_rag.png similarity index 100% rename from milena/doc/white_paper/figures/house_rag.png rename to milena/doc/figures/house_rag.png diff --git a/milena/doc/white_paper/figures/house_wshed.png b/milena/doc/figures/house_wshed.png similarity index 100% rename from milena/doc/white_paper/figures/house_wshed.png rename to milena/doc/figures/house_wshed.png diff --git a/milena/doc/white_paper/figures/house_wshed_mean_colors.png b/milena/doc/figures/house_wshed_mean_colors.png similarity index 100% rename from milena/doc/white_paper/figures/house_wshed_mean_colors.png rename to milena/doc/figures/house_wshed_mean_colors.png diff --git a/milena/doc/technical/figures/file_layout.pdf b/milena/doc/figures/technical/file_layout.pdf similarity index 100% rename from milena/doc/technical/figures/file_layout.pdf rename to milena/doc/figures/technical/file_layout.pdf diff --git a/milena/doc/technical/figures/file_layout.png b/milena/doc/figures/technical/file_layout.png similarity index 100% rename from milena/doc/technical/figures/file_layout.png rename to milena/doc/figures/technical/file_layout.png diff --git a/milena/doc/graphicx.hva b/milena/doc/graphicx.hva new file mode 100644 index 0000000..ff95ca7 --- /dev/null +++ b/milena/doc/graphicx.hva @@ -0,0 +1,3 @@ + % -*- LaTeX -*- + +\newcommand{\includegraphics}[2][]{\imgsrc{#2.png}} diff --git a/milena/doc/ref_guide/ref_guide.tex b/milena/doc/ref-guide.tex similarity index 100% rename from milena/doc/ref_guide/ref_guide.tex rename to milena/doc/ref-guide.tex diff --git a/milena/doc/technical/designs/properties/values.txt b/milena/doc/technical.old/designs/properties/values.txt similarity index 100% rename from milena/doc/technical/designs/properties/values.txt rename to milena/doc/technical.old/designs/properties/values.txt diff --git a/milena/doc/technical/designs/site_psite_piter/README b/milena/doc/technical.old/designs/site_psite_piter/README similarity index 100% rename from milena/doc/technical/designs/site_psite_piter/README rename to milena/doc/technical.old/designs/site_psite_piter/README diff --git a/milena/doc/technical/technical.tex b/milena/doc/technical.tex similarity index 96% rename from milena/doc/technical/technical.tex rename to milena/doc/technical.tex index 198bcd6..4afc908 100644 --- a/milena/doc/technical/technical.tex +++ b/milena/doc/technical.tex @@ -131,15 +131,15 @@ reference documents available here: Writing a new routine in Milena requires a specific layout in the -code. This layout is described in figure \ref{figures/file_layout}. +code. This layout is described in figure \ref{figures/technical/file_layout}. \begin{center} - \doxyimg{figures/file_layout}{8cm} + \doxyimg{figures/technical/file_layout}{8cm} \end{center} For a better understanding, we are going to comment this figure -(fig. \ref{figures/file_layout}) from the bottom to the top. +(fig. \ref{figures/technical/file_layout}) from the bottom to the top. \begin{itemize} \item \textbf{Facade}. The facade is the public routine that will be diff --git a/milena/doc/tutorial/design/Makefile b/milena/doc/tutorial.old/design/Makefile similarity index 100% rename from milena/doc/tutorial/design/Makefile rename to milena/doc/tutorial.old/design/Makefile diff --git a/milena/doc/tutorial/design/design.tex b/milena/doc/tutorial.old/design/design.tex similarity index 100% rename from milena/doc/tutorial/design/design.tex rename to milena/doc/tutorial.old/design/design.tex diff --git a/milena/doc/tutorial/design/include/imagetours.tex b/milena/doc/tutorial.old/design/include/imagetours.tex similarity index 100% rename from milena/doc/tutorial/design/include/imagetours.tex rename to milena/doc/tutorial.old/design/include/imagetours.tex diff --git a/milena/doc/tutorial/design/include/properties.tex b/milena/doc/tutorial.old/design/include/properties.tex similarity index 100% rename from milena/doc/tutorial/design/include/properties.tex rename to milena/doc/tutorial.old/design/include/properties.tex diff --git a/milena/doc/tutorial/doxyfile_tuto.local b/milena/doc/tutorial.old/doxyfile_tuto.local similarity index 100% rename from milena/doc/tutorial/doxyfile_tuto.local rename to milena/doc/tutorial.old/doxyfile_tuto.local diff --git a/milena/doc/tutorial/image_types.txt b/milena/doc/tutorial.old/image_types.txt similarity index 100% rename from milena/doc/tutorial/image_types.txt rename to milena/doc/tutorial.old/image_types.txt diff --git a/milena/doc/tutorial/image_values.txt b/milena/doc/tutorial.old/image_values.txt similarity index 100% rename from milena/doc/tutorial/image_values.txt rename to milena/doc/tutorial.old/image_values.txt diff --git a/milena/doc/tutorial/images_tour.txt b/milena/doc/tutorial.old/images_tour.txt similarity index 100% rename from milena/doc/tutorial/images_tour.txt rename to milena/doc/tutorial.old/images_tour.txt diff --git a/milena/doc/tutorial/slides.tex b/milena/doc/tutorial.old/slides.tex similarity index 100% rename from milena/doc/tutorial/slides.tex rename to milena/doc/tutorial.old/slides.tex diff --git a/milena/doc/tutorial/tutorial.tex b/milena/doc/tutorial.tex similarity index 100% rename from milena/doc/tutorial/tutorial.tex rename to milena/doc/tutorial.tex diff --git a/milena/doc/tutorial/headers.stamp b/milena/doc/tutorial/headers.stamp deleted file mode 100644 index e69de29..0000000 diff --git a/milena/doc/white_paper/white_paper.tex b/milena/doc/white-paper.tex similarity index 100% rename from milena/doc/white_paper/white_paper.tex rename to milena/doc/white-paper.tex -- 1.5.6.5