Debian Codegraph @

texmf-dist/source/latex/easyreview/easyReview.dtx

raw
1 % \iffalse meta-comment
2 %
3 % Copyright (C) 2014 by jmamatos <[email protected]>
4 % ---------------------------------------------------------------------------
5 % This work may be distributed and/or modified under the
6 % conditions of the LaTeX Project Public License, either version 1.3
7 % of this license or (at your option) any later version.
8 % The latest version of this license is in
9 % http://www.latex-project.org/lppl.txt
10 % and version 1.3 or later is part of all distributions of LaTeX
11 % version 2005/12/01 or later.
12 %
13 % This work has the LPPL maintenance status `maintained'.
14 %
15 % The Current Maintainer of this work is jmamatos.
16 %
17 % This work consists of the files easyReview.dtx and easyReview.ins
18 % and the derived filebase easyReview.sty.
19 %
20 % \fi
21 %
22 % \iffalse
23 %<*driver>
24 \ProvidesFile{easyReview.dtx}
25 %</driver>
26 %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
27 %<package>\ProvidesPackage{easyReview}
28 %<*package>
29 [2014/06/27 Package for Easy Review on LaTeX documents]
30 %</package>
31 %
32 %<*driver>
33 \documentclass{ltxdoc}
34 \usepackage{easyReview}[2014/06/27]
35 \EnableCrossrefs
36 \CodelineIndex
37 \RecordChanges
38 \begin{document}
39 \DocInput{easyReview.dtx}
40 \PrintChanges
41 \PrintIndex
42 \end{document}
43 %</driver>
44 % \fi
45 %
46 % \CheckSum{63}
47 %
48 % \CharacterTable
49 % {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
50 % 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
51 % Digits \0\1\2\3\4\5\6\7\8\9
52 % Exclamation \! Double quote \" Hash (number) \#
53 % Dollar \$ Percent \% Ampersand \&
54 % Acute accent \' Left paren \( Right paren \)
55 % Asterisk \* Plus \+ Comma \,
56 % Minus \- Point \. Solidus \/
57 % Colon \: Semicolon \; Less than \<
58 % Equals \= Greater than \> Question mark \?
59 % Commercial at \@ Left bracket \[ Backslash \\
60 % Right bracket \] Circumflex \^ Underscore \_
61 % Grave accent \` Left brace \{ Vertical bar \|
62 % Right brace \} Tilde \~}
63 %
64 %
65 % \changes{<+version+>}{<+date+>}{Converted to DTX file}
66 %
67 % \DoNotIndex{\newcommand,\newenvironment}
68 %
69 % \providecommand*{\url}{\texttt}
70 % \GetFileInfo{easyReview.dtx}
71 % \title{The \textsf{easyReview} package}
72 % \author{jmamatos \\ \url{[email protected]}}
73 % \date{\fileversion~from \filedate}
74 %
75 % \maketitle
76 %
77 % \section{Introduction}
78 %
79 % Put text here.
80 %
81 % \section{Usage}
82 %
83 % Put text here.
84 %
85 %
86 % \DescribeMacro{\setreviewson}
87 %
88 %
89 % \DescribeMacro{\setreviewsoff}
90 %
91 %
92 % \DescribeMacro{\alertColor}
93 %
94 %
95 % \DescribeMacro{\removeColor}
96 %
97 %
98 % \DescribeMacro{\addColor}
99 %
100 %
101 % \DescribeMacro{\alert}
102 %
103 %
104 % \DescribeMacro{\remove}
105 %
106 %
107 % \DescribeMacro{\add}
108 %
109 %
110 % \DescribeMacro{\substitute}
111 %
112 %
113 % \DescribeMacro{\replace}
114 %
115 %
116 % \DescribeMacro{\highlight}
117 %
118 %
119 % \DescribeMacro{\comment}
120 %
121
122 %
123 % \StopEventually{}
124 %
125 % \section{Implementation}
126 %
127 % \iffalse
128 %<*package>
129 % \fi
130 %
131 %% easyReview.sty, v-1.0 jmamatos
132 %% Copyright 2013- by jmamatos
133 %%
134 %% This work may be distributed and/or modified under the
135 %% conditions of the LaTeX Project Public License, either version 1.3
136 %% of this license or (at your option) any later version.
137 %% The latest version of this license is in
138 %% http://www.latex-project.org/lppl.txt
139 %% and version 1.3 or later is part of all distributions of LaTeX
140 %% version 2005/12/01 or later.
141 %%
142 %% This work has the LPPL maintenance status `maintained'.
143 %%
144 %% The Current Maintainer of this work is jmamatos, led
145 %% by Jody Maick Matos. Further information are available on
146 %% https://github.com/jmamatos/easyReview/
147 %%
148 %%
149 %%
150 %% Revision history:
151 %%
152 %% 2014/06/27 jmamatos
153 %%
154 %%
155 %
156 % \begin{macrocode}
157 \NeedsTeXFormat{LaTeX2e}[1994/06/01]
158 % \end{macrocode}
159 %% This file provide the easyReview package, wich can be used to
160 %% easily review tex documents (or editorial processes).
161 % \begin{macrocode}
162 \ProvidesPackage{easyReview}[2013/12/09 Package for Easy Review on LaTeX documents]
163 \newif\ifistoreview
164 \istoreviewtrue
165 % \end{macrocode}
166 %
167 % \begin{macro}{\setreviewson}
168 % \begin{macrocode}
169 \newcommand{\setreviewson}{\istoreviewtrue}
170 % \end{macrocode}
171 % \end{macro}
172 %
173 %
174 % \begin{macro}{\setreviewsoff}
175 % \begin{macrocode}
176 \newcommand{\setreviewsoff}{\istoreviewfalse}
177 % \end{macrocode}
178 % \end{macro}
179 %
180 % \begin{macrocode}
181 \RequirePackage{soul}
182 \RequirePackage{xcolor}
183 \RequirePackage{todonotes}
184 % \end{macrocode}
185 %
186 % \begin{macro}{\alertColor}
187 % \begin{macrocode}
188 \newcommand{\alertColor}{\textcolor{red}}
189 % \end{macrocode}
190 % \end{macro}
191 %
192 %
193 % \begin{macro}{\removeColor}
194 % \begin{macrocode}
195 \newcommand{\removeColor}{\textcolor{red}}
196 % \end{macrocode}
197 % \end{macro}
198 %
199 %
200 % \begin{macro}{\addColor}
201 % \begin{macrocode}
202 \newcommand{\addColor}{\textcolor{blue}}
203 % \end{macrocode}
204 % \end{macro}
205 %
206 %
207 % \begin{macro}{\alert}
208 % \begin{macrocode}
209 \newcommand{\alert}[1]{\ifistoreview\alertColor{#1}\else #1\fi}
210 % \end{macrocode}
211 % \end{macro}
212 %
213 %
214 % \begin{macro}{\remove}
215 % \begin{macrocode}
216 \newcommand{\remove}[1]{\ifistoreview\alertColor{\st{#1}}\else #1\fi}
217 % \end{macrocode}
218 % \end{macro}
219 %
220 %
221 % \begin{macro}{\add}
222 % \begin{macrocode}
223 \newcommand{\add}[1]{\ifistoreview\addColor{#1}\else #1\fi}
224 % \end{macrocode}
225 % \end{macro}
226 %
227 %
228 % \begin{macro}{\substitute}
229 % \begin{macrocode}
230 \newcommand{\substitute}[2]{\ifistoreview\remove{#1}~\add{#2} \else #1\fi}
231 % \end{macrocode}
232 % \end{macro}
233 %
234 %
235 % \begin{macro}{\replace}
236 % \begin{macrocode}
237 \newcommand{\replace}[2]{\ifistoreview\remove{#1}~\add{#2}\else #1\fi}
238 % \end{macrocode}
239 % \end{macro}
240 %
241 %
242 % \begin{macro}{\highlight}
243 % \begin{macrocode}
244 \newcommand{\highlight}[1]{\hl{#1}}
245 % \end{macrocode}
246 % \end{macro}
247 %
248 %
249 % \begin{macro}{\comment}
250 % \begin{macrocode}
251 \newcommand{\comment}[2]{\highlight{#1}\todo[inline]{#2}}% \end{macrocode}
252 % \end{macro}
253 %
254
255 %
256 % \iffalse
257 %</package>
258 % \fi
259 %
260 % \Finale
261 \endinput