Notebox Module
The notebox module includes a collection of plugins for creating different types of informational boxes with text that can be used to draw the attention of the reader. The different info boxes have unique icons and colors.
There are five types of information boxes available, all of which have a similar syntax and key options.
\begin{note}[title=text style=names]
...
\end{note}
\begin{warn}[title=text style=names]
...
\end{warn}
\begin{error}[title=text style=names]
...
\end{error}
\begin{tip}[title=text style=names]
...
\end{tip}
\begin{define}{term}[title=text style=names]
...
\end{define}
- term
-
A required argument for the definition box which indicates the term being defined.
- title
-
An optional argument for specifying the text to display in the title bar of the box. The default is to display an appropriate single word title for the given box.
- style
-
Class name(s) appended to the table's class name. This allows for additional styling or minor adjustments to the default style of the information boxes.
Examples
Examples are provided below for each of the five types of information boxes.
- \begin{note}[title='Note Title']
- This is an example box displaying a note or information for the reader.
- \end{note}
- \begin{warn}
- This is an example box displaying a ''warning'' for the reader.
- \end{warn}
- \begin{error}
- This is an example box displaying an ''error'' message for the reader.
- \end{error}
- \begin{tip}
- The reader can be provided with a programming tip using the ''tip'' box.
- \end{tip}
- \begin{define}{word}
- Define a word or term for the reader.
- \end{define}