Re: [Doxygen-users] LaTeX > PDF - Contents page

[Randall, L. <l-r...@ti...>]

This is easily done in the RTF output.  All of the RTF headings contain =
the markers necessary to build a multi-level TOC.  I do not believe that =
to be true of the LaTex output. =20

It also appeared to be difficult to create a "Document Template" (a.k.a. =
"base document" -- This contains the formatted cover page, the required =
formatted legal statement, logos and marks, headers, footers, TOC, =
index, introduction, explanation of typographic conventions, etc.) in =
LaTex.  We have had a "Document Template" for each of our deliverable =
(and internal) document types for at least three years.  These were =
created in Word.  They are revision controlled, and are changed only by =
ECR and Change Control Board approval.  They reside in ClearCase under =
full configuration management.

The document creator typically opens the "Document Template" for the =
document type, sets a few file properties, pastes the Doxygen output in =
the appropriate location, prints a page (to update ALL fields -- Word =
does NOT update all fields if you use F9), saves the file, and closes =
the file.  The file properties "customize" the document to the program, =
component type, component, release, silicon, silicon rev, OS, OS ver, =
and other common variables.

We do not use the Doxygen-generated TOC or Index.  We use the headings =
(mapped to our styles) "as is" and have Word generate the TOC in the =
defined location in the document.  We also have the option of allowing =
Word to generate an index, using the Doxygen-marked entries.  Some of =
our programs need this.  If needed, the index falls at the end of the =
document.

We have a tool that "crawls" our build directories and automatically =
generates PDF from the Word documents.  Some releases may contain close =
to 100 documents.  We have many different release streams, with content =
from our programmers in at least four countries in most of them.

Regards,=20
Larry Randall =20

-----Original Message-----
From: dox...@li... =
[mailto:dox...@li...] On Behalf Of David =
Whiteman
Sent: Wednesday, June 14, 2006 09:32
To: L=F6wis, Johannes; dox...@li...
Subject: Re: [Doxygen-users] LaTeX > PDF - Contents page

So is there a way I can mark up my documentation, or alter
my configuration settings, so I can get a table of contents
at the beginning of my documentation if I should desire one?

Thanks,
David

Wednesday, June 14, 2006, 2:31:21 AM, L=F6wis, Johannes wrote:

> Hello David,

> David Whiteman wrote:
>> I am trying to produce professional-looking PDF documentation using
>> Doxygen. One thing I noticed is that the PDF document that is =
produced
>> includes on the front page that it was produced by Doxygen. What can =
I
>> do to suppress this?

> You can modify the appearance of the generated PDF by using your own
> LaTeX header and stylefile. Use the ones generated by

>   doxygen -w latex header.tex stylefile.sty

> as a starting point. You need to supply the name of your own header =
file
> in Doxyfile using the LATEX_HEADER tag.

>> Also, the 2nd page of the document has the heading Contents,
>> but nothing else on the page.  Why is there the empty
>> contents page?  I didn't think Doxygen had a way to specify
>> a table of contents, but I would either like to leave out
>> the empty contents page entirely, or build up a reasonable
>> table of contents for that page somehow.  How can I achieve
>> either?

> If using your own header and style file is not sufficient you may want
> to use a Perl script (or whatever your favourite scripting language =
for
> such a task is) to tweak the files doxygen generates. I admit that =
this
> has the disadvantage that you have to assume a certain structure of =
the
> generated files which might change when you upgrade to a newer version
> of doxygen.

> Regards
> Johannes




--=20
Regards,
David                           =20
mailto:dlw...@al...




_______________________________________________
Doxygen-users mailing list
Dox...@li...
https://lists.sourceforge.net/lists/listinfo/doxygen-users