LaTeX style or macro for detailed response to referee report

Question

Is there a suitable macro (or even style) for responses to referees and editor?

These often entails several points to that need to be addressed. It would be nice to, say, quote the original text (possibly numbered) and the show the response slightly indented, as in

a) Spell foo as bar

We opted to follow the ABC style of ...

b) Include reference to Really, Important and Stuff (2010)

Section 2 has been updated and the discussion ...

Answer 1

Given the lack of pointers to anything pre-existing, I ended up with the following (and rather simplistic) solution, at least for now:

\newcommand{\pointRaised}[2]{\medskip \hrule \noindent 
               \textsl{{\fontseries{b}\selectfont #1}: #2}} 
\newcommand{\reply}{\noindent \textbf{Reply}:\ }       

The \pointRaised macro takes two arguments. The first is the enumeration and/or location of the issue. This will be set bold. The remainder is the what I chose to quote from the issue raised. This will be set in slanted. The whole block is separated by some vertically space and a horizontal rule.

The \reply simply starts with a bold token followed by the comment.

Answer 2

For insert comments about the text modifications in a LaTeX file according to referee questions, a good and easy option could be make a version with the todonotes package activated. Small comments can be made at margin and big comments might be placed in line. For example:

\documentclass{article}
\usepackage{lipsum}
\usepackage{todonotes}
\title{A more clever title
\todo{Modified according to referee}}
\author{The author}
\begin{document}
\maketitle
\begin{abstract}
\todo[inline,color=green!50]
{Abstract changed to adapt to format indicated in
guidelines to authors. Text has beeen changed to 
reflect the update of Section 2 and Discussion.}
\lipsum[1] 
\end{abstract}
\section{Introduction}
Really et al. (2010) 
\todo[color=blue!40]{Added citation} 
said some important suff.\lipsum[2]
\lipsum[3]
\end{document}

For a letter with questions & answers, this is essentially the same text structure of a exam, so you can use the exam document class. An example:

\documentclass[answers,12pt]{exam}
\usepackage{xcolor}
\definecolor{SolutionColor}{rgb}{0.1,0.3,1}
\usepackage{lipsum}

\renewcommand{\thequestion}{\alph{question} }
\renewcommand\questionlabel{\llap{\thequestion)}}

%\pointsinrightmargin
%\boxedpoints
\unframedsolutions
\shadedsolutions
\definecolor{SolutionColor}{rgb}{0.9,0.9,1}
\renewcommand{\solutiontitle}{}

\begin{document}


Dear Editor in Chief, \bigskip

Please read below our answer about the \numquestions{}
questions made by  both refereees. I hope that you agree
wih all our comments. \bigskip

Best regards,\bigskip

The author

\begin{questions}
\question Spell foo as bar
\begin{solution}
 We opted to follow the ABC style of ... 
\end{solution}
\question  Include reference to Really, Important and Stuff (2010)
\begin{solution}
Section 2 has been updated and the discussion ... 
\end{solution}
\end{questions}

\end{document}

Answer 3

There is a new template for a beautiful authors response to reviewers, that is

1. easy to write, and
2. easy to read.

The content can be written like this:

\section{Reviewer 1}
\subsection{Page 4 Line 12}
\RC Lengthy paragraph about something
\AR I do not agree.
\begin{quote}
Excerpt from the text with latexdiff-flavoured text changes.
\end{quote}

Or alternatively, in Markdown:

# Reviewer 1
## Page 4 Line 12
\RC Lengthy paragraph about something
\AR I do not agree.
> Excerpt from the text with latexdiff-flavoured text changes.

And looks like this:

Answer 4

I've modified this idea a bit, adding counters to automatically number the responses, and automatic referencing of where you've made relevant changes:

\usepackage{lineno}

% counters for reviewer points
\newcounter{reviewer}
\setcounter{reviewer}{0}
\newcounter{point}
\setcounter{point}{0}

\newcommand{\reviewersection}{\stepcounter{reviewer}\setcounter{point}{0}
                  \section*{Reviewer \#\thereviewer:}}
\newcommand{\point}[2]{\stepcounter{point} \bigskip \hrule \medskip \noindent 
               \textsl{{\fontseries{b}\selectfont (\thereviewer.\thepoint) #1} #2}} 
\newcommand{\reply}{\medskip \noindent \textbf{Reply}:\ }   

% use this command in the text where a change addressing a reviewer point has occurred
\newcommand{\revpoint}[2]{\linelabel{rr:rev#1:#2}}
% and this one to refer to such a location
\newcommand{\revref}{{(p.\ \pageref{rr:rev\thereviewer:\thepoint}, l.\ \lineref{rr:rev\thereviewer:\thepoint})}}

\newif\ifreviewresponses
\reviewresponsestrue

% put this where the reviews are to appear (at the end?)
\newcommand{\includereviews}{
    \ifreviewresponses
    \clearpage
    \setcounter{page}{1}
    \setcounter{section}{0}
    \setcounter{subsection}{0}
    \nolinenumbers
    \begin{center}
      {\LARGE \bf Response to Reviews}
    \end{center}
    \input{\responsefile}
    \fi
}

To use this, I've got the tex for the paper in, say, paper.tex, and the responses in responses.tex (just the document, no header commands), and in the header of paper.tex:

\input{review-response-commands}
\reviewresponsestrue  % include them
% \reviewresponsesfalse  % don't include them
\newcommand{\responsefile}{responses.tex}  % name of the review reponses file

Just after the \begin{document}:

\ifreviewresponses\linenumbers\fi

And down where I want the responses to appear in the document:

% put in the reviews here
\includereviews

For instance, when I add some text or whatnot to address, say, Reviewer 2's third point, for example:

This point was previously tangentially alluded to by Fred et al (2007). \revpoint{2}{3}

the responses might look like

\point{p.7}{This was previously studied by Fred et al (2007), which should be cited.}

\reply{We have included the citation \revref.}

This is working great; the only unsatisfactory thing about it is that you can't reorder reviewer points or add/subtract any after you've started working or you mess up the whole numbering scheme. It seems preferable to making up unique keys for each point yourself or something. Any other ideas?

Answer 5

This will be a non-LaTeX. As Editor in Chief for a journal, I will add some thoughts based on experience. The lack of templates reflects the fact that there is no real need for such a template. A letter in rresponse to referees comments should probably be made so that it is clear that each comment has been responded to. Such a letter will then probably reflect the review format more than enything else.

I would argue that the most important aspect of such letters are clearly non-(La)TeX issues summarized by 1. clarity 2. sincerity 3. cordiality

As is stated by @dank normal structural features of (La)TeX is enough (technically) to make a successful response letter.

Answer 6

Just use itemize or enumerate. Put the suggestion (or, better, a one-line summary of it) in bold or italic at the start of each item.

Although it is useful to use latex or tex (in case there is mathematics involved), the formatting should not matter much to the editor or the reviewers, so long as things are clear. Don't waste time worrying about formatting.

Instead, spend your time documenting the changes to your document (or reasons for not changing). I normally quote line numbers in the revised version, so that reviewers can check quickly the changes that have been made, to see if they judge them sufficient. Few reviewers are going to read the whole text again, with the original one at its side, to see the changes.

The reviewers have done a lot of work for you, and few systems credit that work. (Deans and bosses of all kinds want to count beans, and providing careful reviews counts as, well, as a first approximation, zero beans.) You should give your reviewers a break, in the second round. Tell them what you've changed (and where in the text), and why you refuse to change other things. If you have some minimal formatting (even a blank line between items), that's sufficient.

Answer 7

I created this template if anybody needs it: https://sites.google.com/site/andreaballatore/misc

Answer 8

As I like the simplicity of Dirk Eddelbuettel's answer (petrelharp's solution was a bit too complex for my taste), but don't like keeping track of point numbers (I got a lot of comments from my reviewers), here's my take using a point counter and an environment to reset the counter for new reviewers.

% response_macros.tex
\newcommand{\initresponses}{\newcounter{pointcounter}}

\newenvironment{reviewer}{\setcounter{pointcounter}{1}}{}

\newcommand{\point}[1]{\medskip \noindent
               \textsl{{\fontseries{b}\selectfont Q\thepointcounter}.
                 \stepcounter{pointcounter} #1}}
\newcommand{\reply}{\medskip \noindent \textbf{Answer}.\ }

And you use it as...

\input{response_macros}
\initresponses

\begin{reviewer}
\section*{Reviewer 1}

\point{Could you fix this?}
\reply Sure, I can.

\point{And that?}
\reply Why not?

\end{reviewer}

\begin{reviewer}
\section*{Reviewer 2}

\point{Excellent!}

\reply Thanks.

\end{reviewer}