From 7692033f87b4c0326f655b7c73d361e6d318294a Mon Sep 17 00:00:00 2001
From: Mohammad Akhlaghi <mohammad@akhlaghi.org>
Date: Fri, 20 Nov 2020 15:01:45 +0000
Subject: Highlighting changes can now be toggled at run-time

Until now, the core Maneage 'paper.tex' had a '\highlightchanges' macro
that defines two LaTeX macros: '\new' and '\tonote'.

When '\highlightchanges' was defined, anything that was written within
'\new' became dark green (highlighting new things that have been
added). Also, anything that was written in '\tonote' was put within a '[]'
and became dark red (to show that there is a note here that should be
addressed later).

When '\highlightchanges' wasn't defined, anything within the '\new' element
would be black (like the rest of the text), and the things in '\tonote'
would not be shown at all.

Commenting the '\newcommand{\highlightchanges}{}' line within 'paper.tex'
(to toggle the modes above) would create a different Git hash and has to be
committed.

But this different commit hash could create a false sense in the reader
that other things have also been changed and the only way they could
confirm was to actually go and look into the project history (which they
will not usually have time to do, and thus won't be able to trust the two
modes of the text).

Also, the added highlights and the note highlights were bundeled together
into one macro, so you couldn't only have one of them.

With this commit, the choice of highlighting either one of the two is now
done as two new run-time options to the './project' script (which are
passed to the Makefiles, and written into the 'project.tex' file which is
loaded into 'paper.tex'). In this way, we can generate two PDFs with the
same Git commit (project's state): one with the selected highlights and
another one without it.

This issue actually came up for me while implementing the changes here: we
need to submit one PDF to the journal/referees with highlights on the added
features. But we also need to submit another PDF to arXiv and Zenodo
without any highlights. If the PDFs have different commit hashes, the
referees may associate it with other changes in any part of the work. For
example https://oadoi.org/10.22541/au.159724632.29528907 that mentions
"Another version of the manuscript was published on arXiv: 2006.03018",
while the only difference was a few words in the abstract after the journal
complained on the abstract word-count of our first submission (where the
commit hashes matched with arXiv/Zenodo).
---
 tex/src/preamble-project.tex | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

(limited to 'tex/src/preamble-project.tex')

diff --git a/tex/src/preamble-project.tex b/tex/src/preamble-project.tex
index b4fd764..6efdfd7 100644
--- a/tex/src/preamble-project.tex
+++ b/tex/src/preamble-project.tex
@@ -57,14 +57,18 @@
 
 
 
-%% Maneage feature for highlighting updates. When this is set, text marked
-%% as \new will be colored in dark green and text that is marked
-%% wtih \tonote will be marked in dark red.
-\ifdefined\highlightchanges
+%% Maneage feature for highlighting changes they can be set activated
+%% directly on the command-line with the '--highlight-new' or
+%% '--highlight-notes' options
+\ifdefined\highlightnew
 \newcommand{\new}[1]{\textcolor{green!60!black}{#1}}
-\newcommand{\tonote}[1]{\textcolor{red!60!black}{[#1]}}
 \else
 \newcommand{\new}[1]{\textcolor{black}{#1}}
+\fi
+
+\ifdefined\highlightnotes
+\newcommand{\tonote}[1]{\textcolor{red!60!black}{[#1]}}
+\else
 \newcommand{\tonote}[1]{{}}
 \fi
 
-- 
cgit v1.2.1

