Skip to content

yifu-ding/Journal-Response-Template

Repository files navigation

Journal Response LaTeX Template

中文

A LaTeX template for journal response letters. Modified from Journal-Response-Letter-Template-Latex and Latex Template for Review Comments of Papers. Thanks for the great groundwork.

How to Compile

rm -rf build/
latexmk -xelatex -synctex=1 -file-line-error -interaction=nonstopmode -outdir=build review_response.tex

The compiled PDF is generated at ./build/review_response.pdf.

How to Use

File Tree

.
├─ Responses/                   # Write responses here
│  ├─ AssociateEditor.tex       # Response to the Associate Editor
│  ├─ Editor.tex                # Response to the Editor
│  ├─ R1.tex                    # Response to Reviewer 1
│  └─ R2.tex                    # Response to Reviewer 2
├─ utils/                       # Reusable inserts
│  ├─ algorithms/               # Algorithm snippets
│  │  ├─ algo1.tex
│  │  └─ algo2.tex
│  ├─ figures/                  # Figure snippets
│  │  ├─ figure1.tex
│  │  └─ figure2.tex
│  ├─ imgs/                     # Image assets
│  │  ├─ sample1.png
│  │  └─ sample2.png
│  └─ tables/                   # Table snippets
│     ├─ table1.tex
│     └─ table2.tex
├─ compile.sh                   # Build script
├─ cover_letter.tex             # Cover letter
├─ literature.bib               # Bibliography
├─ review_response.tex          # Main file
└─ reviewresponse.sty           # Style file

✍️ Cover Page - Basic Fields

Journal info and manuscript ID on the cover page: review_response.tex#L9-10

\usepackage[journal={IEEE Transactions on XXX},
            manuscript={TXXX-YYYY-MM-IDID},
            editor={Mrs. Joyce Arnold}]{reviewresponse}

Manuscript ID in the footer: review_response.tex#L115

% around review_response.tex#L107
\fancyfoot[L]{Response Letter for TXXX-YYYY-MM-IDID}

Title and author info: review_response.tex#L97-100

\title{}
\author{}

image-20251003133756427

Cover example


⚙️ Preset Commands

  1. Editor / Associate Editor (if any) / Reviewers
\begin{document}
...
\editor
Response to the editor

\AssociateEditor % if an associate editor is involved
Response to the associate editor

\reviewer
Response to the first reviewer

\reviewer
Response to the second reviewer

image-20251003134014035

TOC example

  1. General Comment

Provide a high-level summary of the editor’s/associate editor’s/reviewer’s general comment:

\begin{generalcomment}
A brief summary of the editor’s/associate editor’s/reviewer’s general comment.
\end{generalcomment}

Your meta-level response:

\begin{revmeta}[Optional Parameter]
Our response to the general comment.
\end{revmeta}

image-20251003134130787

Summary Comment example

  1. Single comment from the Associate Editor
\begin{revcommentToAssociateAuthor}
Restate the associate editor’s comment.
\end{revcommentToAssociateAuthor}

Reply using \begin{revmeta}[] ... \end{revmeta}.

image-20251003134207950

Single Comment example (Associate Editor)

  1. Single reviewer comment (numbered)
\begin{revcomment}
Restate the reviewer’s comment.
\end{revcomment}
\begin{revresponse}[Optional Parameter]
Our response.
\end{revresponse}

image-20251003144547508

Single Comment example (Reviewer)

  1. Insert “Changes”

Wrap content with:

\begin{changes}
...
\end{changes}

image-20251003134606251

Changes example

  1. Label cross-references
\begin{revcomment}
A summary of the practical domains where these methods have been applied, or could be applied, is missing.
\label{com:rev1:Q1}
\end{revcomment}
For the detailed response, please refer to Comment~\ref{com:rev1:Q1} for Reviewer 1.

image-20251003150453120

Label cross-reference example


⚠️ Key Customization Areas

  1. Show the Cover Letter in the TOC as Cover Letter or Preface (as required by the journal), set in cover_letter.tex#L4:
\addcontentsline{toc}{section}{\protect\numberline{}Cover Letter}  % Display as “Cover Letter”
  1. The current template states at cover_letter.tex#L34 that modified text is marked in red and newly added text is marked in blue (some journals require “track changes”). Update this sentence to match your paper, and adjust the colors in reviewresponse.sty#L41-42:
\textbf{In the revised manuscript, modified parts are marked in red, and newly added parts are marked in blue.}
\newcommand{\modified}[1]{\textcolor{red}{#1}}
\newcommand{\added}[1]{\textcolor{blue}{#1}}

Note: for environments like tables/algorithms, wrap them with

\begin{addedenv}
...
\end{addedenv}

and keep the color in sync, as defined in reviewresponse.sty#L44-51:

\newenvironment{addedenv}{
  \begingroup
  \arrayrulecolor{blue}
  \captionsetup{labelfont={color=blue}, textfont={color=blue}}%
  \color{blue}%
}{%
  \endgroup
}

image-20251003141840217

Track Changes example


Color Palette and Styles

  1. Color customization (reviewresponse.sty#L26-39)
% comment box color
\definecolor{colorcommentbg}{HTML}{ededed}   % comment background
\definecolor{colorcommentframe}{HTML}{8faadc} % comment title background

% response text color
\definecolor{maintext}{HTML}{000000}
\definecolor{commenttext}{HTML}{23579A}

%%%% change box color
\definecolor{colorchangebg}{HTML}{f9daa6}    % change box sidebar
\definecolor{colorchangetext}{HTML}{000000}  % change text
  1. Comment card styling (e.g., rounded corners, shadow). Edit the revcomment environment at reviewresponse.sty#L136:
\newenvironment{revcomment}[1][]{\refstepcounter{reviewcomment@counter}
  \begin{tcolorbox}[adjusted title={Comment \arabic{reviewer@counter}.\arabic{reviewcomment@counter}},
    fonttitle={\bfseries}, enhanced jigsaw, colbacktitle={colorcommentframe},
    arc=2pt, outer arc=2pt, opacityframe=0, boxrule=0em, colback={colorcommentbg},
    drop shadow={opacity=0.25}, #1]
}{\end{tcolorbox}}

image-20251003154040973

Comment Card example

About

A clean LaTeX template for preparing journal revision responses and reviewer rebuttal letters.

Topics

Resources

License

Stars

3 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors