path: root/macros/latex/contrib/easyreview/easyReview.dtx

% \iffalse meta-comment
%
% Copyright (C) 2014 by jmamatos <jody.matos@inf.ufrgs.br>
% ---------------------------------------------------------------------------
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License, either version 1.3
% of this license or (at your option) any later version.
% The latest version of this license is in
%   http://www.latex-project.org/lppl.txt
% and version 1.3 or later is part of all distributions of LaTeX
% version 2005/12/01 or later.
%
% This work has the LPPL maintenance status `maintained'.
%
% The Current Maintainer of this work is jmamatos.
%
% This work consists of the files easyReview.dtx and easyReview.ins
% and the derived filebase easyReview.sty.
%
% \fi
%
% \iffalse
%<*driver>
\ProvidesFile{easyReview.dtx}
%</driver>
%<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
%<package>\ProvidesPackage{easyReview}
%<*package>
    [2014/06/27 Package for Easy Review on LaTeX documents]
%</package>
%
%<*driver>
\documentclass{ltxdoc}
\usepackage{easyReview}[2014/06/27]
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\begin{document}
  \DocInput{easyReview.dtx}
  \PrintChanges
  \PrintIndex
\end{document}
%</driver>
% \fi
%
% \CheckSum{63}
%
% \CharacterTable
%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%   Digits        \0\1\2\3\4\5\6\7\8\9
%   Exclamation   \!     Double quote  \"     Hash (number) \#
%   Dollar        \$     Percent       \%     Ampersand     \&
%   Acute accent  \'     Left paren    \(     Right paren   \)
%   Asterisk      \*     Plus          \+     Comma         \,
%   Minus         \-     Point         \.     Solidus       \/
%   Colon         \:     Semicolon     \;     Less than     \<
%   Equals        \=     Greater than  \>     Question mark \?
%   Commercial at \@     Left bracket  \[     Backslash     \\
%   Right bracket \]     Circumflex    \^     Underscore    \_
%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%   Right brace   \}     Tilde         \~}
%
%
% \changes{<+version+>}{<+date+>}{Converted to DTX file}
%
% \DoNotIndex{\newcommand,\newenvironment}
%
% \providecommand*{\url}{\texttt}
% \GetFileInfo{easyReview.dtx}
% \title{The \textsf{easyReview} package}
% \author{jmamatos \\ \url{jody.matos@inf.ufrgs.br}}
% \date{\fileversion~from \filedate}
%
% \maketitle
%
% \section{Introduction}
%
% Put text here.
%
% \section{Usage}
%
% Put text here.
%
%
% \DescribeMacro{\setreviewson}
%
%
% \DescribeMacro{\setreviewsoff}
%
%
% \DescribeMacro{\alertColor}
%
%
% \DescribeMacro{\removeColor}
%
%
% \DescribeMacro{\addColor}
%
%
% \DescribeMacro{\alert}
%
%
% \DescribeMacro{\remove}
%
%
% \DescribeMacro{\add}
%
%
% \DescribeMacro{\substitute}
%
%
% \DescribeMacro{\replace}
%
%
% \DescribeMacro{\highlight}
%
%
% \DescribeMacro{\comment}
%

%
% \StopEventually{}
%
% \section{Implementation}
%
% \iffalse
%<*package>
% \fi
%
%% easyReview.sty, v-1.0 jmamatos
%% Copyright 2013- by jmamatos
%%
%% This work may be distributed and/or modified under the
%% conditions of the LaTeX Project Public License, either version 1.3
%% of this license or (at your option) any later version.
%% The latest version of this license is in
%%   http://www.latex-project.org/lppl.txt
%% and version 1.3 or later is part of all distributions of LaTeX
%% version 2005/12/01 or later.
%%
%% This work has the LPPL maintenance status `maintained'.
%% 
%% The Current Maintainer of this work is jmamatos, led
%% by Jody Maick Matos. Further information are available on 
%% https://github.com/jmamatos/easyReview/
%%
%% 
%%
%% Revision history:
%%
%% 2014/06/27 jmamatos
%% 
%%
%
%    \begin{macrocode}
\NeedsTeXFormat{LaTeX2e}[1994/06/01]
%    \end{macrocode}
%% This file provide the easyReview package, wich can be used to
%% easily review tex documents (or editorial processes).
%    \begin{macrocode}
\ProvidesPackage{easyReview}[2013/12/09 Package for Easy Review on LaTeX documents]
\newif\ifistoreview
\istoreviewtrue
%    \end{macrocode}
%
% \begin{macro}{\setreviewson}
%    \begin{macrocode}
\newcommand{\setreviewson}{\istoreviewtrue}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\setreviewsoff}
%    \begin{macrocode}
\newcommand{\setreviewsoff}{\istoreviewfalse}
%    \end{macrocode}
% \end{macro}
%
%    \begin{macrocode}
\RequirePackage{soul}
\RequirePackage{xcolor}
\RequirePackage{todonotes}
%    \end{macrocode}
%
% \begin{macro}{\alertColor}
%    \begin{macrocode}
\newcommand{\alertColor}{\textcolor{red}}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\removeColor}
%    \begin{macrocode}
\newcommand{\removeColor}{\textcolor{red}}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\addColor}
%    \begin{macrocode}
\newcommand{\addColor}{\textcolor{blue}}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\alert}
%    \begin{macrocode}
\newcommand{\alert}[1]{\ifistoreview\alertColor{#1}\else #1\fi}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\remove}
%    \begin{macrocode}
\newcommand{\remove}[1]{\ifistoreview\alertColor{\st{#1}}\else #1\fi}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\add}
%    \begin{macrocode}
\newcommand{\add}[1]{\ifistoreview\addColor{#1}\else #1\fi}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\substitute}
%    \begin{macrocode}
\newcommand{\substitute}[2]{\ifistoreview\remove{#1}~\add{#2} \else #1\fi}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\replace}
%    \begin{macrocode}
\newcommand{\replace}[2]{\ifistoreview\remove{#1}~\add{#2}\else #1\fi}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\highlight}
%    \begin{macrocode}
\newcommand{\highlight}[1]{\hl{#1}}
%    \end{macrocode}
% \end{macro}
%
%
% \begin{macro}{\comment}
%    \begin{macrocode}
\newcommand{\comment}[2]{\highlight{#1}\todo[inline]{#2}}%    \end{macrocode}
% \end{macro}
%

%
% \iffalse
%</package>
% \fi
%
% \Finale
\endinput