On 05.12.2010 10:36, Greg Ercolano wrote: > A few things I noticed about the docs.. maybe I'm late to the party > and this has all been discussed before: > > 1. We have eps files under svn management (documentation/src/*.eps) > which are just huge eps versions of our gif and jpeg files.
I'm not sure why they are needed, but ISTR that Fabien created them for use with the latex/PDF documentation. IIRC he used B/W images to reduce the size. > 2. The documentation/Makefile has the filenames of all the > eps/gif/jpeg files, and a dependency is set up between them, > but no rule exists to create them. (ie. if an eps file is > missing, make complains there's no rule to convert it) There's no rule to _make_ it. The dependency is not set up between individual images. I don't know what it is good for (currently), but it prevents you from starting a (maybe long running) doxygen job and getting warnings about missing images and an incomplete result. > 3. I think there's a small error in the documentation/README; > it says 'make pdf' will create fltk.pdf, but that doesn't work.. > seems 'make pdf-dist' is the correct target. I committed an updated README file and tried to clarify this. > Regarding #1 and #2, I found if I remove any of the eps files, > 'make' complains it doesn't know how to make them. But I found > it *will* automatically make them if I add a few rules to the > global makeinclude: > > a) Add (.eps .gif .jpg) to the list of .SUFFIXES > > b) Add the following two rules: > > .gif.eps: > echo Converting $<... > @convert $< $@ > > .jpg.eps: > echo Converting $<... > @convert $< $@ > > Whether or not we still need the eps files under version control, > these rules would at least help so that the dependencies will try > to resolve if ImageMagick's convert(1) program is installed. > > Suggesting to add these rules to the makeinclude.in -1 on adding these rules. I always thought that such names like 'convert' are dangerous. We would need to make sure that we run ImageMagick's convert. Here you can see why (output from my Windows 7 system with Cygwin, but I believe MinGW would be the same): $ convert Ein Dateisystem muss angegeben werden. (translated: "A file system must be specified"). $ type convert convert is hashed (/c/Windows/system32/convert) $ convert choice.gif choice.eps Unzulässiger Parameter - choice.eps (translated: "Invalid argument - choice.eps") > Also, unless there's a compelling reason to have the eps files in SVN, > it seems we could make the distro a bit lighter if we took the eps > files out, and let 'make' create them on the fly. I believe this is the same reason why Fabien proposed to include fltk.pdf in the distribution: we don't want to have too many dependencies for users. That said, I agree that we should not have too many big, generated files in the distribution. I'd be glad if we could find a better way than to include fltk.pdf (and the eps files as well) in the dist. tar balls. As for the pdf docs, we'd need a version-specific file that we can upload to the fltk web site, maybe along with the normal release and/or snapshot. It must be version-specific, because users should be able to download the files for older versions. Maybe we could create a special documentation distribution file that can be downloaded seperately? If we would do this, only users that don't have the tools would need to download the doc tar ball, and those who don't need to generate their docs would never need them. Albrecht _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
