Re: docs: faq build

[Alexandre Julliard]

"Dimitrie O. Paun"  writes:
> The fact that the FAQ is now SGML does not warant
> building it in all sorts of formats, and including
> it in the docs tarball. Just because we can, does
> not mean we should.
>
> In fact, theoretically we should move this over
> to the lostwages/ modules, this is part of the
> WineHQ proper, not the wine tree.

I'm not sure I agree with that. If we make the documentation available
for download then we should have the FAQ there too, we shouldn't
require people to go to WineHQ to get it. I do agree that we don't
need all the fancy formats, in fact the download should probably be
only the plain text version.

docs: faq build

[Dimitrie O. Paun]

On Thu, 18 Sep 2003, Alexandre Julliard wrote:
> I'm not sure I agree with that. If we make the documentation available
> for download then we should have the FAQ there too, we shouldn't
> require people to go to WineHQ to get it.

I don't know, it maybe just me, for I never expect to see FAQs with
the source -- for me it's an exclusively web kind of content.
And it used to be like so with us too until recently...:) But if
people feel that it has a place with the other stuff, I guess
I can live with it.
> I do agree that we don't
> need all the fancy formats, in fact the download should probably be
> only the plain text version.

Agreed. What about this:

ChangeLog
    Dimitrie O. Paun 
    Build only the text version of the docu for the download tarball.
    Build the FAQ as a single HTML file named wine-faq.html.

Index: documentation/Makefile.in
===================================================================
RCS file: /var/cvs/wine/documentation/Makefile.in,v
retrieving revision 1.35
diff -u -r1.35 Makefile.in
--- documentation/Makefile.in	17 Sep 2003 22:38:39 -0000	1.35
+++ documentation/Makefile.in	18 Sep 2003 18:51:33 -0000
@@ -56,7 +56,6 @@

ALLBOOKS = \
    wine-devel \
-	wine-faq \
    wine-user \
    winelib-user

@@ -84,10 +83,12 @@
    $(DB2PS) $< >/dev/null

wine-devel.pdf wine-devel.ps wine-devel/index.html: $(WINE_DEVEL_SRCS)
-wine-faq.pdf wine-faq.ps wine-faq/index.html: $(WINE_FAQ_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)

+wine-faq.html: wine-faq.sgml $(WINE_FAQ_SRCS)
+	$(DB2HTML) -u -d $(SRCDIR)/default.dsl $<
+
 wine.man: wine.man.in
    sed -e 's,@bindir@,$(bindir),g' -e 's,@dlldir@,$(dlldir),g' -e 's,@PACKAGE_STRING@,@PACKAGE_STRING@,g' $(SRCDIR)/wine.man.in >$@ || ($(RM) $@ && false)

@@ -95,18 +96,10 @@

dist: wine-doc-ps.tar.gz wine-doc-pdf.tar.gz wine-doc-html.tar.gz wine-doc-txt.tar.gz

-wine-doc-ps.tar.gz: $(ALLBOOKS:%=%.ps)
-	tar cf - $(ALLBOOKS:%=%.ps) | gzip -9 > $@ || ($(RM) $@ && false)
-
-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-txt.tar.gz: $(ALLBOOKS:%=%/index.html)
+wine-doc-txt.tar.gz: $(ALLBOOKS:%=%/index.html) wine-faq.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)
+	w3m -dump wine-faq.html > wine-faq.txt || exit 1
+	tar cf - $(ALLBOOKS:%=%/*.txt) wine-faq.txt | gzip -9 > $@ || ($(RM) $@ && false)

install:: $(MAN_TARGETS)
    $(MKINSTALLDIRS) $(mandir)/man$(prog_manext) $(mandir)/man$(conf_manext) $(mandir)/man$(api_manext)