Changing headers/footers in PDF output
Brought to you by:
dimitri
Menu
▾
▴
I'm a new user of DOxygen, and I'm trying to figure out how to set a document's header and footer to follow my organization's publication standards.
We want to publish in PDF format. I have some problems making DOxygen go that, which I'm addressing in another thread. However, it appears that DOxygen's header and footer definitions - files identified by the HTML_HEADER and HTML_FOOTER tags - not only have to be expressed in HTML, but are specific to HTML output, and won't affect PDF output.
That raises the question: how do I define headers and footers for PDF output? I can't find anything in the DOxygen documentation, or in the wizard, that explains it.
The only answer I've come up with is to hack the .sty file that DOxygen generates with TEX output. There are a couple of problems with that. One is: how do I do it? I've used TEX a bit, but the stuff in the .sty file is way beyond me. I wouldn't relish explaining to my boss that I'll have to become a TEX guru to change DOxygen's headings and footings.
The more serious problem (at least, technically more serious) is that DOxygen presumably regenerates the .sty file every time it's run. Must I hack it again each time? Or am I supposed to keep it elsewhere and copy it back into DOxygen's output directory each time, and remember to merge the changes if I do anything to DOxygen's config file that changes the generated .sty file? That's so hokey that I can't believe it's the right answer. There must be a more reasonable solution, but I don't know where to look for it.
I think you can create a set of default files, change them and use them for each creation process.
There is a set of settings for LaTeX like the ones for HTML and you can use
to generate the default style, header and footer files to be used for the LATEX_HEADER, etc. settings.
I just spent 1 minute to get this information from the documentation ;-)
Stefan, thank you for the pointer. When I find a solution to the "make" problem so that I can compare the contents of the intermediate files to their effects on the output, I'm sure this will become clear.
Regarding the amount of time it takes to find the information… anyone can find almost anything in a minute if they know what to look for. The whole reason I'm visiting this forum was to get the assistance of people who have more experience in this area than I do, and so know what to look for.
To give you some insight into this: I searched the manual for HEADER and found the text that mentioned LATEX_HEADER in section 18.1, but most of the matches on HEADER concerned header files, and by the time I reached this text, it appeared to be just another one. Consequently I read it without realizing that it was the solution to my problem.
Don't underestimate the value of your experience. Just because you can find something in less than a minute, doesn't mean it's trivial. ;)
You are right about searching, since you can use the wrong combination of terms and you will get no hit at all, but removing one word and the first hit can be the solution.
What I did was to open the doxygen documentation and selecting the Configuration section, which opened a page with all configuration options listed.
Scanning through them I just noticed the LATEX_HEADER entry and clicked it.
It is sometimes better not to search at all ;-)
Stumbling along to my goal, I've hit another roadblock. This is probably a really dumb problem, the solution isn't revealing itself to me.
I generated the header, footer, and style sheet with the DOxygen wizard's -w option.
I discovered that LATEX_HEADER and LATEX_FOOTER specify "header" and "footer" files for the document, and not the running headers and footers for the pages, as I assumed. But I see how I can control the running headers and footers by changing the fancyhead and fancyfoot definitions in the project's .sty file.
But… once I do that, how do I tell DOxygen to use that .sty file instead of generating a new default one and using it in each run? I'd expect to find an option for specifying a style file in the Expert tab's LaTeX section, along with the LATEX_HEADER and LATEX_FOOTER options. It's not there, though. I've looked for it in the other sections of the Expert tab, but I it's not anywhere I've looked, or else I've missed it.
I have noticed this too.
It would be nice to have a LATEX_STYLE setting, which would allow me to tweak the table output, that I am struggling with.
Opened enhancement https://bugzilla.gnome.org/show_bug.cgi?id=668066 for the support of LATEX_STYLE setting.
I've got everything I need for the moment. Thanks for your help.
I have one last question, concerning something I had to kludge (apart from LATEX_STYLE).
My assignment requires me to generate output in both letter size and A4 format. I tried to do that by changing the front end's PAPER_TYPE setting from A4 to "letter." It didn't work. I kept getting A4 output. I tried saving the config file before clicking Run, but that made no difference.
I was able to change the paper size by editing the .tex file that DOxygen generates. It's a one-line change, but that is, as I said, a kludge.
Do I misunderstand something about how the front end works? Or is this a bug that should be reported?
The PAPER_TYPE is the correct way to change this, but if you use a custom LATEX_HEADER, you need to change that too.
In general I would create two DoxyFile files one called DoxyFile_A4 and one DoxyFile_Letter, this way you run the creation process twice, once with each paper format.
BTW, I have added a working replacement for "make pdf" on Windows to the bug tracker as make_pdf.cmd.
See https://bugzilla.gnome.org/show_bug.cgi?id=668010#c2
I am using this in my project with success.