summaryrefslogtreecommitdiffstats
path: root/templates
diff options
context:
space:
mode:
authorDimitri van Heesch <doxygen@gmail.com>2021-01-11 19:21:55 (GMT)
committerGitHub <noreply@github.com>2021-01-11 19:21:55 (GMT)
commit735203d07ce01c587b6807122e7a220a2c89de7d (patch)
tree50accac4dd8cdd3eb8f754fb5476d8b9208a9748 /templates
parentf81308d9a8f535c8a149a8173fcccd772bf0cd92 (diff)
parentc44fd3b5049ff3b16403c95ec51d1fa3f83412ce (diff)
downloadDoxygen-735203d07ce01c587b6807122e7a220a2c89de7d.zip
Doxygen-735203d07ce01c587b6807122e7a220a2c89de7d.tar.gz
Doxygen-735203d07ce01c587b6807122e7a220a2c89de7d.tar.bz2
Merge pull request #8309 from albert-github/feature/bug_668003
bug 668003 Default LaTeX header misses $-placeholders
Diffstat (limited to 'templates')
-rwxr-xr-xtemplates/latex/footer.tex50
-rw-r--r--templates/latex/header.tex249
2 files changed, 299 insertions, 0 deletions
diff --git a/templates/latex/footer.tex b/templates/latex/footer.tex
new file mode 100755
index 0000000..0227221
--- /dev/null
+++ b/templates/latex/footer.tex
@@ -0,0 +1,50 @@
+%--- End generated contents ---
+
+%%BEGIN CITATIONS_PRESENT
+ % Bibliography
+ \newpage
+ \phantomsection
+
+%%BEGIN !PDF_HYPERLINKS
+ \clearemptydoublepage
+%%BEGIN COMPACT_LATEX
+ \addcontentsline{toc}{section}{$latexcitereference}
+%%END COMPACT_LATEX
+%%BEGIN !COMPACT_LATEX
+ \addcontentsline{toc}{chapter}{$latexcitereference}
+%%END !COMPACT_LATEX
+ \printindex
+%%END !PDF_HYPERLINKS
+
+ \bibliographystyle{$latexbibstyle}
+ \bibliography{$latexbibfiles}
+%%BEGIN PDF_HYPERLINKS
+%%BEGIN COMPACT_LATEX
+ \addcontentsline{toc}{section}{$latexcitereference}
+%%END COMPACT_LATEX
+%%BEGIN !COMPACT_LATEX
+ \addcontentsline{toc}{chapter}{$latexcitereference}
+%%END !COMPACT_LATEX
+%%END PDF_HYPERLINKS
+
+%%END CITATIONS_PRESENT
+
+% Index
+%%BEGIN !COMPACT_LATEX
+ \backmatter
+%%END !COMPACT_LATEX
+ \newpage
+ \phantomsection
+ \clearemptydoublepage
+%%BEGIN COMPACT_LATEX
+ \addcontentsline{toc}{section}{\indexname}
+%%END COMPACT_LATEX
+%%BEGIN !COMPACT_LATEX
+ \addcontentsline{toc}{chapter}{\indexname}
+%%END !COMPACT_LATEX
+ \printindex
+
+% Required for some languages (in combination with latexdocumentpre from the header)
+$latexdocumentpost
+\end{document}
+
diff --git a/templates/latex/header.tex b/templates/latex/header.tex
new file mode 100644
index 0000000..a9446d7
--- /dev/null
+++ b/templates/latex/header.tex
@@ -0,0 +1,249 @@
+ % Handle batch mode
+%%BEGIN LATEX_BATCHMODE
+ \batchmode
+%%END LATEX_BATCHMODE
+
+ % to overcome problems with too many open files
+ \let\mypdfximage\pdfximage\def\pdfximage{\immediate\mypdfximage}
+
+ % Set document class depending on configuration
+%%BEGIN COMPACT_LATEX
+ \documentclass[twoside]{article}
+%%END COMPACT_LATEX
+%%BEGIN !COMPACT_LATEX
+ \documentclass[twoside]{book}
+%%END !COMPACT_LATEX
+
+ %% moved from doxygen.sty due to workaround for LaTex 2019 version and unmaintained tabu package
+ \usepackage{ifthen}
+ \ifx\requestedLaTeXdate\undefined
+ \usepackage{array}
+ \else
+ \usepackage{array}[=2016-10-06]
+ \fi
+ %%
+
+ % Packages required by doxygen
+ \usepackage{fixltx2e} % for \textsubscript
+ \usepackage{doxygen}
+
+ $extralatexstylesheet
+
+ \usepackage{graphicx}
+ \usepackage[utf8]{inputenc}
+ \usepackage{makeidx}
+ \PassOptionsToPackage{warn}{textcomp}
+ \usepackage{textcomp}
+ \usepackage[nointegrals]{wasysym}
+ \usepackage{ifxetex}
+
+ % NLS support packages
+ $languagesupport
+
+ % Define default fonts
+ % Font selection
+%%BEGIN LATEX_FONTENC
+ \usepackage[$latexfontenc]{fontenc}
+%%END LATEX_FONTENC
+
+ % set main and monospaced font
+ $latexfont
+
+ \usepackage{sectsty}
+ \allsectionsfont{%
+ \fontseries{bc}\selectfont%
+ \color{darkgray}%
+ }
+ \renewcommand{\DoxyLabelFont}{%
+ \fontseries{bc}\selectfont%
+ \color{darkgray}%
+ }
+ \newcommand{\+}{\discretionary{\mbox{\scriptsize$\hookleftarrow$}}{}{}}
+
+ % Arguments of doxygenemoji:
+ % 1) ':<text>:' form of the emoji, already LaTeX-escaped
+ % 2) file with the name of the emoji without the .png extension
+ % in case image exist use this otherwise use the ':<text>:' form
+ \newcommand{\doxygenemoji}[2]{%
+ \IfFileExists{$latexemojidirectory/#2.png}{\raisebox{-0.1em}{\includegraphics[height=0.9em]{$latexemojidirectory/#2.png}}}{#1}%
+ }
+
+ % Page & text layout
+ \usepackage{geometry}
+ \geometry{%
+ $papertype,%
+ top=2.5cm,%
+ bottom=2.5cm,%
+ left=2.5cm,%
+ right=2.5cm%
+ }
+
+ % Allow a bit of overflow to go unnoticed by other means
+ \tolerance=750
+ \hfuzz=15pt
+ \hbadness=750
+ \setlength{\emergencystretch}{15pt}
+ \setlength{\parindent}{0cm}
+ \newcommand{\doxynormalparskip}{\setlength{\parskip}{3ex plus 2ex minus 2ex}}
+ \newcommand{\doxytocparskip}{\setlength{\parskip}{1ex plus 0ex minus 0ex}}
+ \doxynormalparskip
+ % Redefine paragraph/subparagraph environments, using sectsty fonts
+ \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
+
+ \makeatletter
+ \newcommand\hrulefilll{\leavevmode\leaders\hrule\hskip 0pt plus 1filll\kern\z@}
+ \makeatother
+
+ % Headers & footers
+ \usepackage{fancyhdr}
+ \pagestyle{fancyplain}
+ \renewcommand{\footrulewidth}{0.4pt}
+
+ \fancypagestyle{fancyplain}{
+ \fancyhf{}
+ \fancyhead[LE, RO]{\bfseries\thepage}
+ \fancyhead[LO]{\bfseries\rightmark}
+ \fancyhead[RE]{\bfseries\leftmark}
+ \fancyfoot[LO, RE]{\bfseries\scriptsize $generatedby Doxygen }
+ }
+
+ \fancypagestyle{plain}{
+ \fancyhf{}
+ \fancyfoot[LO, RE]{\bfseries\scriptsize $generatedby Doxygen }
+ \renewcommand{\headrulewidth}{0pt}
+ }
+
+ \pagestyle{fancyplain}
+
+
+%%BEGIN !COMPACT_LATEX
+ \renewcommand{\chaptermark}[1]{%
+ \markboth{#1}{}%
+ }
+%%END !COMPACT_LATEX
+ \renewcommand{\sectionmark}[1]{%
+ \markright{\thesection\ #1}%
+ }
+
+ % ToC, LoF, LoT, bibliography, and index
+ % Indices & bibliography
+ \usepackage{natbib}
+ \usepackage[titles]{tocloft}
+ \setcounter{tocdepth}{3}
+ \setcounter{secnumdepth}{5}
+
+ % creating indexes
+ $makeindex
+
+ $extralatexpackages
+
+ $latexspecialformulachars
+
+%%BEGIN FORMULA_MACROFILE
+ \input{$formulamacrofile}
+%%END FORMULA_MACROFILE
+
+ % Hyperlinks
+%%BEGIN PDF_HYPERLINKS
+ % Hyperlinks (required, but should be loaded last)
+ \ifpdf
+ \usepackage[pdftex,pagebackref=true]{hyperref}
+ \else
+ \ifxetex
+ \usepackage[pagebackref=true]{hyperref}
+ \else
+ \usepackage[ps2pdf,pagebackref=true]{hyperref}
+ \fi
+ \fi
+
+ \hypersetup{%
+ colorlinks=true,%
+ linkcolor=blue,%
+ citecolor=blue,%
+ unicode%
+ }
+
+%%END PDF_HYPERLINKS
+
+ % Custom commands used by the header
+ % Custom commands
+ \newcommand{\clearemptydoublepage}{%
+ \newpage{\pagestyle{empty}\cleardoublepage}%
+ }
+
+ % caption style definition
+ \usepackage{caption}
+ \captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
+
+
+ % in page table of contents
+ \usepackage{etoc}
+ \etocsettocstyle{\doxytocparskip}{\doxynormalparskip}
+
+ % prevent numbers overlap the titles in toc
+ \renewcommand{\numberline}[1]{#1~}
+
+% End of preamble, now comes the document contents
+%===== C O N T E N T S =====
+
+\begin{document}
+ \raggedbottom
+
+ $latexdocumentpre
+
+ % Titlepage & ToC
+%%BEGIN PDF_HYPERLINKS
+%%BEGIN USE_PDFLATEX
+ % To avoid duplicate page anchors due to reuse of same numbers for
+ % the index (be it as roman numbers)
+ \hypersetup{pageanchor=false,
+ bookmarksnumbered=true,
+ pdfencoding=unicode
+ }
+%%END USE_PDFLATEX
+%%END PDF_HYPERLINKS
+ \pagenumbering{alph}
+ \begin{titlepage}
+ \vspace*{7cm}
+ \begin{center}%
+ {\Large $title}\\
+ \vspace*{1cm}
+ {\large $generatedby Doxygen $doxygenversion}\\
+%%BEGIN LATEX_TIMESTAMP
+ \vspace*{0.5cm}
+ {\small $datetime}
+%%END LATEX_TIMESTAMP
+ \end{center}
+ \end{titlepage}
+
+%%BEGIN !COMPACT_LATEX
+ \clearemptydoublepage
+%%END !COMPACT_LATEX
+ \pagenumbering{roman}
+
+ \tableofcontents
+%%BEGIN !COMPACT_LATEX
+ \clearemptydoublepage
+%%END !COMPACT_LATEX
+ \pagenumbering{arabic}
+
+%%BEGIN PDF_HYPERLINKS
+%%BEGIN USE_PDFLATEX
+ % re-enable anchors again
+ \hypersetup{pageanchor=true}
+%%END USE_PDFLATEX
+%%END PDF_HYPERLINKS
+
+%--- Begin generated contents ---
+