CTAN Comprehensive TeX Archive Network

Directory macros/latex/contrib/zebra-goodies

README.md

zebra-goodies

A collection of handy note-taking macros such as todo and comment. It is primarily intended for draft and review workflows.

Options

  • draft: boolean option, whether to show the notes. Enabled by default. Example to disable it:
  •   \usepackage[draft=false]{zebra-goodies}
      % or use the complementary option "final"
      \usepackage[final]{zebra-goodies}
      
  • microtypeexpansion: boolean option, whether to enable microtype font expansion. Enabled by default. zebra-goodies ensures microtype is loaded. Example to disable expansion while keeping microtype loaded:
  •   \usepackage[microtypeexpansion=false]{zebra-goodies}
      % or use the complementary option "nomicrotypeexpansion"
      \usepackage[nomicrotypeexpansion]{zebra-goodies}
      
  • Engines without font expansion support still fall back to expansion=false automatically.
  • hyperref: boolean option, whether to load package hyperref. Enabled by default. Example to disable it:
  •   \usepackage[hyperref=false]{zebra-goodies}
      % or use the complementary option "nohyperref"
      \usepackage[nohyperref]{zebra-goodies}
      
  • listofnotes: boolean option, whether to print the summary table and detailed note list at the end of the document. Enabled by default. Example to disable it:
  •   \usepackage[listofnotes=false]{zebra-goodies}
      % or use the complementary option "nolistofnotes"
      \usepackage[nolistofnotes]{zebra-goodies}
      

Take Notes

Add comments, todos, and notes during drafting in a visible way. The package also prints a summary table and a detailed note list at the end of the document. The predefined commands are:

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

If any of these short names does not work, it is very likely that another package has already defined it. zebra-goodies does not overwrite existing commands, so use the always-available prefixed forms instead:

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

Define new Notes

% \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 plotting:

  • zebrablue
  • zebrared
  • zebrayellow
  • zebrapurple
  • zebragreen

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 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.

Download the contents of this package in one zip archive (639.0k).

zebra-goodies – A collection of handy macros for (paper) writing

This package offers a collection of macros to help in the process of writing a paper. You may add comments, todo notes, etc. during revision, in a colourful way. The package also summarizes the inserted notes at the end of the document.

There are some predefined note commands as well as a way of defining new ones to suit the user's needs.

You may safely remove this package once the paper is finished.

Note: “zebra” is the name of the package author's lab.

Packagezebra-goodies
Home pagehttps://github.com/xueruini/zebra-goodies
Bug trackerhttps://github.com/xueruini/zebra-goodies/issues
Repositoryhttps://github.com/xueruini/zebra-goodies
Developershttps://github.com/xueruini
Version1.0.0 2026-03-16
LicensesThe Project Public License 1.3c
Copyright2016–2026 Ruini Xue
MaintainerRuini Xue
Contained inTeX Live as zebra-goodies
MiKTeX as zebra-goodies
TopicsEditorial
Notes
Marginal
...
Guest Book Sitemap Contact Contact Author