STR #2090

FLTK matrix user chat room
(using Element browser app)   FLTK gitter user chat room   GitHub FLTK Project   FLTK News RSS Feed  
  FLTK Apps      FLTK Library      Forums      Links     Login 
 Home  |  Articles & FAQs  |  Bugs & Features  |  Documentation  |  Download  |  Screenshots  ]

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

STR #2090

Application:FLTK Library
Status:5 - New
Priority:2 - Low, e.g. a documentation error or undocumented side-effect
Scope:3 - Applies to all machines and operating systems
Summary:Incorrect instructions for building documentation
Created By:vmanis
Assigned To:Unassigned
Fix Version:Unassigned
Update Notification:

Receive EMails Don't Receive EMails

Trouble Report Files:

Post File ]

No files

Trouble Report Comments:

Post Text ]
Name/Time/Date Text top right image
#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.
bottom left image   bottom right image

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


Comments are owned by the poster. All other content is copyright 1998-2023 by Bill Spitzak and others. This project is hosted by The FLTK Team. Please report site problems to ''.