[ Return to Bugs & Features | Roadmap 2.0 | Post Text | Post File ]

STR #2090

Trouble Report Files:

No files

Trouble Report Comments:

	Name/Time/Date	Text
	#1  vmanis 22:04 Nov 13, 2008	I attempted to use the Makefile provided in the documentation directory to create a PDF version of the FLTK manual. This failed, even though I had appropriate versions of htmldoc and doxygen on my system. Apparently, the variable HTMLFILES was not set. Thanks to a suggestion from Michael Sweet, I enabled LaTeX generation in documentation/Doxyfile, and then, modulo a couple of minor problems, the documentation built fine. Suggested actions. 1. If the Makefile method of building the documentation is to stay, then set HTMLFILES correctly. 2. Amend documentation/README so that it says essentially the following.    ``To build the documentation via Doxygen, you will need a TeX distribution. Edit Doxyfile so that GENERATE_LATEX is set to YES. If you have a reasonably modern TeX distribution, also set LATEX_COMMAND to  pdflatex. Then run doxygen. Now cd to documentation/latex, and say `make refman.pdf'. 3. Set up the release build process so that a PDF file is automatically built, and add it to the Downloads page, then most people won't have to do either step 1 or step 2 :-). There are still a fair number of LaTeX errors while compiling the documentation. 2 encoding errors occur on the first pass; as well as a very large number of underfull and overfull boxes, as well as reports of multiply-defined cross-references. I have considerable expertise with LaTeX, and could probably fix many of these problems in the original Doxygen files. I won't go ahead and do that unless there's a sentiment that I should. For all I know, there may be a plan to switch to some other documentation build technology.

[ Return to Bugs & Features | Post Text | Post File ]