documentation: build html as one big file

Dimitrie O. Paun dpaun at rogers.com
Thu Sep 18 18:11:15 CDT 2003


I find this a lot more easy to read, work with, etc.
It also makes it a lot easier to distribute in
/usr/share/doc/wine, etc.

As a user, I see only one file, it's clear. It makes
reading a lot more pleasurable as you don't have to
constantly click (big problem for people that have
wrist problems, like myself). The only downside is for
people with slow connections, but even that does not
apply because they would have to download the entire
tarball anyway.

As an added bonus, it cleans up the Makefile a bit too.

ChangeLog
    Build the HTML documents as one big file.

Index: documentation/Makefile.in
===================================================================
RCS file: /var/cvs/wine/documentation/Makefile.in,v
retrieving revision 1.36
diff -u -r1.36 Makefile.in
--- documentation/Makefile.in	18 Sep 2003 20:51:32 -0000	1.36
+++ documentation/Makefile.in	18 Sep 2003 22:00:45 -0000
@@ -65,16 +65,16 @@
 
 everything: $(MAN_TARGETS) doc
 doc: html pdf ps
-html: $(ALLBOOKS:%=%/index.html) wine-faq.html
+html: $(ALLBOOKS:%=%.html) wine-faq.html
 pdf: $(ALLBOOKS:%=%.pdf)
 ps: $(ALLBOOKS:%=%.ps)
 
 .PHONY: everything doc html pdf ps dist
 
-.SUFFIXES: .sgml /index.html .pdf .ps
+.SUFFIXES: .sgml .html .pdf .ps
 
-.sgml/index.html:
-	$(DB2HTML) -d $(SRCDIR)/default.dsl -o $* $<
+.sgml.html:
+	$(DB2HTML) -u -d $(SRCDIR)/default.dsl $<
 
 .sgml.pdf:
 	$(DB2PDF) $< >/dev/null
@@ -82,15 +82,13 @@
 .sgml.ps:
 	$(DB2PS) $< >/dev/null
 
-wine-devel.pdf wine-devel.ps wine-devel/index.html: $(WINE_DEVEL_SRCS)
-wine-user.pdf wine-user.ps wine-user/index.html: $(WINE_USER_SRCS)
-winelib-user.pdf winelib-user.ps winelib-user/index.html: $(WINELIB_USER_SRCS)
+%.txt: %.html
+	w3m -dump $< > $@ || ($(RM) $@ && false)
 
+wine-devel.pdf wine-devel.ps wine-devel.html: $(WINE_DEVEL_SRCS)
+wine-user.pdf wine-user.ps wine-user.html: $(WINE_USER_SRCS)
+winelib-user.pdf winelib-user.ps winelib-user.html: $(WINELIB_USER_SRCS)
 wine-faq.html: wine-faq.sgml $(WINE_FAQ_SRCS)
-	$(DB2HTML) -u -d $(SRCDIR)/default.dsl $(SRCDIR)/wine-faq.sgml
-
-wine-faq.txt: wine-faq.html
-	w3m -dump wine-faq.html > $@ || ($(RM) $@ && false)
 
 wine.man: wine.man.in
 	sed -e 's, at bindir\@,$(bindir),g' -e 's, at dlldir\@,$(dlldir),g' -e 's, at PACKAGE_STRING\@, at PACKAGE_STRING@,g' $(SRCDIR)/wine.man.in >$@ || ($(RM) $@ && false)
@@ -105,12 +103,11 @@
 wine-doc-pdf.tar.gz: $(ALLBOOKS:%=%.pdf)
 	tar cf - $(ALLBOOKS:%=%.pdf) | gzip -9 > $@ || ($(RM) $@ && false)
 
-wine-doc-html.tar.gz: $(ALLBOOKS:%=%/index.html)
-	tar cf - $(ALLBOOKS:%=%/*.html) | gzip -9 > $@ || ($(RM) $@ && false)
+wine-doc-html.tar.gz: $(ALLBOOKS:%=%.html)
+	tar cf - $(ALLBOOKS:%=%.html) | gzip -9 > $@ || ($(RM) $@ && false)
 
-wine-doc-txt.tar.gz: $(ALLBOOKS:%=%/index.html)
-	for i in $(ALLBOOKS:%=%/*.html); do w3m -dump $$i > `dirname $$i`/`basename $$i .html`.txt || exit 1; done
-	tar cf - $(ALLBOOKS:%=%/*.txt) | gzip -9 > $@ || ($(RM) $@ && false)
+wine-doc-txt.tar.gz: $(ALLBOOKS:%=%.txt)
+	tar cf - $(ALLBOOKS:%=%.txt) | gzip -9 > $@ || ($(RM) $@ && false)
 
 install:: $(MAN_TARGETS)
 	$(MKINSTALLDIRS) $(mandir)/man$(prog_manext) $(mandir)/man$(conf_manext) $(mandir)/man$(api_manext)
@@ -126,6 +123,6 @@
 
 clean::
 	$(RM) *.aux *.dvi *.out *.pdf *.ps *.tex *.log *.html wine-doc-*.tar.gz wine-faq.txt $(MAN_TARGETS)
-	$(RM) -r $(ALLBOOKS) html api-guide man$(api_manext) *.junk DBTOHTML_OUTPUT_DIR*
+	$(RM) -r html api-guide man$(api_manext) *.junk DBTOHTML_OUTPUT_DIR*
 
 ### Dependencies:
Index: documentation/.cvsignore
===================================================================
RCS file: /var/cvs/wine/documentation/.cvsignore,v
retrieving revision 1.12
diff -u -r1.12 .cvsignore
--- documentation/.cvsignore	18 Sep 2003 20:51:32 -0000	1.12
+++ documentation/.cvsignore	18 Sep 2003 21:14:50 -0000
@@ -9,8 +9,5 @@
 *.tex
 DBTOHTML_OUTPUT_DIR*
 Makefile
-wine-devel
 wine-faq.txt
-wine-user
 wine.man
-winelib-user


-- 
Dimi.




More information about the wine-patches mailing list