diff options
| -rw-r--r-- | Master/texmf-dist/doc/latex/hf-tikz/README.txt | 15 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/latex/hf-tikz/hf-tikz.pdf | bin | 114062 -> 124608 bytes | |||
| -rw-r--r-- | Master/texmf-dist/source/latex/hf-tikz/hf-tikz.dtx | 174 | ||||
| -rw-r--r-- | Master/texmf-dist/source/latex/hf-tikz/hf-tikz.ins | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/tex/latex/hf-tikz/hf-tikz.sty | 4 |
5 files changed, 117 insertions, 80 deletions
diff --git a/Master/texmf-dist/doc/latex/hf-tikz/README.txt b/Master/texmf-dist/doc/latex/hf-tikz/README.txt deleted file mode 100644 index 207fac77a84..00000000000 --- a/Master/texmf-dist/doc/latex/hf-tikz/README.txt +++ /dev/null @@ -1,15 +0,0 @@ -* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * -* hf-tikz --- A simple way to highlight formulas and formula parts. -* -* E-mail: claudio dot fiandrino at gmail dot com -* -* Released under the LaTeX Project Public License v1.3c or later -* -* See http://www.latex-project.org/lppl.txt -* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * - -The package provides a way to highlight formulas and formula parts -in both documents and presentations thanks to TikZ. - - - diff --git a/Master/texmf-dist/doc/latex/hf-tikz/hf-tikz.pdf b/Master/texmf-dist/doc/latex/hf-tikz/hf-tikz.pdf Binary files differindex 4e7a4b1a915..9df3f8fa051 100644 --- a/Master/texmf-dist/doc/latex/hf-tikz/hf-tikz.pdf +++ b/Master/texmf-dist/doc/latex/hf-tikz/hf-tikz.pdf diff --git a/Master/texmf-dist/source/latex/hf-tikz/hf-tikz.dtx b/Master/texmf-dist/source/latex/hf-tikz/hf-tikz.dtx index efb98a2cf92..067d4ee9f5a 100644 --- a/Master/texmf-dist/source/latex/hf-tikz/hf-tikz.dtx +++ b/Master/texmf-dist/source/latex/hf-tikz/hf-tikz.dtx @@ -40,7 +40,7 @@ in both documents and presentations thanks to TikZ. \endpreamble \postamble -Copyright (C) 2012 by Claudio Fiandrino <claudio.fiandrino@gmail.com> +Copyright (C) 2012-2014 by Claudio Fiandrino <claudio.fiandrino@gmail.com> This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), either @@ -64,12 +64,10 @@ and the derived files hf-tikz.ins and %</install> %<install>\endbatchfile %<*internal> -\usedir{source/latex/hf-tikz} \generate{ \file{\jobname.ins}{\from{\jobname.dtx}{install}} } \nopreamble\nopostamble -\usedir{doc/latex/demopkg} \generate{ \file{README.txt}{\from{\jobname.dtx}{readme}} } @@ -81,7 +79,7 @@ and the derived files hf-tikz.ins and %</internal> %<*package> \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{hf-tikz}[2013/01/13 v0.3 A simple way to highlight formulas and formula parts.] +\ProvidesPackage{hf-tikz}[2014/07/25 v0.3a A simple way to highlight formulas and formula parts.] %</package> %<*driver> \documentclass{ltxdoc} @@ -98,6 +96,7 @@ and the derived files hf-tikz.ins and \newcommand{\packoption}[2]{\textcolor{blue!60!cyan}{\texttt{#1}} \texttt{(initial:~#2)}} \newcommand{\smkey}[1]{\textcolor{blue!60!cyan}{\texttt{#1}}} \newcommand{\smoption}[1]{\textcolor{orange!30!red}{\texttt{#1}}} +\newcommand{\hftikz}{\textsf{hf-tikz}} \EnableCrossrefs \CodelineIndex \RecordChanges @@ -129,6 +128,7 @@ and the derived files hf-tikz.ins and % \changes{v0.1a}{2012/12/18}{Fixed bug \pgfpointorigin} % \changes{v0.2}{2013/01/13}{Added norndcorners and warning second run} % \changes{v0.3}{2013/03/01}{Key interface and markings option} +% \changes{v0.3}{2014/07/25}{Documentation} % % \GetFileInfo{hf-tikz.sty} % @@ -139,7 +139,7 @@ and the derived files hf-tikz.ins and % \maketitle % \begin{abstract} % This package provides a way to \emph{highlight} formulas in both documents and presentations thanks to Ti\emph{k}Z. -% The idea cames out from \href{http://tex.stackexchange.com/questions/52598/beamer-highlighting-aligned-math-with-overlay}{this question} on \href{http://tex.stackexchange.com}{TeX.StackExchange} +% The idea originated in \href{http://tex.stackexchange.com/questions/52598/beamer-highlighting-aligned-math-with-overlay}{this question} on \href{http://tex.stackexchange.com}{TeX.StackExchange} % and it is based on the \texttt{tikzmark} macro from \href{http://tex.stackexchange.com/users/86/andrew-stacey}{Andrew Stacey} and %\href{http://tex.stackexchange.com/users/4301/peter-grill}{Peter Grill}. % @@ -147,12 +147,12 @@ and the derived files hf-tikz.ins and % \tableofcontents % % \section{Introduction and requirements} -% The aim of the package is to provide a simple way to highlight formulas. This is not the first package that tries to accomplish this task, but, rather than \href{http://www.ctan.org/pkg/empheq}{empheq}, \mbox{\textsf{hf-tikz}} provides also a way to highlight formulas overlay-aware inside a presentation, not only in standard documents. Moreover, in contrast with \href{http://www.ctan.org/pkg/empheq}{empheq}, \textsf{hf-tikz} even allows to highlight just a part of an equation. +% The aim of the package is to provide a simple way to highlight formulas. \hftikz\ is not the first package that tries to accomplish this task, but, despite \href{http://www.ctan.org/pkg/empheq}{empheq}, it provides not only a way to highlight formulas in standard document, but also inside a presentation though Beamer overlay-aware specifications. In addition, with respect to \href{http://www.ctan.org/pkg/empheq}{empheq}, \hftikz\ even allows to highlight just a part of a formula. % % The package uses Ti\emph{k}Z and it is based on the \texttt{tikzmark} macro from \href{http://tex.stackexchange.com/users/86/andrew-stacey}{Andrew Stacey} and -%\href{http://tex.stackexchange.com/users/4301/peter-grill}{Peter Grill} (see as reference \href{http://tex.stackexchange.com/questions/51582/background-coloring-with-overlay-specification-in-algorithm2e-beamer-package}{this answer} and \href{http://tex.stackexchange.com/questions/50015/tikzmark-to-have-different-behaviour-if-first-run-and-mark-locations-not-yet-av}{this question}): among the numerous versions present on \href{http://tex.stackexchange.com}{TeX.SX}, the reference one implemented is taken from \href{http://tex.stackexchange.com/questions/57537/issues-and-potentiality-of-the-tikzmark-macro-dynamic-box-adaptation#57655}{this answer}. Indeed, as explained later, the concept of \emph{extendible markers} helps in customizing the box dimension. +%\href{http://tex.stackexchange.com/users/4301/peter-grill}{Peter Grill} (see \href{http://tex.stackexchange.com/questions/51582/background-coloring-with-overlay-specification-in-algorithm2e-beamer-package}{this answer} and \href{http://tex.stackexchange.com/questions/50015/tikzmark-to-have-different-behaviour-if-first-run-and-mark-locations-not-yet-av}{this question}): among the numerous versions present on \href{http://tex.stackexchange.com}{TeX.SX}, the one the package implements is taken from \href{http://tex.stackexchange.com/questions/57537/issues-and-potentiality-of-the-tikzmark-macro-dynamic-box-adaptation#57655}{this answer}. Indeed, as explained later, the concept of \emph{extendible markers} helps a lot in customizing the box dimension. % -% The packages loaded by \textsf{hf-tikz} are: +% The packages loaded by \hftikz\ are: % \begin{itemize} % \item Ti\emph{k}Z and the libraries \library{shadings} and \library{decorations.markings} (this library is not always loaded, see subsection \ref{subsec:markings}); % \item \textsf{xparse}; @@ -160,28 +160,28 @@ and the derived files hf-tikz.ins and % \end{itemize} % % -% \section{The usage} +% \section{Using the package} % \subsection{The basic commands} -% Formulas can be highlighted by means of the insertion of delimiters before and -% after the part to be highlighted. Two compilation runs are always necessary: the first one to compute the position of the markers (also called delimiters) and the second one to place the box. +% Formulas can be highlighted by inserting a pair of delimiters before and +% after the part to be highlighted. Two compilation runs are always necessary: the first one to compute the position of the delimiters (also called markers in this manual) and the second one to actually place the box. % \DescribeMacro{\tikzmarkin}^^A -% The starting delimiter should be introduced with the \cs{tikzmarkin} macro: it has a different syntax upon +% The starting delimiter should be introduced with the \cs{tikzmarkin} macro: it may assume a different syntax upon % being in \texttt{beamer} mode or not as it will be pointed out in subsection \ref{subsec:beamer}. % % \DescribeMacro{\tikzmarkend}^^A % The end delimiter should be introduced by means of the \cs{tikzmarkend} macro: despite \cs{tikzmarkin}, -% this macro keeps the same syntax also in \texttt{beamer} mode. +% this macro keeps the same syntax in \texttt{beamer} mode too. % -% An example of the basic usage is: +% An example of the basic use is: % \begin{verbatim} % \[x+\tikzmarkin{a}y\tikzmarkend{a}=400\] % \end{verbatim} % which produces: % \[x+\tikzmarkin{a}y\tikzmarkend{a}=400\] % -% Notice that delimiter labels, also called \texttt{marker-id}s, should characterize \emph{uniquely} the part highlighted therefore reuse the same label name twice will lead to undesired results. Along this documentation there are examples showing how it is possible to give label names. +% Notice that the delimiter labels, also called \texttt{marker-id}s, should characterize \emph{uniquely} the part highlighted. Reusing the same name more than once will lead to undesired results. Along this documentation there are examples that illustrates some guidelines to provide names consistenly. % -% In presence of fractions, sums, integrals and other operators, the standard command is not suitable. Consider the following example: +% In presence of fractions, sums, integrals and other operators, the standard command is not appropriate. Consider the following example: % \begin{verbatim} % \[\tikzmarkin{a-1}x+\dfrac{z}{y}=400\tikzmarkend{a-1}\] % \end{verbatim} @@ -202,12 +202,12 @@ and the derived files hf-tikz.ins and % \tikzmarkend{right delim frac} % \end{equation} % -% The \emph{shift-offsets} should be introduced following this syntax: +% The \emph{shift-offsets} should be introduced using the following syntax: % \begin{verbatim} % \tikzmarkin{marker-id}(below right offset)(above left offset) % \end{verbatim} % -% Here is an image that explains the differences between the default setting and the \emph{shift-offsets} manually inserted for the previous example: +% The following image explains pretty well the difference between the default setting and the \emph{shift-offsets} used in the previous example: % \bigskip % \begin{center} % \tikzmarkin{r}(0.1,-0.4)(-0.1,0.5)\tikz[baseline=-0.5ex]\node[opacity=0]{\ensuremath{x+\dfrac{z}{y}=400}};\tikzmarkend{r} @@ -229,9 +229,9 @@ and the derived files hf-tikz.ins and % \draw plot[mark=x] coordinates{(f)} node[above]{\scriptsize{\texttt{default setting}}}; % \end{tikzpicture} % -% Manual shifts allow to customize dimensions on the base of user's needs: they should be introduced inside round braces as coordinate points. Coordinates, indeed, introduce more degree of freedom from the user's point of view while other solutions are more restrictive. Markers, therefore, are \emph{extensible}. Notice that is is not possible to use markers separately, but they should be declared in pair. +% Manual shifts allow to customize the box dimension on the base of user's needs: they should be introduced inside round braces as coordinate points. Coordinates, indeed, provide more degree of freedom from the user's point of view whereas other solutions are more restrictive. Markers, therefore, are \emph{extensible}. Notice that with the aformentioned syntax, it is not possible to use the markers separately, but they should be declared in pair. % -% From version 0.3 it is also possible to exploit a key-interface to set the \emph{shift-offsets}; for example, the previous example, could be done in another manner: +% From version 0.3, it is also possible to exploit a key-based interface to set the \emph{shift-offsets}; for example, the previous example, could have been done as follows: % \begin{verbatim} % \begin{equation} % \tikzmarkin[below right offset={0.1,-0.4},above left offset={-0.1,0.5}] @@ -249,9 +249,9 @@ and the derived files hf-tikz.ins and % % The list of keys available to customize the \emph{shift-offsets} are: % \begin{itemize} -% \item \packoption{left}{-0.1/-0.075}: this key sets the left offset (the second value is active when the \smoption{fill} option is active); +% \item \packoption{left}{-0.1/-0.075}: this key sets the left offset (the second value is active when the \smoption{fill} option is passed to the package); % -% \item \packoption{right}{0.1/0.075}: this key sets the right offset (the second value is active when the \smoption{fill} option is active); +% \item \packoption{right}{0.1/0.075}: this key sets the right offset (the second value is active when the \smoption{fill} option is passed to the package); % % \item \packoption{above}{0.35}: this key sets the above offset; % @@ -259,17 +259,17 @@ and the derived files hf-tikz.ins and % % \item \packoption{below right}{0.1/0.075,0.35}: this key sets contemporarely the below and the right offsets; % -% \item \packoption{above left}{-0.1/-0.075,0.35}: this optikeyon sets contemporarely the above and the left offsets. +% \item \packoption{above left}{-0.1/-0.075,0.35}: this key sets contemporarely the above and the left offsets. % % \end{itemize} % -% All the keys, not only those ones dedicated to the \emph{shift-offsets}, should be introduced in the first optional argument if \smoption{beamer} option is disables or in the second argument in the other case. In this way, the keys have a local application; if, instead, they are set by means of \verb|\tikzset{}| they are applied to the whole document. For example: +% All the keys, not only the ones devoted to the \emph{shift-offsets}, should be introduced in the first optional argument only if the \smoption{beamer} option is not loaded. In the other case, the first argument of \verb|\tikzmarkin| concerns the overly-specification definition. Furthermore, the keys provided in the optional argument have a local scope. On the contrary, when they are set by means of \verb|\tikzset{}|, they are applied to the whole document. For example: % \begin{verbatim} % \tikzset{above left offset={-0.1,0.325},below right offset={0.1,-0.4}} % \end{verbatim} % % \subsection{An advanced example} -% This example shows how to insert an annotation aligned with a sentence: it requires the \library{calc} library from Ti\emph{k}Z. The way in which colors are set is explained in subsection \ref{subsec:customcolors}. +% This example shows how to insert an annotation aligned with a sentence: it requires the \library{calc} library from Ti\emph{k}Z. The colors have been set accordingly to the explanation provided in subsection \ref{subsec:customcolors}. % \hfsetfillcolor{red!10} % \hfsetbordercolor{red} % \begin{equation*} @@ -306,11 +306,9 @@ and the derived files hf-tikz.ins and % \end{tikzpicture} % \end{verbatim} % -% The message here is that, when something is highlighted, the \texttt{marker-id} could be used to subsequently add elements on the image, i.e. the annotation. +% Note that when a formula is highlighted, the \texttt{marker-id} can be used to subsequently add elements on the image, i.e. annotations. % -% From version 0.3 there is a more simpler manner to make annotations: for this the option \smoption{markings} should be enabled. -% -% Look the previous example done in this way (the annotation is put a bit close to the highlighted area intentionally): +% From the version 0.3, it exists simpler manner to add annotations that requires the option \smoption{markings} to be enabled. Under such an hypothesis, the previous example can be done as follows (the annotation has been put a little bit close to the highlighted area intentionally): % \begin{equation*} % \left.\begin{array}{cc} % -2\cdot \tikzmarkin[mark at=0.93]{col 1}(0.05,-0.2)(-0.05,0.4)2=& -4 \\ @@ -343,7 +341,7 @@ and the derived files hf-tikz.ins and % \end{tikzpicture} % \end{verbatim} % -% Thus, it is sufficient to \smkey{mark at} a given position the rectangle delimiting the highlighted area and then access this coordinate by means of \smkey{use marker id}. Further details are provided in subsection \ref{subsec:markings}. +% Thus, it is sufficient to mark the box delimiting the highlighted area with the option \smkey{mark at}. Then, it is possible to access this coordinate by means of \smkey{use marker id}. Further details are provided in subsection \ref{subsec:markings}. % % \section{The options} % \subsection{The \texttt{beamer} mode}\label{subsec:beamer} @@ -352,7 +350,7 @@ and the derived files hf-tikz.ins and % \begin{verbatim} % \usepackage[beamer]{hf-tikz} % \end{verbatim} -% let the package to enter in \texttt{beamer} mode and the \cs{tikzmarkin} macro is \emph{overlay-aware}, that is overlay specifications could be introduced as first argument. For example: +% let the package to enter in \texttt{beamer} mode and the \cs{tikzmarkin} macro becomes \emph{overlay-aware}. As a resutl, overlay specifications can be introduced as first argument. For example: % \begin{verbatim} % \begin{align} % \tikzmarkin<1->{a1}a_i\tikzmarkend{a1} + b_j = 10 \\ @@ -361,7 +359,7 @@ and the derived files hf-tikz.ins and % >= 30\tikzmarkend{c} % \end{align} % \end{verbatim} -% Examples in which the overlay specifications could be introduced are: +% Here it follows a list of examples in which overlay-specifications can be defined: % \begin{itemize} % \item a single number: \texttt{<1>}; % \item multiple numbers separated by commas and delimited by braces: \texttt{<\{1,2,3\}>}; @@ -370,12 +368,12 @@ and the derived files hf-tikz.ins and % % \subsection{Customize colors}\label{subsec:customcolors} % \DescribeMacro{customcolors}^^A -% This option allows you to customize both the fill and the border color. When using this option, two commands become available: +% This option allows to customize both the fill and the border color. While using this option, two commands become available: % \begin{itemize} % \item \cs{hfsetfillcolor} % \item \cs{hfsetbordercolor} % \end{itemize} -% They can be use in whatever part of the document allowing an high color customization. For example: +% These commands can be used at any time in the document. For example: % \begin{verbatim} % \hfsetfillcolor{red!10} % \hfsetbordercolor{red} @@ -400,7 +398,7 @@ and the derived files hf-tikz.ins and % \hfsetbordercolor{blue} % \[\tikzmarkin{z1}x+y=400\tikzmarkend{z1}\] % -% From version 0.3 it is also possible to customize the fill and the border color by means of the keys: +% From the version 0.3, it is also possible to customize the fill and the border color by means of the following keys: % \begin{itemize} % \item \packoption{set fill color}{fancybrown}: this key sets the fill color; % \item \packoption{set border color}{fancyviolet}: this key sets the border color. @@ -409,7 +407,8 @@ and the derived files hf-tikz.ins and % An example: % \begin{verbatim} % \[ -% \tikzmarkin[set fill color=green!50!lime!30,set border color=green!40!black]{z-a}(0.2,-0.4)(-0.2,0.6) +% \tikzmarkin[set fill color=green!50!lime!30, +% set border color=green!40!black]{z-a}(0.2,-0.4)(-0.2,0.6) % \dfrac{100}{x} % \tikzmarkend{z-a} % \] @@ -419,16 +418,17 @@ and the derived files hf-tikz.ins and % % Notice that: % \begin{itemize} -% \item the definition of colors could be also done via \cs{tikzset} and the application is global +% \item the color definition can also be done via \cs{tikzset}; in this case its application is global in the document % \begin{verbatim} % \tikzset{set fill color=orange!30,set border color=orange} % \end{verbatim} -% \item global definitions, done via \cs{tikzset} or \cs{hfsetfillcolor} and \cs{hfsetbordercolor} are always overridden by local ones; that is: +% \item global definitions defined via \cs{tikzset} or \cs{hfsetfillcolor} and \cs{hfsetbordercolor} can always be overridden by local ones; that is: % \end{itemize} % \begin{verbatim} % \tikzset{set fill color=orange!30,set border color=orange} % \[ -% \tikzmarkin[set fill color=green!50!lime!30,set border color=green!40!black]{label}(0.2,-0.4)(-0.2,0.6) +% \tikzmarkin[set fill color=green!50!lime!30, +% set border color=green!40!black]{label}(0.2,-0.4)(-0.2,0.6) % \dfrac{100}{x} % \tikzmarkend{z-a} % \] @@ -445,7 +445,7 @@ and the derived files hf-tikz.ins and % \DescribeMacro{shade}^^A % \hfsetfillcolor{blue!10} % \hfsetbordercolor{blue} -% The option \smoption{shade} activates the possibility of introducing shaded backgrounds besides the fill color currently set. Available shadings are: +% The option \smoption{shade} activates the possibility of introducing shaded backgrounds besides any fill color definition currently set up. Available shadings are: % \begin{itemize} % \item vertical shading; % \item horizontal shading; @@ -488,15 +488,15 @@ and the derived files hf-tikz.ins and % Result: % \[\tikzmarkin[outer color=white, inner color=blue!20]{rshade}x+y=400\tikzmarkend{rshade}\] % -% \subsection{Avoid the background color} +% \subsection{Avoiding the background color} % \DescribeMacro{nofill}^^A -% Using the \smoption{nofill} option allows to simply not introduce the background color. -% When the option is active, you can not change this behaviour inside the document. Another option to remove the background color, is to set the fill color by means of \cs{hfsetfillcolor} with the same color of the page. +% Using the \smoption{nofill} option allows very simply to not introduce the background color. +% When the option is active, you can not change this behaviour inside the document. Another way to remove the background color, is to set the fill color by means of \cs{hfsetfillcolor} to be of the same color of the page. % \subsection{Disable rounded corners} % \DescribeMacro{norndcorners}^^A -% To disable the rounded corners, there are actually two ways. The first one, which is general, is the option \smoption{norndcorners}: as the other options it should be provided when loading the package. +% To disable the rounded corners, it exists two ways actually. The first one, which is a global approach, is the option \smoption{norndcorners}: as any of the other package options, it should be provided during the package load. % -% There is also a second way, which actually disables the rounded corners locally; you should proceed using the \smkey{disable rounded corners} key set to \verb|true|. +% It exists a second way that disables the rounded corners only locally; this approach needs the \smkey{disable rounded corners} key to be set to \verb|true|. % % For example: % \begin{verbatim} @@ -511,7 +511,7 @@ and the derived files hf-tikz.ins and % % \subsection{The \texttt{markings} option}\label{subsec:markings} % \DescribeMacro{markings}^^A -% Loading the package with the \smoption{markings} option allows to mark some positions on the rectangle delimiting the highlighted area. This is done by setting the key \smkey{mark at}\verb|=<pos>| where \verb|<pos>=[0,1]|; the position could be later on access with \smkey{use marker id}\verb|=<id-num>| where \verb|<id-num>| is the progressive identifier of the positions previously marked. +% Loading the package with the \smoption{markings} option allows to mark positions on the box delimiting the highlighted area. This can be achieved by setting the key \smkey{mark at}\verb|=<pos>| where \verb|<pos>=[0,1]|; the positions can be later accessed with the key \smkey{use marker id}\verb|=<id-num>| where \verb|<id-num>| is the progressive identifier of the positions previously marked. % % For example: % \tikzset{set fill color=orange!30,set border color=orange} @@ -519,7 +519,9 @@ and the derived files hf-tikz.ins and % \tikzmarkin[show markers,mark at=0,]{marker 1} % x+y=400 % \tikzmarkend{marker 1} -% \tikz[remember picture,overlay]\draw[use marker id,blue,xscale=-1](0,0)arc(270:90:1.5mm); +% \tikz[remember picture,overlay]{ +% \draw[use marker id,blue,xscale=-1](0,0)arc(270:90:1.5mm); +% } % \] % is realized by means of: % \begin{verbatim} @@ -528,7 +530,9 @@ and the derived files hf-tikz.ins and % \tikzmarkin[show markers,mark at=0,]{marker 1} % x+y=400 % \tikzmarkend{marker 1} -% \tikz[remember picture,overlay]\draw[use marker id,blue,xscale=-1](0,0)arc(270:90:1.5mm); +% \tikz[remember picture,overlay]{ +% \draw[use marker id,blue,xscale=-1](0,0)arc(270:90:1.5mm); +% } % \] % \end{verbatim} % @@ -540,24 +544,72 @@ and the derived files hf-tikz.ins and % \tikz[remember picture,overlay]\draw[use marker id=1,blue,xscale=-1](0,0)arc(270:90:1.5mm); % \tikz[remember picture,overlay]\draw[use marker id=2,blue](0,0)arc(270:90:1.5mm); % \] -% by referring them in order as they have been marked: +% by referring them in the same order in which they have been marked: % \begin{verbatim} % \[ % \tikzmarkin[show markers,mark at=0,mark at=0.55]{marker 2} % x+y=400 % \tikzmarkend{marker 2} -% \tikz[remember picture,overlay]\draw[use marker id=1,blue,xscale=-1](0,0)arc(270:90:1.5mm); -% \tikz[remember picture,overlay]\draw[use marker id=2,blue](0,0)arc(270:90:1.5mm); +% \tikz[remember picture,overlay]{ +% \draw[use marker id=1,blue,xscale=-1](0,0)arc(270:90:1.5mm); +% } +% \tikz[remember picture,overlay]{ +% \draw[use marker id=2,blue](0,0)arc(270:90:1.5mm); +% } % \] % \end{verbatim} % -% The markers are visible when the \smkey{show markers} key is present, but for annotations it is preferable to not show them (by defaul they are not); moreover, markes can be customized: +% The markers can become visible when the \smkey{show markers} key is activated. By default, they are invisible, but during the working process it may be useful to know their location. In addition, the markers can be customized: % \begin{itemize} % \item \packoption{marker size}{1pt}: this key sets the radius of the marker; % \item \packoption{marker color}{blue}: this key sets the color of the marker. % \end{itemize} % -% The option necessitates of the \library{decorations.markings} from Ti\textit{k}Z: this library, however, is not loaded always, but just in case the \smoption{markings} option is active. +% The options necessitates of the \library{decorations.markings} of Ti\textit{k}Z: this library, however, is not always loaded, but just in case the \hftikz\ \smoption{markings} option is active. +% +% \section{Efficient use of Ti\textit{k}Z styles} +% Ti\textit{k}Z are very powerful and their use is recommended also with \hftikz. For example, an intelligent way to proceed if two different highlighting colors have to be used is as follows: +%\begin{verbatim} +%\tikzset{offset definition/.style={ +% above left offset={-0.1,0.6}, +% below right offset={0.1,-0.45}, +% }, +% h1/.style={ +% offset definition, +% set fill color=green!50!lime!60, +% set border color=green!40!black, +% }, +% h2/.style={ +% offset definition, +% set fill color=blue!20!cyan!60, +% set border color=blue!60!cyan, +% } +%} +%\end{verbatim} +%\tikzset{offset definition/.style={ +% above left offset={-0.1,0.6}, +% below right offset={0.1,-0.45}, +% }, +% h1/.style={ +% offset definition, +% set fill color=green!50!lime!60, +% set border color=green!40!black, +% }, +% h2/.style={ +% offset definition, +% set fill color=blue!20!cyan!60, +% set border color=blue!60!cyan, +% } +%} +% Their use in the document is: +% \begin{verbatim} +% \[\tikzmarkin[h1]{st-a}x + \dfrac{y}{z} = 400\tikzmarkend{st-a}\] +% \[\tikzmarkin[h2]{st-b}x + \dfrac{y}{z} = 400\tikzmarkend{st-b}\] +% \end{verbatim} +% which gives as result: +% \[\tikzmarkin[h1]{st-a}x + \dfrac{y}{z} = 400\tikzmarkend{st-a}\] +% and +% \[\tikzmarkin[h2]{st-b}x + \dfrac{y}{z} = 400\tikzmarkend{st-b}\] % % \StopEventually{\PrintChanges} % @@ -574,8 +626,8 @@ and the derived files hf-tikz.ins and \RequirePackage{etoolbox} % \end{macrocode} % -% This warning is arised at first compilation run, to inform that a second run is necessary to get the final result. The code -% used as base is taken from \href{http://tex.stackexchange.com/a/82072/13304}{this answer in TeX.SX}. +% This warning is arised after the first compilation run to inform that a second run is necessary for the final result. The code +% has been inspired by \href{http://tex.stackexchange.com/a/82072/13304}{this answer on TeX.SX}. % % \begin{macrocode} \AtEndDocument{% @@ -593,7 +645,7 @@ and the derived files hf-tikz.ins and % \end{macrocode} % % \subsection{Options definition} -% In this subsection the definitions of pre-defined colors and options are shown. +% This subsection is devoted to define options and default colors. % % \begin{macrocode} %% Colors @@ -639,7 +691,7 @@ and the derived files hf-tikz.ins and \ProcessOptions % \end{macrocode} % -% The keys definition to locally disable rounded corners. +% It follows the definition of the keys devoted to disable the rounded corners. % % \begin{macrocode} \pgfkeys{/tikz/.cd,% @@ -656,7 +708,7 @@ and the derived files hf-tikz.ins and % \end{macrocode} % -% The keys definition of the offsets: the initial values change according to the presence of \smoption{fill} option to compatibility reasons. +% Offsets keys' definition: for compatibility reasons, the initial values change according to the presence of the \smoption{fill} option. % % \begin{macrocode} @@ -695,7 +747,7 @@ and the derived files hf-tikz.ins and }% % \end{macrocode} % -% The keys and style definition of the markings: they are active when the \smoption{markings} option is present. This is a feature request from Bodo Manthey and the implementation is taken from Jake's \href{http://tex.stackexchange.com/a/25940/13304}{answer in TeX.SX}: thanks to both. +% Keys and style definition of the markings: they are activated when the \smoption{markings} option is present. This is a feature request from Bodo Manthey and the implementation has been inspired by Jake's \href{http://tex.stackexchange.com/a/25940/13304}{answer on TeX.SX}: thanks to both. % % \begin{macrocode} \ifbool{markings}{ @@ -743,7 +795,7 @@ and the derived files hf-tikz.ins and } % \end{macrocode} % \subsection{General settings} -% In this subsection the general settings that allow the highlighing are shown. +% This subsection is devoted to illustrate the code used for defining the settings used by the highlighting commands. % \begin{macrocode} %% Settings @@ -866,7 +918,7 @@ and the derived files hf-tikz.ins and } % \end{macrocode} % \subsection{The highlighting commands} -% In this subsection the definition of the highlighing commands in \texttt{beamer} mode and not are shown. Thanks to \textsf{etoolbox} it is possible to perform a check on the options active, then the commands are consequently declared. +% In this subsection the definitions of the highlighing commands are shown when the \texttt{beamer} mode is active and when it is not. Thanks to \textsf{etoolbox} it is possible to perform a check on the active options. Then the commands are declared. % \begin{macrocode} \ifbool{norndcorners}{%true-norndcorners \ifbool{beamer}{%true-beamer diff --git a/Master/texmf-dist/source/latex/hf-tikz/hf-tikz.ins b/Master/texmf-dist/source/latex/hf-tikz/hf-tikz.ins index f182be38a04..0d60ee6aa47 100644 --- a/Master/texmf-dist/source/latex/hf-tikz/hf-tikz.ins +++ b/Master/texmf-dist/source/latex/hf-tikz/hf-tikz.ins @@ -30,7 +30,7 @@ \endpreamble \postamble -Copyright (C) 2012 by Claudio Fiandrino <claudio.fiandrino@gmail.com> +Copyright (C) 2012-2014 by Claudio Fiandrino <claudio.fiandrino@gmail.com> This work may be distributed and/or modified under the conditions of the LaTeX Project Public License (LPPL), either @@ -56,7 +56,7 @@ and the derived files hf-tikz.ins and %% -%% Copyright (C) 2012 by Claudio Fiandrino <claudio.fiandrino@gmail.com> +%% Copyright (C) 2012-2014 by Claudio Fiandrino <claudio.fiandrino@gmail.com> %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License (LPPL), either diff --git a/Master/texmf-dist/tex/latex/hf-tikz/hf-tikz.sty b/Master/texmf-dist/tex/latex/hf-tikz/hf-tikz.sty index 53e81c3b007..64d27193556 100644 --- a/Master/texmf-dist/tex/latex/hf-tikz/hf-tikz.sty +++ b/Master/texmf-dist/tex/latex/hf-tikz/hf-tikz.sty @@ -15,7 +15,7 @@ %% * See http://www.latex-project.org/lppl.txt %% * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * \NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{hf-tikz}[2013/01/13 v0.3 A simple way to highlight formulas and formula parts.] +\ProvidesPackage{hf-tikz}[2014/07/25 v0.3a A simple way to highlight formulas and formula parts.] @@ -457,7 +457,7 @@ \newcommand\tikzmarkend[2][]{% \tikz[remember picture with id=#2] #1;} %% -%% Copyright (C) 2012 by Claudio Fiandrino <claudio.fiandrino@gmail.com> +%% Copyright (C) 2012-2014 by Claudio Fiandrino <claudio.fiandrino@gmail.com> %% %% This work may be distributed and/or modified under the %% conditions of the LaTeX Project Public License (LPPL), either |