zebra

A writing revision toolkit for LaTeX. The current release focuses on inline note-taking, providing macros (\todo, \comment, \fixed, \note, \placeholder) for collaborative writing. Notes are colour-coded, numbered, and marked in the margin. A summary table and clickable note list are appended at the end of the document. The final option suppresses all notes for clean output.

Migration: This package was previously distributed as zebra-goodies.
The old name still works but prints a deprecation warning.

Options

• draft / final: show or suppress notes. Default: draft.

  \usepackage[final]{zebra}
  

• sort: order of the detailed note list. none (default, document order) or type (grouped by note type).

  \usepackage[sort=type]{zebra}
  

• font-expansion / nofont-expansion: control microtype font expansion, which usually improves the appearance of the document. Disable it if it conflicts with your engine or another package. Default: enabled. microtype remains loaded when expansion is disabled.

  \usepackage[nofont-expansion]{zebra}
  

• pagelinks / nopagelinks: enable or disable clickable page-number links in the detailed note list. Default: enabled.

  \usepackage[nopagelinks]{zebra}
  

Take Notes

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

If a short name clashes with another package, use the prefixed form:

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

Define New Notes

\colorlet{mycyan}{cyan}
\zebranewnote{question}{mycyan}              % uses default symbol
\zebranewnote{question}{mycyan}[$\diamond$]  % custom symbol for this type

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

Customise Existing Types

Use \zebrasetup to change the colour or symbol of any note type after loading:

\zebrasetup{color/todo=red}                 % red todos
\zebrasetup{symbol/fixed=$\surd$}           % tick mark for fixed notes
\zebrasetup{color/todo=red, symbol/fixed=$\surd$}  % combine several keys

Author

Ruini Xue <xueruini@gmail.com>

License

Copyright (C) 2016-2026, Ruini Xue

This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), version 1.3c. The latest version of this license is at:

http://www.latex-project.org/lppl.txt

This work is "maintained" (as per LPPL maintenance status) by Ruini Xue.