Skip to content

A simple yet effective LaTeX template to write professional responses to reviewers comments.

License

Notifications You must be signed in to change notification settings

tomdemeyere/academic-review

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📝 LaTeX Reviewer Response Template

A simple yet effective LaTeX template focused on answering reviewer's comments in scientific writing. The template is self-contained and contains all the necessary commands to create a professional response to reviewer's comments. All commands are defined in the academic-review.sty file and can be easily customized if needed. The package was partially inspired by the work done by Dr. Julian Holland while working on his PhD thesis at Southampton University.


🚀 Getting Started

The package should be placed in the same directory as the main LaTeX file. To use the package, simply include the following line in the main LaTeX file:

\usepackage{academic-review}

📌 Core Commands

💬 \RC and \AR Commands

The template provides two commands to help you write your response to reviewer's comments:

  • \RC: Used to write the reviewer's comment
  • \AR: Used to write your response to the reviewer's comment
\RC{The authors should consider the impact of X on Y.}
\AR{We have now considered the impact of X on Y.}

📦 changes Environment

The template provides a changes environment to highlight modifications made in the manuscript. Text inside the changes environment will be displayed in a framed box.

\begin{changes}
    We performed X to address the reviewer's comment.
\end{changes}

\begin{changes}[5]
    We performed Y to address the reviewer's comment.
\end{changes}

\begin{changes}[5-12]
    We performed Z to address the reviewer's comment.
\end{changes}

👥 Reviewer Management

\newreviewer Command

Creates sections for each reviewer. The command takes no argument and automatically counts the number of reviewers.

\newreviewer

\newcomment Command

Creates subsections for each comment. The command takes no argument and automatically counts the number of comments.

\newcomment

✏️ Text Formatting

\del Command

Highlights deleted text from the manuscript, automatically striking through the text and changing the color to red.

\del{An obviously flawed argument.}

\important Command

Used to write important notes and acknowledgments.

\important{Correction on Page 5, Paragraph 2.}

🙏 Acknowledgments

\randomthanks Command

Generates a random acknowledgment message from a predefined list.

\randomthanks [...]

% Might generate:
% "We thank the reviewer for their insightful comment."
% "We appreciate the reviewer's valuable feedback."
% ...
% Can be customized in the academic-review.sty file.

📄 Example Usage

example.tex is provided as a demonstration file. The compiled PDF file is also included for reference.


📚 Dependencies

The template is based on the article class and uses the following packages:

\RequirePackage[T1]{fontenc}
\RequirePackage{amsmath}
\RequirePackage{mdframed}
\RequirePackage{newtxtext}
\RequirePackage{titlesec}
\RequirePackage{ulem}
\RequirePackage{xcolor}
\RequirePackage{parskip}
\RequirePackage{hyperref}
\RequirePackage{graphicx}
\RequirePackage{microtype}
\RequirePackage{tabularray}
\RequirePackage{pgfmath}
\RequirePackage[a4paper, total={6in, 10in}]{geometry}

About

A simple yet effective LaTeX template to write professional responses to reviewers comments.

Resources

License

Stars

Watchers

Forks

Languages