summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/zebra-goodies/README.md
blob: 66e844e3afa1a133d1f29cd179ba64d2b28e6538 (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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# zebra-goodies

A collection of handy macros for note taking, like `todo` and `comment`. This is
not intended for general cases. Use it at your own risk.

## Options

- `draft`: boolean option, whether to show the notes. Enabled by default. Example to disable it:
    ```latex
    \usepackage[draft=false]{zebra-goodies}
    % or use the complementary option "final"
    \usepackage[final]{zebra-goodies}
    ```
- `microtype`: boolean option, whether to load package `microtype`. Enabled by default.

## Take Notes

Add comments, todos, notes anything you like during revise in a colorful way.
The package also summarizes the revise notes at the end of the document.
Predefined commands are as follows:

```latex
\todo[<who>]{bla bla}
\fixed[<who>]{bla bla}
\comment[<who>]{bla bla}
\note[<who>]{bla bla}
\placeholder[<who>]{bla bla}
```

If any of them does not work, it is very likely that it has been defined by
other packages. We will not override the definition, so you have to turn to its
full version as follows:

```latex
\zebratodo[<who>]{bla bla}
\zebrafixed[<who>]{bla bla}
\zebracomment[<who>]{bla bla}
\zebranote[<who>]{bla bla}
\zebraplaceholder[<who>]{bla bla}
```

## Define new Notes

```latex
% \zebranewnote{<note name>}{<xcolor color>}

\colorlet{mycyan}{cyan}
\zebranewnote{question}{mycyan}

\question[who]{what's this?}
```

## Use Colors 

Several colors are provided via `xcolor` for ploting:
- `zebrablue`
- `zebrared`
- `zebrayellow`
- `zebrapurple`
- `zebragreen`