From ab61c03433423d1744db3550db8e1e281dbdf256 Mon Sep 17 00:00:00 2001
From: Albrecht Schlosser <albrechts.fltk@online.de>
Date: Wed, 10 Aug 2022 18:51:53 +0200
Subject: Improve automatic documentation generation

This removes the need to edit the copyright year before generating
  the documentation (every year, in several files) and adds some
  technical information (doxygen generation date, doxygen version,
  and FLTK Git revision) in both HTML and PDF docs.

- auto-generate copyright year (current year) used in several places
- include FLTK Git revision in HTML and PDF docs
- include generation date and doxygen version
- replace special html footer which didn't work well with default footer
---
 documentation/src/fltk-title.tex.in |  6 ++++--
 documentation/src/html_footer       | 24 ------------------------
 documentation/src/index.dox         |  5 +++--
 documentation/src/preface.dox       |  4 ++--
 4 files changed, 9 insertions(+), 30 deletions(-)
 delete mode 100644 documentation/src/html_footer

(limited to 'documentation/src')

diff --git a/documentation/src/fltk-title.tex.in b/documentation/src/fltk-title.tex.in
index 1bc388828..c4c7c1813 100644
--- a/documentation/src/fltk-title.tex.in
+++ b/documentation/src/fltk-title.tex.in
@@ -14,7 +14,7 @@
 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.}\\
+{\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.}\\
@@ -22,10 +22,12 @@ This software and manual are provided under the terms of the GNU Library General
 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}
+\vspace*{1.5cm}
 {\large Generated by Doxygen @DOXY_VERSION@}\\
 \vspace*{0.5cm}
 \today{}\\
+\vspace*{0.5cm}
+{\small Git revision @GIT_REVISION@}\\
 \end{center}
 \end{titlepage}
 %
diff --git a/documentation/src/html_footer b/documentation/src/html_footer
deleted file mode 100644
index 03c6717a5..000000000
--- a/documentation/src/html_footer
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--BEGIN GENERATE_TREEVIEW-->
-    <li class="footer">
-      <!-- Generated for $projectname by Doxygen -->
-      Copyright &copy; 1998-2022 by Bill Spitzak and others. &nbsp;&nbsp;&nbsp;
-      <a href="https://www.fltk.org"><img src="tiny.png" align="bottom" alt="FLTK"></a>
-     </li>
-   </ul>
- </div>
-<!--END GENERATE_TREEVIEW-->
-<!--BEGIN !GENERATE_TREEVIEW-->
-<hr class="footer"/><address class="footer"><small>
-    <!-- Generated for $projectname by Doxygen -->
-    Copyright &copy; 1998-2022 by Bill Spitzak and others. &nbsp;&nbsp;&nbsp;
-    <a href="https://www.fltk.org"><img src="tiny.png" align="bottom" alt="FLTK"></a>
-</small></address>
-<hr class="footer"/><address class="footer"><small>
-  <div align="center">
-    Permission is granted to reproduce this manual or any portion for any purpose,
-    provided this copyright and permission notice are preserved.
-  </div>
-</small></address>
-<!--END !GENERATE_TREEVIEW-->
-</body>
-</html>
diff --git a/documentation/src/index.dox b/documentation/src/index.dox
index 97e89eab6..7d3858d57 100644
--- a/documentation/src/index.dox
+++ b/documentation/src/index.dox
@@ -13,13 +13,13 @@
     By F.&nbsp;Costantini, D.&nbsp;Gibson, M.&nbsp;Melcher,
     A.&nbsp;Schlosser, B.&nbsp;Spitzak and M.&nbsp;Sweet.
 
-    Copyright &copy; 1998-2022 by Bill Spitzak and others.
+    \include{doc} copyright.dox
   </CENTER></TD>
 </TR>
 </TABLE>
 <TABLE BGCOLOR="#9f9f9f" CELLPADDING="8" CELLSPACING="0" SUMMARY="TITLE BAR" WIDTH="100%" BORDER="0">
 <TR>
-  <TD>
+  <TD style="text-align: center;">
     This software and manual are provided under the terms of the GNU
     Library General Public License. Permission is granted to reproduce
     this manual or any portion for any purpose, provided this copyright
@@ -103,6 +103,7 @@
 </TR>
 </TABLE>
 
+\htmlinclude{doc} generated.dox
 
 \htmlonly
 <hr>
diff --git a/documentation/src/preface.dox b/documentation/src/preface.dox
index f3f401efa..168240570 100644
--- a/documentation/src/preface.dox
+++ b/documentation/src/preface.dox
@@ -80,8 +80,8 @@ was dropped after FLTK 1.0.10. FLTK uses the preprocessor definition
 
 \section preface_copyrights Copyrights and Trademarks
 
-FLTK is Copyright 1998-2020 by Bill Spitzak and others.  Use and
-distribution of FLTK is governed by the GNU Library General Public
+FLTK is \include{doc} copyright.dox
+Use and distribution of FLTK is governed by the GNU Library General Public
 License with 4 exceptions, located in \ref license.
 
 UNIX is a registered trademark of the X Open Group, Inc.
-- 
cgit v1.2.3