diff options
| author | Matthias Melcher <github@matthiasm.com> | 2024-04-17 17:51:32 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-04-17 17:51:32 +0200 |
| commit | fd791a068e39e06785adc44693f4c533d3d6c903 (patch) | |
| tree | ef7ff684b38f646165e80c142e454cd7ef077e2e /fluid/documentation/make_header | |
| parent | b4cf1a9824f2c4ba9596044962d3af36e3ca3d99 (diff) | |
Separate FLUID user documentation, screen shot automation (#936)
* CMake integration, no autotiools
* alignment panel is now correctly renamed to setting panel
* source view is now correctly renamed to code view
* Merge FLTK FLUID docs into FLUID user manual.
* Add two simple entry tutorials
* Remove FLUID chapter form FLTK docs.
* GitHub action to generate HTML and PDF docs and
make the available as artefacts
Diffstat (limited to 'fluid/documentation/make_header')
| -rwxr-xr-x | fluid/documentation/make_header | 63 |
1 files changed, 63 insertions, 0 deletions
diff --git a/fluid/documentation/make_header b/fluid/documentation/make_header new file mode 100755 index 000000000..58df10af2 --- /dev/null +++ b/fluid/documentation/make_header @@ -0,0 +1,63 @@ +#!/bin/sh +# +# Create a new LaTeX header file for doxygen PDF docs +# +# Note: this LaTeX file depends on Doxygen and LaTeX versions, resp. +# and needs therefore to be created with current Doxygen and LaTeX +# versions on the build system. +# +# Usage: +# +# $ sh make_header doxygen_path input-file output-file +# +# where +# - 'doxygen_path' is the full path to the doxygen executable +# or just 'doxygen'. If the full path is used an arbitrary +# doxygen executable and thus doxygen version can be used. +# - 'input-file' is the pure (LaTeX) title page (template) +# - 'output-file' is the generated (LaTeX) title page (template) +# that is used by `make' or `cmake` to generate the final LaTeX +# page header (combined doxygen template + FLTK title page). +# +#======================================================================= +# This script requires a posix shell and uses the following commands: +# cat, rm and sed and (obviously) doxygen +#======================================================================= + +# input and output file names +DOXY_CMD="$1" +FLTK_HEAD="$2" +DOXY_HEAD="$3" +# temp file +DOXY_TEMP="doxy-header.tex.$$" + +if test x$FLTK_HEAD = x; then + echo "usage: $0 fltk-header-file output-file" + exit 1 +fi + +if test x$DOXY_HEAD = x; then + echo "usage: $0 fltk-header-file output-file" + exit 1 +fi + +# Create the doxygen LaTeX header template and replace the LaTeX +# code between (and including) the lines containing +# - 'begin{titlepage}' and +# - 'end{titlepage}' +# with our PDF document title page (LaTeX code) and write the +# result to $DOXY_HEAD. + +"$DOXY_CMD" -w latex $DOXY_TEMP /dev/null /dev/null + +# combine three parts of these files to the output file +# using '( ... ) > $DOXY_HEAD' to write (concatenate) +# all three parts to one file + +( sed -e'/begin{titlepage}/,$d' < $DOXY_TEMP + cat $FLTK_HEAD + sed -e'1,/end{titlepage}/d' < $DOXY_TEMP +) > $DOXY_HEAD + +# cleanup +rm -f $DOXY_TEMP |
