diff options
Diffstat (limited to 'macros/latex/contrib/snaptodo/snaptodo.tex')
-rw-r--r-- | macros/latex/contrib/snaptodo/snaptodo.tex | 102 |
1 files changed, 52 insertions, 50 deletions
diff --git a/macros/latex/contrib/snaptodo/snaptodo.tex b/macros/latex/contrib/snaptodo/snaptodo.tex index 65a3d7d3a6..07f091561a 100644 --- a/macros/latex/contrib/snaptodo/snaptodo.tex +++ b/macros/latex/contrib/snaptodo/snaptodo.tex @@ -1,36 +1,38 @@ \documentclass{article} -\def\todo{} +\def\snaptodo{} \usepackage{snaptodo} \usepackage[pdfusetitle,urlbordercolor=red!50!black]{hyperref} \begin{document} -\title{Snaptodo---A Snap-to-the-Correct-Side Todo\thanks{ +\title{Snaptodo---A todo that snaps to the closer side\thanks{ Repository \url{https://github.com/Symbol1/snaptodo}. }} \author{Hsin-Po Wang\thanks{ Email - \href{mailto:a.simple.people@gmail.com}{\ttfamily a.simple.people@gmail.com}. + \href{mailto:a.simple.people@gmail.com} + {\ttfamily a.simple.people@gmail.com}. Website \url{https://www.symbol.codes}.}} +\date{November 25, 2021} + \maketitle \begin{abstract} - Snaptodo package is an alternative to the todonote package - that differs in the following ways: + Snaptodo package is an alternative to todonote package, + from which it differs in the following ways: (A) Depending on where you call - {\ttfamily\color{red!50!black}\string\todo}, + {\ttfamily\color{red!50!black}\string\snaptodo}, the note is put on the left or right margin, whichever is closer. (B) The notes bump each other down so they never overlap; the lines never overlap either; - and they don't trigger the marginpar warning. (C) Minimalistic, aesthetic, and customizable style. \end{abstract} @@ -48,26 +50,26 @@ \usepackage{snaptodo} \begin{document} Your done - \todo{Your todo} + \snaptodo{Your todo} \end{document} \end{verbatim} \section{Showcase of Examples} Using snaptodo is as simple as calling - {\ttfamily\verb|\todo|}% - \todo{Calling \texttt{\string\todo}!} + {\ttfamily\verb|\snaptodo|}% + \snaptodo{Calling \texttt{\string\snaptodo}!} and compile twice.% - \todo{Compile twice!} + \snaptodo{Compile twice!} If the calling point% - \todo{Calling point!} + \snaptodo{Calling point!} is on the left of a page,% - \todo{Left of a page!} + \snaptodo{Left of a page!} the todo note---after compiling twice of course---will appear to the left margin.% - \todo{On the left margin!} + \snaptodo{On the left margin!} And vice versa.% - \todo{Vice versa!} + \snaptodo{Vice versa!} \section{Customization} @@ -81,7 +83,7 @@ you can also assess the exact same options by {\ttfamily\verb|\pgfkeys{/snaptodo/<some_option>}|}. For local changes, you can put them here - {\ttfamily\verb|\todo[<some_option>]{}|}. + {\ttfamily\verb|\snaptodo[<some_option>]{}|}. \subsection{Color} @@ -92,9 +94,9 @@ Saying {\ttfamily\verb|\colorlet{snaptodo@chain}{green!50!white}|} lets you to change this color globally. On the other hand, - for locally changing this color, one may prefer using - {\ttfamily\verb|\todo[call chain/.style=green!50!white]|}.% - \todo[call chain/.style=green!50!white]{New broken line color} + for locally changing this color, one may prefer + {\ttfamily\verb|\snaptodo[call chain/.style=green!50!white]{}|}.% + \snaptodo[call chain/.style=green!50!white]{New broken line color} The color of the note text is {\ttfamily\verb|snaptodo@block|}. @@ -103,9 +105,9 @@ Saying {\ttfamily\verb|\colorlet{snaptodo@block}{blue!50!white}|} lets you change this color. On the other hand, - for locally changing this color, one may prefer using - {\ttfamily\verb|\todo[margin block/.style=blue!50!white]|}.% - \todo[margin block/.style=blue!50!white]{New note text color} + for locally changing this color, one may prefer + {\ttfamily\verb|\snaptodo[margin block/.style=blue!50!white]{}|}.% + \snaptodo[margin block/.style=blue!50!white]{New note text color} \subsection{Line style} @@ -115,9 +117,9 @@ {\ttfamily\verb|[ultra thin]|}, or {\ttfamily\verb|[line width=???]|}. - In our case, simply put that option in the proper style - {\ttfamily\verb|\todo[call chain/.style={line width=???}]{}|}.% - \todo[call chain/.style={line width=2pt}]{Thicker broken line} + In our case, simply put that option in this style + \snaptodo[call chain/.style={line width=2pt}]{Thicker broken line}% + {\ttfamily\verb|\snaptodo[call chain/.style={line width=???}]{}|}. In order to use a special dash pattern, recall the standard Ti\emph kZ option @@ -125,9 +127,9 @@ {\ttfamily\verb|[dashed]|}, or {\ttfamily\verb|[dash pattern=???]|}. - In our case, simply put that option in the proper style - {\ttfamily\verb|\todo[call chain/.style={dash pattern=???}]{}|}.% - \todo[call chain/.style={dashed}]{Dashed broken line} + In our case, simply put that option in this style + \snaptodo[call chain/.style={dashed}]{Dashed broken line}% + {\ttfamily\verb|\snaptodo[call chain/.style={dash pattern=???}]{}|}. \subsection{Sep and width} @@ -138,9 +140,9 @@ Use {\ttfamily\verb|\snaptodoset{block sep=0pt}|} for global setting and use - {\ttfamily\verb|\todo[block sep=0pt]{note}|}% - \todo[block sep=0pt]{2 blocks close.} - \todo[block sep=0pt]{..to each other} + {\ttfamily\verb|\snaptodo[block sep=0pt]{note}|}% + \snaptodo[block sep=0pt]{2 blocks close.} + \snaptodo[block sep=0pt]{..to each other} for local setting this. The gap between two horizontal lines is stored in @@ -150,9 +152,9 @@ To change, use {\ttfamily\verb|\snaptodoset{chain sep=0pt}|} for global setting and - {\ttfamily\verb|\todo[chain sep=0pt]{note}|}% - \todo[chain sep=0pt]{2 chains close.} - \todo[chain sep=0pt]{..to each other} + {\ttfamily\verb|\snaptodo[chain sep=0pt]{note}|}% + \snaptodo[chain sep=0pt]{2 chains close.} + \snaptodo[chain sep=0pt]{..to each other} for local setting. The width of the note block is @@ -168,10 +170,10 @@ to the right is the center of the page, by default. You can change this by {\ttfamily\verb|/snaptodo/chain bias=-99in|}.% - \todo[chain bias=-99in]{Forced to the left} + \snaptodo[chain bias=-99in]{Forced to the left} That way, all todo notes are forcedly snapped to the left hand side. Or, by - \todo[chain bias=99in]{Forced to the right}% + \snaptodo[chain bias=99in]{Forced to the right}% {\ttfamily\verb|/snaptodo/call bias=99in|}, all todo notes are forcedly snapped to the right hand side. @@ -179,13 +181,13 @@ If your document is really busy, e.g., like {\ttfamily\verb|stress_testing.tex|}, - consider setting a positive - {\ttfamily\verb|/snaptodo/block rise|}.% - \todo[block rise=2em]{Rising} - \todo[block rise=2em]{to leave} - \todo[block rise=2em]{room.} - For instance, - {\ttfamily\verb|\todo[block rise=2em]{}|}. + try setting a positive + {\ttfamily\verb|/snaptodo/block rise|},% + \snaptodo[block rise=2em]{Rising} + \snaptodo[block rise=2em]{to leave} + \snaptodo[block rise=2em]{room.} + e.g., + {\ttfamily\verb|\snaptodo[block rise=2em]{}|}. That way, a note will rise by that amount to leave more rooms for later notes. (But if there will be overlay, @@ -204,7 +206,7 @@ {\ttfamily\verb|align=flush \std@rightleft|}, is what you do,% \makeatletter - \todo[margin block/.style={align=flush \std@rightleft}] + \snaptodo[margin block/.style={align=flush \std@rightleft}] {flush toward text body} \makeatother the text will be flushed toward the main @@ -217,13 +219,13 @@ \subsection{Font} Font size is controlled by - \todo[margin block/.style={font=\tiny}]{tiny} - \todo[margin block/.style={font=\Large}]{Large} - \todo[margin block/.style={font=\Huge}]{Huge} + \snaptodo[margin block/.style={font=\tiny}]{tiny} + \snaptodo[margin block/.style={font=\Large}]{Large} + \snaptodo[margin block/.style={font=\Huge}]{Huge} {\ttfamily\verb|/snpatodo/margin block/.style={font=...}|}. - \todo[margin block/.style={font=\itshape}]{itshape} - \todo[margin block/.style={font=\sffamily}]{sffamily} - \todo[margin block/.style={font=\bfseries}]{bfseries} + \snaptodo[margin block/.style={font=\itshape}]{itshape} + \snaptodo[margin block/.style={font=\sffamily}]{sffamily} + \snaptodo[margin block/.style={font=\bfseries}]{bfseries} So is font family. \end{document} |