From 7aa27859a552f0e459110455a372e5a017bc6873 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Sat, 4 Oct 2014 23:42:17 +0000 Subject: Improve documentation generation (pdf only). Add file VERSION that includes the FLTK version number (only), generate fltk.pdf with automatic copyright year and doxygen version. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@10352 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/Makefile | 11 +++++-- documentation/src/fltk-book.tex | 65 -------------------------------------- documentation/src/fltk-book.tex.in | 65 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 74 insertions(+), 67 deletions(-) delete mode 100644 documentation/src/fltk-book.tex create mode 100644 documentation/src/fltk-book.tex.in (limited to 'documentation') diff --git a/documentation/Makefile b/documentation/Makefile index 599e1c11b..24e7e7768 100644 --- a/documentation/Makefile +++ b/documentation/Makefile @@ -64,7 +64,7 @@ dist: all html pdf alldocs: dist clean: - $(RM) fltk.pdf refman.pdf + $(RM) fltk.pdf refman.pdf src/fltk-book.tex $(RMDIR) html latex $(RM) *~ *.bck *.bak *.log $(RM) $(MANPAGES) $(SRC_DOCDIR)/*.0 @@ -148,7 +148,7 @@ html-online: html pdf: refman.pdf cp -f latex/refman.pdf fltk.pdf -refman.pdf: $(HTMLFILES) Doxybook +refman.pdf: $(HTMLFILES) Doxybook src/fltk-book.tex -$(RMDIR) latex echo "Generating PDF documentation ..." $(DOXYDOC) Doxybook ;\ @@ -166,6 +166,13 @@ refman.pdf: $(HTMLFILES) Doxybook done ; \ cd ..) > pdfall.log 2>&1 +src/fltk-book.tex: src/fltk-book.tex.in + DOXY_VERSION=`$(DOXYDOC) --version`; \ + YEAR=`date +%Y`; \ + FLTK_VERSION=`cat ../VERSION`; \ + sed -e"s/@YEAR@/$$YEAR/g" -e"s/@VERSION@/$$FLTK_VERSION/g" \ + -e"s/@DOXY_VERSION@/$$DOXY_VERSION/g" < $< > $@ + # # End of "$Id$". # diff --git a/documentation/src/fltk-book.tex b/documentation/src/fltk-book.tex deleted file mode 100644 index bc07f0f82..000000000 --- a/documentation/src/fltk-book.tex +++ /dev/null @@ -1,65 +0,0 @@ -\documentclass[a4paper]{book} -\usepackage{a4wide} -\usepackage{makeidx} -\usepackage{fancyhdr} -\usepackage{graphicx} -\usepackage{multicol} -\usepackage{float} -\usepackage{textcomp} -\usepackage{alltt} -\usepackage{times} -\usepackage{ifpdf} -\ifpdf -\usepackage[pdftex, - pagebackref=true, - colorlinks=true, - linkcolor=blue, - unicode - ]{hyperref} -\else -\usepackage[ps2pdf, - pagebackref=true, - colorlinks=true, - linkcolor=blue, - unicode - ]{hyperref} -\usepackage{pspicture} -\fi -\usepackage[utf8]{inputenc} -\usepackage{doxygen} -\makeindex -\setcounter{tocdepth}{1} -\renewcommand{\footrulewidth}{0.4pt} -\begin{document} -\begin{titlepage} -\vspace*{4.5cm} -\begin{center} -{\Huge FLTK 1.3.2 Programming Manual}\\ -\vspace*{2cm} -\begin{ImageNoCaption} - \mbox{\includegraphics[width=6cm]{FL200}} -\end{ImageNoCaption}\\ -\vspace*{2cm} -{\Large -Revision 9 by F. Costantini, D. Gibson, M. Melcher, \\ -A. Schlosser, B. Spitzak, and M. Sweet.}\\ -\vspace*{1.5cm} -{\large Copyright 1998-2012 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 1.7.5}\\ -\vspace*{0.5cm} -\today{}\\ -\end{center} -\end{titlepage} -\clearemptydoublepage -\pagenumbering{roman} -\tableofcontents -\clearemptydoublepage -\pagenumbering{arabic} diff --git a/documentation/src/fltk-book.tex.in b/documentation/src/fltk-book.tex.in new file mode 100644 index 000000000..e3cdb8f2e --- /dev/null +++ b/documentation/src/fltk-book.tex.in @@ -0,0 +1,65 @@ +\documentclass[a4paper]{book} +\usepackage{a4wide} +\usepackage{makeidx} +\usepackage{fancyhdr} +\usepackage{graphicx} +\usepackage{multicol} +\usepackage{float} +\usepackage{textcomp} +\usepackage{alltt} +\usepackage{times} +\usepackage{ifpdf} +\ifpdf +\usepackage[pdftex, + pagebackref=true, + colorlinks=true, + linkcolor=blue, + unicode + ]{hyperref} +\else +\usepackage[ps2pdf, + pagebackref=true, + colorlinks=true, + linkcolor=blue, + unicode + ]{hyperref} +\usepackage{pspicture} +\fi +\usepackage[utf8]{inputenc} +\usepackage{doxygen} +\makeindex +\setcounter{tocdepth}{1} +\renewcommand{\footrulewidth}{0.4pt} +\begin{document} +\begin{titlepage} +\vspace*{4.5cm} +\begin{center} +{\Huge FLTK @VERSION@ Programming Manual}\\ +\vspace*{2cm} +\begin{ImageNoCaption} + \mbox{\includegraphics[width=6cm]{FL200}} +\end{ImageNoCaption}\\ +\vspace*{2cm} +{\Large +Revision 9 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} -- cgit v1.2.3