summaryrefslogtreecommitdiff
path: root/documentation/src
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2020-09-20 14:44:14 +0200
committerAlbrecht Schlosser <albrechts.fltk@online.de>2020-09-21 14:32:46 +0200
commitb713b919756fd420063e7defc30bfc21996de636 (patch)
tree59e0f3bcd8dcb4c27413f3f533c27a6e2d2bea87 /documentation/src
parentf072cec13fb7afcc7726bda38869825f963bb483 (diff)
PDF docs: generate LaTeX header file from source
The LaTeX header file used when creating PDF documentation depends on the doxygen and latex versions, respectively. The old header file 'documentation/src/fltk-book.tex.in' had been generated manually and needed to be updated for new doxygen versions which made the PDF documentation generation dependent on the doxygen/latex versions on the build system. The new LaTeX header file 'fltk-book.tex' is generated by doxygen, i.e. taking into account the doxygen and latex versions on the build system and "edited" to include the page title defined in the new file 'documentation/src/fltk-title.tex.in'. This makes the PDF documentation independent of the doxygen and latex versions of the build system.
Diffstat (limited to 'documentation/src')
-rw-r--r--documentation/src/fltk-book.tex.in161
-rw-r--r--documentation/src/fltk-title.tex.in33
2 files changed, 33 insertions, 161 deletions
diff --git a/documentation/src/fltk-book.tex.in b/documentation/src/fltk-book.tex.in
deleted file mode 100644
index 880d06ead..000000000
--- a/documentation/src/fltk-book.tex.in
+++ /dev/null
@@ -1,161 +0,0 @@
-% Latex header for FLTK generated by doxygen 1.8.13
-\batchmode
-\documentclass[twoside]{book}
-
-% Packages required by doxygen
-\usepackage{fixltx2e}
-\usepackage{calc}
-\usepackage{doxygen}
-\usepackage[export]{adjustbox} % also loads graphicx
-\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[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}{3ex plus 2ex minus 2ex}
-\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 by Doxygen }}
-\fancyfoot[LO]{\fancyplain{}{\bfseries\scriptsize Generated 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}%
-}
-
-\usepackage{caption}
-\captionsetup{labelsep=space,justification=centering,font={bf},singlelinecheck=off,skip=4pt,position=top}
-
-%===== C O N T E N T S =====
-
-\begin{document}
-
-% Titlepage & ToC
-\hypersetup{pageanchor=false,
- bookmarksnumbered=true,
- pdfencoding=unicode
- }
-\pagenumbering{alph}
-\begin{titlepage}
-\vspace*{5cm}
-\begin{center}%
-{\Huge FLTK @FLTK_VERSION@ Programming Manual}\\
-\vspace*{2cm}
-\begin{DoxyImageNoCaption}
- \mbox{\includegraphics[width=6cm]{FL200.png}}
-\end{DoxyImageNoCaption}\\
-\vspace*{2cm}
-{\Large
-Revision 11 by F. Costantini, D. Gibson, M. Melcher, \\
-A. Schlosser, B. Spitzak, and M. Sweet.}\\
-\vspace*{1.5cm}
-{\large Copyright 1998-@YEAR@ by Bill Spitzak and others.}\\
-\vspace*{0.75cm}
-{\small
-This software and manual are provided under the terms of the GNU Library General Public License.}\\
-{\small
-Permission is granted to reproduce this manual or any portion for any purpose,}\\
-{\small
-provided this copyright and permission notice are preserved.}\\
-\vspace*{2.5cm}
-{\large Generated by Doxygen @DOXY_VERSION@}\\
-\vspace*{0.5cm}
-\today{}\\
-\end{center}
-\end{titlepage}
-\clearemptydoublepage
-\pagenumbering{roman}
-\tableofcontents
-\clearemptydoublepage
-\pagenumbering{arabic}
-\hypersetup{pageanchor=true}
-
-%--- Begin generated contents ---
diff --git a/documentation/src/fltk-title.tex.in b/documentation/src/fltk-title.tex.in
new file mode 100644
index 000000000..8a10747ea
--- /dev/null
+++ b/documentation/src/fltk-title.tex.in
@@ -0,0 +1,33 @@
+%
+% FLTK PDF documentation title page (LaTeX)
+%
+\begin{titlepage}
+\vspace*{5cm}
+\begin{center}%
+{\Huge FLTK @FLTK_VERSION@ Programming Manual}\\
+\vspace*{2cm}
+\begin{DoxyImageNoCaption}
+ \mbox{\includegraphics[width=6cm]{FL200.png}}
+\end{DoxyImageNoCaption}\\
+\vspace*{2cm}
+{\Large
+Revision 11 by F. Costantini, D. Gibson, M. Melcher, \\
+A. Schlosser, B. Spitzak, and M. Sweet.}\\
+\vspace*{1.5cm}
+{\large Copyright 1998-@YEAR@ by Bill Spitzak and others.}\\
+\vspace*{0.75cm}
+{\small
+This software and manual are provided under the terms of the GNU Library General Public License.}\\
+{\small
+Permission is granted to reproduce this manual or any portion for any purpose,}\\
+{\small
+provided this copyright and permission notice are preserved.}\\
+\vspace*{2.5cm}
+{\large Generated by Doxygen @DOXY_VERSION@}\\
+\vspace*{0.5cm}
+\today{}\\
+\end{center}
+\end{titlepage}
+%
+% end of FLTK PDF documentation title page (LaTeX)
+%