summaryrefslogtreecommitdiff
path: root/documentation/src
diff options
context:
space:
mode:
authorAlbrecht Schlosser <albrechts.fltk@online.de>2018-08-07 09:01:32 +0000
committerAlbrecht Schlosser <albrechts.fltk@online.de>2018-08-07 09:01:32 +0000
commitfb0f940c517d4f0f0f2f22f92acc54c9f5b37242 (patch)
treed14329422b6a85b09ba8cd1a4c30bfe1fefc19b3 /documentation/src
parent72cc8b9b238b391c4b804b1f1c487dfb73c03eef (diff)
Update doxygen files to fix broken PDF generation.
Note: PDF generation "worked" with the previous configuration up to doxygen 1.8.6 on my "old" Ubuntu 14.04 system but did no longer work with doxygen 1.8.7 - 1.8.13 (the latter on Ubuntu 18.04). Tests showed that 1.8.14 is seriously broken and git:master (aka 1.8.15, but not yet released as of today) is not usable as well. Hopefully there will be some doxygen fixes in the future. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.4@13010 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/src')
-rw-r--r--documentation/src/fltk-book.tex.in158
-rw-r--r--documentation/src/index.dox2
2 files changed, 128 insertions, 32 deletions
diff --git a/documentation/src/fltk-book.tex.in b/documentation/src/fltk-book.tex.in
index f4294c7be..e1568d6d6 100644
--- a/documentation/src/fltk-book.tex.in
+++ b/documentation/src/fltk-book.tex.in
@@ -1,39 +1,132 @@
-\documentclass[a4paper]{book}
-\usepackage{a4wide}
-\usepackage{makeidx}
-\usepackage{fancyhdr}
+% 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{float}
+\usepackage{multirow}
+\PassOptionsToPackage{warn}{textcomp}
\usepackage{textcomp}
-\usepackage{alltt}
-\usepackage{times}
+\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,
- colorlinks=true,
- linkcolor=blue,
- unicode
- ]{hyperref}
+ \usepackage[pdftex,pagebackref=true]{hyperref}
\else
-\usepackage[ps2pdf,
- pagebackref=true,
- colorlinks=true,
- linkcolor=blue,
- unicode
- ]{hyperref}
-\usepackage{pspicture}
+ \usepackage[ps2pdf,pagebackref=true]{hyperref}
\fi
-\usepackage[utf8]{inputenc}
-\usepackage{doxygen}
-\makeindex
-\setcounter{tocdepth}{1}
-\renewcommand{\footrulewidth}{0.4pt}
+\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*{4.5cm}
-\begin{center}
+\vspace*{5cm}
+\begin{center}%
{\Huge FLTK @FL_VERSION@ Programming Manual}\\
\vspace*{2cm}
\begin{DoxyImageNoCaption}
@@ -41,16 +134,16 @@
\end{DoxyImageNoCaption}\\
\vspace*{2cm}
{\Large
-Revision 10 by F. Costantini, D. Gibson, M. Melcher, \\
+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
+{\small
This software and manual are provided under the terms of the GNU Library General Public License.}\\
-{\Small
+{\small
Permission is granted to reproduce this manual or any portion for any purpose,}\\
-{\Small
+{\small
provided this copyright and permission notice are preserved.}\\
\vspace*{2.5cm}
{\large Generated by Doxygen @DOXY_VERSION@}\\
@@ -63,3 +156,6 @@ provided this copyright and permission notice are preserved.}\\
\tableofcontents
\clearemptydoublepage
\pagenumbering{arabic}
+\hypersetup{pageanchor=true}
+
+%--- Begin generated contents ---
diff --git a/documentation/src/index.dox b/documentation/src/index.dox
index 936aa1234..c483b7d96 100644
--- a/documentation/src/index.dox
+++ b/documentation/src/index.dox
@@ -10,7 +10,7 @@
<TD><CENTER>
<B>FLTK 1.4.0 Programming Manual</B>
- Revision 10 by F.&nbsp;Costantini, D.&nbsp;Gibson, M.&nbsp;Melcher,
+ Revision 11 by F.&nbsp;Costantini, D.&nbsp;Gibson, M.&nbsp;Melcher,
A.&nbsp;Schlosser, B.&nbsp;Spitzak and M.&nbsp;Sweet.
Copyright 1998-2018 by Bill Spitzak and others.