summaryrefslogtreecommitdiff
path: root/toolbox.sty
blob: 9231c8200a6df979d0ef206511ef5320c74d4039 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

\ProvidesPackage{toolbox}
%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%
%                      Required Packages for the Module                      %
%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%
\RequirePackage{xcolor}   % Addition of colors and color boxes

%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%
%                       Useful Functions for Team Work                       %
%~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~%
% The following should NEVER apprear in a final document.
%
% Their goal is to provide a better team work experience by adding
% colorful/highlighted keywords into the pdfdocument.


%% Usage (These function require a user input)
% \todo{Something to be done...}
% \note{A note to communicate to your team}
% \fixme{An error you wish to higlight for later fix}

\newcommand{\todo}[1]{\colorbox{red}{\textbf{TODO}:}#1}
\newcommand{\note}[1]{\colorbox{orange}{\textbf{NOTE}:}#1}
\newcommand{\fixme}[1]{\colorbox{purple}{\textbf{FIXME}:}#1}

%% Usage (These function DON'T require a user input)
% \addref   --> Displays "addref" highlighted in magenta
% \addcite  --> Displays "addcite" highlighted in magenta
% \addimg   --> Displays "addimg" highlighted in cyan
\newcommand{\addref}{\colorbox{magenta}{add ref}}
\newcommand{\addcite}{\colorbox{magenta}{add citation}}
\newcommand{\addimg}{\colorbox{cyan}{add image!}}