You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

2.9 KiB

How to use the review notes commands

First add the \input{revgmarx} command to include definitions into the under reviewing document:

\documentclass[twoside]{IEEEtran}
\usepackage{cite}
\usepackage{amsmath,amssymb,amsfonts}
\usepackage{algorithmic}
\usepackage{graphicx}
\usepackage{textcomp}
\usepackage{hyperref}
\usepackage{booktabs}
\usepackage{subcaption}
%\usepackage{enumitem}
\input{revgmarx}    % <---- add this

After you include the revgmarx file you can access to the following commands:

  • \marx: A personalized command as a reviewer to add notes using the todonotes package.
  • \add: This commands should be used to indicate that the reviewer has added new text or suggest new content.
  • \replace: This command should be used to indicate that part of the content has been replaced or modified; marking replaced text with red and new/suggested text with blue.
  • \remove: This command should be used to indicate that content should be removed.
  • \reviewlegend: This command prints a legend as instructions to explain colors and notes related with the commands; you can modified to let clear instructions for the reviewed document.
  • \reviewnotes: This command prints-out the list of comments and notes marked during revision; the list shows the comment and its page location.

You can add your own command to make reference as your self as a reviewer by modifying the \marx command or maybe in a later version a general command with author identification will be added

The revgmarx.tex file

The revmarx.tex contains the next packages and commands definitions to be used for the review process:

% Mis comandos para revisión Marx
\usepackage{ulem} % Para tachado (\sout)
\usepackage{soul} % For text highlighting
\usepackage{todonotes}
\usepackage[most]{tcolorbox}

% Define custom TODO commands
\newcommand{\marx}[2][]{%
  \todo[color=orange!30, linecolor=red!70, fancyline, #1]{#2}%
  }

% Define the \add command
\newcommand{\add}[1]{\textcolor{blue}{#1}}

% command \replace
\newcommand{\replace}[3]{%
    \textcolor{red}{\sout{#1}} % antiguo
    \textcolor{blue}{#2}       % nuevo
    {\ensuremath{#3}}          % Fórmula
}

% Define the \remove command
\newcommand{\remove}[1]{\textcolor{red}{\sout{#1}}}


% Define review legend
\newcommand{\reviewlegend}{
  \begin{tcolorbox}[title=Legend for Review Markup, colback=gray!5!white, colframe=gray!75!black]
  \begin{itemize}
    \item \textcolor{red}{\sout{old text}} — text marked for removal or replacement.
    \item \textcolor{blue}{new text} — suggested new or added content.
    \item Orange boxes — reviewer comments or todos, added via the \textbf{$\backslash$marx} \LaTeX{} command.
  \end{itemize}
  \end{tcolorbox}
}

% Define review notes
\newcommand{\reviewnotes}{
	\begin{tcolorbox}[title=Todo List, colback=white, colframe=blue!50!black, fonttitle=\bfseries, title filled]
    \listoftodos
  \end{tcolorbox}
}

%%%%%%