feat(inkscape): automatic composition of watermark string

jdujava · jdujava · commit a52aa6ca29b4 · 2025-05-13T14:30:14.000+02:00
Signed-off-by: Jonas Dujava &lt;jonas.dujava@gmail.com&gt;
diff --git a/chapters/Appendix.tex b/chapters/Appendix.tex
@@ -7,6 +7,7 @@ \chapter{Example of Appendix Chapter} \label{appendix:example}
 \end{example}
 
 \begin{figure}[!ht]
+    \exportInkscapeSVG{parallel-plate-capacitor}% export already here, such that we can use it in the caption
     \fcapside[\FBwidth]{%
         \caption[Example of a figure with a side-caption.]{
             Example of a figure with a side-caption.
@@ -23,7 +24,7 @@ \chapter{Example of Appendix Chapter} \label{appendix:example}
         }%
         \label{fig:parallel-plate-capacitor}%
         \floatfoot{You can also optionally use a footnote\\ for the figure caption.}%
-    }{\includegraphics[width=0.6\textwidth]{parallel-plate-capacitor}}
+    }{\includeInkscapeSVG[0.6\textwidth]{parallel-plate-capacitor}}%
 \end{figure}
 \begin{figure}[!ht]
     \ffigbox[\FBwidth]{%
diff --git a/chapters/Features.tex b/chapters/Features.tex
@@ -476,17 +476,17 @@ \subsection{\texorpdfstring{\texttt{Inkscape}}{Inkscape} Integration}%
 \label{sub:Inkscape Integration}
 \fileTeXtured{preamble/misc/inkscape.tex}
 
+Put your \texttt{Inkscape} figures into \path{figures/Inkscape/} directory, and include them using \custommacro{\includeInkscapeSVG} macro (in place of \macro{\includegraphics}), which has the following features:
 \begin{itemize}
-    \item automatic export after changing the \texttt{svg} (need to enable \macro{--shell-escape} for \hologo{pdfTeX} or \hologo{LuaTeX}, done via \path{.latexmkrc})
-    \item watermark via \texttt{ps} injection
+    \item Automatic export after changing the \texttt{svg} (need to enable \macro{--shell-escape} for \hologo{pdfTeX} or \hologo{LuaTeX}, done via \path{.latexmkrc}).
+    \item Watermark via a \texttt{PostScript} injection.
           \begin{remark}[Watermark String]
-              Edit the watermark text in the shell script \path{figures/Inkscape/inkscape-export-to-latex} to your liking.
+              By default, the watermark string is composed as \enquote{\copyright \textlangle\textit{year}\textrangle{} \textlangle\textit{author's name}\textrangle}, where the author's name is extracted from \custommacro{\ThesisAuthorPlaintext}.
+              You can customize it in the shell script \path{figures/Inkscape/inkscape-export-to-latex} to your liking.
           \end{remark}
-          \begin{Todo}
-              Make it easier to change the watermark text.
-              Or extract it somehow automatically from the PDF document?
-          \end{Todo}
-    \item automatic fix of \macro{/Interpolation} key problem
+    \item Automatic fix of \macro{/Interpolation} key problem.
+    \item All text is processed by \LaTeX{}, ensuring consistent typesetting experience.
+          In particular, you can enter math as usual through \macro{$...$}.
 \end{itemize}
 
 
diff --git a/figures/Inkscape/inkscape-export-to-latex b/figures/Inkscape/inkscape-export-to-latex
@@ -7,15 +7,22 @@
 inkscape "$1.svg" --export-area-drawing --export-dpi=300 --export-latex --export-filename="$1.pdf"
 
 ## Disable interpolation in the PDF (to conform with PDF/A standard)
-# sed -i 's|/Interpolate true$|/Interpolate false|' "$1.pdf" # SOMETIMES BORKS THE PDF
+# sed -i 's|/Interpolate true$|/Interpolate false|' "$1.pdf" # sometimes CORRUPTS the PDF
 ## https://stackoverflow.com/questions/20011515/how-to-remove-anti-aliasing-in-pdf-images
 perl -M-encoding -0777pe "s|/Interpolate true|' 'x17|ge" <"$1.pdf" >"$1-fixed.pdf"
 
 ## Add watermark to the PDF (if watermark script is available)
 directory=$(dirname "$1")
 if [ -f "$directory/add-watermark" ]; then
-    ## NOTE: edit the watermark string here
-    watermark_string="$(date +%Y) Jonas Dujava"
+    ## try to extract the author's name from the LaTeX preamble
+    author_name=$(sed -n 's/^[^%].*ThesisAuthorPlaintext}{}{\(.*\)}$/\1/p' preamble/data.tex)
+    ## if the `\ThesisAuthorPlaintext` command is commented out, extract from the `\ThesisAuthor` command
+    [ -z "$author_name" ] && author_name=$(sed -n 's/.*ThesisAuthor}{}{\(.*\)}$/\1/p' preamble/data.tex)
+
+    author_name=$(printf "%s" "$author_name" | iconv -f utf8 -t ascii//TRANSLIT) # use just ASCII characters
+    watermark_string="$(date +%Y) $author_name"                                  # prepend the year
+
+    # watermark_string="$(date +%Y) Author's Name" ## NOTE: or manually edit the watermark string here
     "$directory"/add-watermark "$1-fixed.pdf" "$watermark_string"
 fi
 
diff --git a/preamble/misc/inkscape.tex b/preamble/misc/inkscape.tex
@@ -4,10 +4,14 @@
 %% TODO: disable this for ArXiv submission (probably just leaving SVGs out will work fine)
 \usepackage{shellesc}
 \usepackage{filemod}
-\NewDocumentCommand{\includesvg}{O{0.8\linewidth} O{./figures/Inkscape/} m}{%
-    \filemodCmp{#2#3.pdf}{#2#3.svg}{}{% regenerate PDF+LaTeX code if SVG is newer
-        \ShellEscape{#2inkscape-export-to-latex "#2#3"}% use `inkscape-export-to-latex` script in the same directory
+\NewDocumentCommand{\exportInkscapeSVG}{O{./figures/Inkscape/} m}{%
+    \filemodCmp{#1#2.pdf}{#1#2.svg}{}{% regenerate PDF+LaTeX code if SVG is newer
+        \ShellEscape{#1inkscape-export-to-latex "#1#2"}% use `inkscape-export-to-latex` script in the same directory
     }%
+}
+%% the third argument is the name of the SVG file without the extension
+\NewDocumentCommand{\includeInkscapeSVG}{O{0.8\linewidth} O{./figures/Inkscape/} m}{%
+    \exportInkscapeSVG[#2]{#3}%
     \def\svgwidth{#1}% set the width of the figure
     \input{#2#3.pdf_tex}%
 }
