From 7d498c1740327a429a1baaeab208434de07c095f Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 25 Nov 2021 21:24:35 +0000 Subject: snaptodo (25nov21) git-svn-id: svn://tug.org/texlive/trunk@61155 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/latex/snaptodo/README | 22 ++--- Master/texmf-dist/doc/latex/snaptodo/snaptodo.pdf | Bin 207510 -> 208140 bytes Master/texmf-dist/doc/latex/snaptodo/snaptodo.tex | 102 +++++++++++---------- .../doc/latex/snaptodo/test/before_after.tex | 6 +- .../doc/latex/snaptodo/test/circle_testing.tex | 10 +- .../doc/latex/snaptodo/test/minimal_testing.tex | 2 +- .../doc/latex/snaptodo/test/stress_testing.tex | 2 +- 7 files changed, 73 insertions(+), 71 deletions(-) (limited to 'Master/texmf-dist/doc') diff --git a/Master/texmf-dist/doc/latex/snaptodo/README b/Master/texmf-dist/doc/latex/snaptodo/README index 8d990a8be36..37da2cd92f6 100644 --- a/Master/texmf-dist/doc/latex/snaptodo/README +++ b/Master/texmf-dist/doc/latex/snaptodo/README @@ -5,18 +5,18 @@ https://github.com/Symbol1/snaptodo Hsin-Po Wang mailto:a.simple.people@gmail.com -https://github.com/Symbol1/snaptodo +https://www.symbol.codes -This is snaptodo, -an alternative to todonote -that differs in the following ways +This is snaptodo package, +an alternative to todonote package, +from which it differs in the following ways: -* Depending on where you call `\todo`, - the note is on the left or right margin, +* Depending on where you call `\snaptodo`, + the note is put on the left or right margin, whichever is closer. -* The notes bump each other - so they never overlap; - the lines never overlap either -* Aesthetic and customizable style. +* The notes bump each other down so they never overlap; + the lines never overlap either. +* Minimalistic, aesthetic and customizable style. -License = https://www.latex-project.org/lppl/lppl-1-3c/ +License +https://www.latex-project.org/lppl/lppl-1-3c/ diff --git a/Master/texmf-dist/doc/latex/snaptodo/snaptodo.pdf b/Master/texmf-dist/doc/latex/snaptodo/snaptodo.pdf index 7115795b1b3..cd719dd451b 100644 Binary files a/Master/texmf-dist/doc/latex/snaptodo/snaptodo.pdf and b/Master/texmf-dist/doc/latex/snaptodo/snaptodo.pdf differ diff --git a/Master/texmf-dist/doc/latex/snaptodo/snaptodo.tex b/Master/texmf-dist/doc/latex/snaptodo/snaptodo.tex index 65a3d7d3a6f..07f091561a9 100644 --- a/Master/texmf-dist/doc/latex/snaptodo/snaptodo.tex +++ b/Master/texmf-dist/doc/latex/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/}|}. For local changes, you can put them here - {\ttfamily\verb|\todo[]{}|}. + {\ttfamily\verb|\snaptodo[]{}|}. \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} diff --git a/Master/texmf-dist/doc/latex/snaptodo/test/before_after.tex b/Master/texmf-dist/doc/latex/snaptodo/test/before_after.tex index 99552464e22..88dc16b644f 100644 --- a/Master/texmf-dist/doc/latex/snaptodo/test/before_after.tex +++ b/Master/texmf-dist/doc/latex/snaptodo/test/before_after.tex @@ -16,9 +16,9 @@ promote the general Welfare, and secure the Blessings of Liberty to ourselves and our Posterity, do ordain and establish this Constitution for the United States of America. -\def\todoexample{% +\def\snaptodoexample{% \pgfmathtruncatemacro\wc{round(1+rnd*10)}% - \todo{% + \snaptodo{% \foreach\w in{1,...,\wc}{% \pgfmathsetmacro\l{1+rnd*10}% \rule{\l pt}{1ex} @@ -26,7 +26,7 @@ States of America. }, } \catcode`\,=\active -\let,=\todoexample +\let,=\snaptodoexample \section{After todo notes} diff --git a/Master/texmf-dist/doc/latex/snaptodo/test/circle_testing.tex b/Master/texmf-dist/doc/latex/snaptodo/test/circle_testing.tex index f501a03cd16..6885de11cab 100644 --- a/Master/texmf-dist/doc/latex/snaptodo/test/circle_testing.tex +++ b/Master/texmf-dist/doc/latex/snaptodo/test/circle_testing.tex @@ -16,9 +16,9 @@ \foreach\fr in{1,...,\nframe}{ \noindent\\[\dimexpr-1em-\baselineskip] - \todo{North West} + \snaptodo{North West} \hfill - \todo{North East} + \snaptodo{North East} \vskip0ptplus1fill \pgfmathsetmacro\x{72*cos(\fr0/\nframe*36*3)} @@ -27,14 +27,14 @@ \noindent \hskip1in \hskip\x pt% - \todo{Hobbit} + \snaptodo{Hobbit} \vskip-\y pt \vskip0ptplus1fill \noindent - \todo{South West} + \snaptodo{South West} \hfill - \todo{South East} + \snaptodo{South East} \clearpage } diff --git a/Master/texmf-dist/doc/latex/snaptodo/test/minimal_testing.tex b/Master/texmf-dist/doc/latex/snaptodo/test/minimal_testing.tex index 428eaa1676b..28adb0562c4 100644 --- a/Master/texmf-dist/doc/latex/snaptodo/test/minimal_testing.tex +++ b/Master/texmf-dist/doc/latex/snaptodo/test/minimal_testing.tex @@ -3,5 +3,5 @@ \usepackage{snaptodo} \begin{document} Your done - \todo{Your todo} + \snaptodo{Your todo} \end{document} diff --git a/Master/texmf-dist/doc/latex/snaptodo/test/stress_testing.tex b/Master/texmf-dist/doc/latex/snaptodo/test/stress_testing.tex index c2b5617fcea..a0d32740e82 100644 --- a/Master/texmf-dist/doc/latex/snaptodo/test/stress_testing.tex +++ b/Master/texmf-dist/doc/latex/snaptodo/test/stress_testing.tex @@ -10,7 +10,7 @@ \def\todoexample{% \pgfmathtruncatemacro\wc{round(1+rnd*10)}% - \todo{% + \snaptodo{% \foreach\w in{1,...,\wc}{% \pgfmathsetmacro\l{1+rnd*10}% \rule{\l pt}{1ex} -- cgit v1.2.3