From d9b15533d458250a30df5a71183ac02154914ef1 Mon Sep 17 00:00:00 2001 From: Bryan Petty Date: Fri, 6 Feb 2015 01:51:14 +0000 Subject: [PATCH] Sync with Doxygen LaTeX header. Using a custom header is an "experimental" feature since it bypasses several Doxygen configuration options, and skips configuration changes necessary for all automatically generated LaTeX. This continues to use the nicer looking custom header, but brings it up-to-date with the automatically generated one from 1.8.8. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@78450 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/Doxyfile | 4 +- docs/doxygen/latex_header.tex | 143 +++++++++++++++++++++++++++++++++ docs/doxygen/latexdocstart.inc | 62 -------------- 3 files changed, 145 insertions(+), 64 deletions(-) create mode 100644 docs/doxygen/latex_header.tex delete mode 100644 docs/doxygen/latexdocstart.inc diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 9c07cd7b1a..7c9958897a 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -435,9 +435,9 @@ LATEX_OUTPUT = latex LATEX_CMD_NAME = latex MAKEINDEX_CMD_NAME = makeindex COMPACT_LATEX = NO -PAPER_TYPE = a4wide +PAPER_TYPE = a4 EXTRA_PACKAGES = -LATEX_HEADER = latexdocstart.inc +LATEX_HEADER = latex_header.tex LATEX_FOOTER = LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES diff --git a/docs/doxygen/latex_header.tex b/docs/doxygen/latex_header.tex new file mode 100644 index 0000000000..b641552a30 --- /dev/null +++ b/docs/doxygen/latex_header.tex @@ -0,0 +1,143 @@ +\batchmode +\documentclass[twoside]{book} + +% Packages required by doxygen +\usepackage{fixltx2e} +\usepackage{calc} +\usepackage{doxygen} +\usepackage{graphicx} +\usepackage[utf8]{inputenc} +\usepackage{makeidx} +\usepackage{multicol} +\usepackage{multirow} +\PassOptionsToPackage{warn}{textcomp} +\usepackage{textcomp} +\usepackage[nointegrals]{wasysym} +\usepackage[table]{xcolor} + +% Font selection +\usepackage[T1]{fontenc} +\usepackage{mathptmx} +\usepackage[scaled=.90]{helvet} +\usepackage{courier} +\usepackage{amssymb} +\usepackage{sectsty} +\renewcommand{\familydefault}{\sfdefault} +\allsectionsfont{% + \fontseries{bc}\selectfont% + \color{darkgray}% +} +\renewcommand{\DoxyLabelFont}{% + \fontseries{bc}\selectfont% + \color{darkgray}% +} +\newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}} + +% Page & text layout +\usepackage{geometry} +\geometry{% + a4paper,% + top=2.5cm,% + bottom=2.5cm,% + left=2.5cm,% + right=2.5cm% +} +\tolerance=750 +\hfuzz=15pt +\hbadness=750 +\setlength{\emergencystretch}{15pt} +\setlength{\parindent}{0cm} +\setlength{\parskip}{0.2cm} +\makeatletter +\renewcommand{\paragraph}{% + \@startsection{paragraph}{4}{0ex}{-1.0ex}{1.0ex}{% + \normalfont\normalsize\bfseries\SS@parafont% + }% +} +\renewcommand{\subparagraph}{% + \@startsection{subparagraph}{5}{0ex}{-1.0ex}{1.0ex}{% + \normalfont\normalsize\bfseries\SS@subparafont% + }% +} +\makeatother + +% Headers & footers +\usepackage{fancyhdr} +\pagestyle{fancyplain} +\fancyhead[LE]{\fancyplain{}{\bfseries\thepage}} +\fancyhead[CE]{\fancyplain{}{}} +\fancyhead[RE]{\fancyplain{}{\bfseries\leftmark}} +\fancyhead[LO]{\fancyplain{}{\bfseries\rightmark}} +\fancyhead[CO]{\fancyplain{}{}} +\fancyhead[RO]{\fancyplain{}{\bfseries\thepage}} +\fancyfoot[LE]{\fancyplain{}{}} +\fancyfoot[CE]{\fancyplain{}{}} +\fancyfoot[RE]{\fancyplain{}{\bfseries\scriptsize Generated on Thu Feb 5 2015 13\+:49\+:29 for wx\+Widgets by Doxygen }} +\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated on Thu Feb 5 2015 13\+:49\+:29 for wx\+Widgets by Doxygen }} +\fancyfoot[CO]{\fancyplain{}{}} +\fancyfoot[RO]{\fancyplain{}{}} +\renewcommand{\footrulewidth}{0.4pt} +\renewcommand{\chaptermark}[1]{% + \markboth{#1}{}% +} +\renewcommand{\sectionmark}[1]{% + \markright{\thesection\ #1}% +} + +% Indices & bibliography +\usepackage{natbib} +\usepackage[titles]{tocloft} +\setcounter{tocdepth}{3} +\setcounter{secnumdepth}{5} +\makeindex + +% Hyperlinks (required, but should be loaded last) +\usepackage{ifpdf} +\ifpdf + \usepackage[pdftex,pagebackref=true]{hyperref} +\else + \usepackage[ps2pdf,pagebackref=true]{hyperref} +\fi +\hypersetup{% + colorlinks=true,% + linkcolor=blue,% + citecolor=blue,% + unicode% +} + +% Custom commands +\newcommand{\clearemptydoublepage}{% + \newpage{\pagestyle{empty}\cleardoublepage}% +} + + +%===== C O N T E N T S ===== + +\begin{document} + +\hypersetup{pageanchor=false, + bookmarks=true, + bookmarksnumbered=true, + pdfencoding=unicode + } + +\begin{titlepage} +\begin{center} +\vspace*{3cm} +\begin{figure}[htbp] +\includegraphics{../../images/main_wxlogo.pdf} +\end{figure} +\vspace*{2cm} +{\large Version $projectnumber}\\ +\vspace*{1cm} +{\today}\\ +\end{center} +\end{titlepage} + +\pagenumbering{roman} +\clearemptydoublepage +\tableofcontents +\clearemptydoublepage +\pagenumbering{arabic} + +\hypersetup{pageanchor=true} diff --git a/docs/doxygen/latexdocstart.inc b/docs/doxygen/latexdocstart.inc deleted file mode 100644 index fb4eb13ab9..0000000000 --- a/docs/doxygen/latexdocstart.inc +++ /dev/null @@ -1,62 +0,0 @@ -\documentclass[a4paper]{report} -\usepackage{verbatim} -\usepackage{a4wide} -\usepackage{makeidx} -\usepackage{fancyhdr} -\usepackage{multicol} -\usepackage{float} -\usepackage{textcomp} -\usepackage{alltt} -\usepackage{palatino} -\usepackage{ifpdf} -\ifpdf -\usepackage[pdftex]{graphicx} -\usepackage{epstopdf} -\usepackage[pdftex, - pagebackref=true, - colorlinks=true, - linkcolor=blue, - unicode - ]{hyperref} -\else -\usepackage{graphicx} -\usepackage[ps2pdf, - pagebackref=true, - colorlinks=true, - linkcolor=blue, - unicode - ]{hyperref} -\usepackage{pspicture} -\fi -\usepackage[utf8]{inputenc} -\usepackage{doxygen} -\usepackage{epstopdf} -\usepackage{palatino} -\setlength{\headheight}{15pt} -\sloppy -\parskip=10pt -\parindent=0pt -\makeindex -\setcounter{tocdepth}{1} -\renewcommand{\footrulewidth}{0.4pt} -\begin{document} -\begin{titlepage} -\vspace*{3cm} -\begin{center} -\begin{figure}[htbp] -\begin{center} -\includegraphics{../../images/main_wxlogo.pdf} -\end{center} -\end{figure} -\vspace*{2cm} -{\large Version 3.1.0 }\\ -\vspace*{1cm} -{Generated on \today}\\ -\end{center} -\end{titlepage} -\pagestyle{fancyplain} -\clearemptydoublepage -\pagenumbering{roman} -\tableofcontents -\clearemptydoublepage -\pagenumbering{arabic}