diff options
Diffstat (limited to 'graphics/pgf/contrib/tikz-ext/doc')
17 files changed, 1007 insertions, 210 deletions
diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-calendar.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-calendar.tex new file mode 100644 index 0000000000..88a3567c1a --- /dev/null +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-calendar.tex @@ -0,0 +1,80 @@ +% !TeX spellcheck = en_US +% !TeX root = tikz-ext-manual.tex +% Copyright 2022 by Qrrbrbirlbel +% +% This file may be distributed and/or modified +% +% 1. under the LaTeX Project Public License and/or +% 2. under the GNU Free Documentation License. +% + +\section{Calendar: Weeknumbers and more conditionals} +\begin{package}{calendar-ext} + This package adds week numbers and more conditionals to the PGF package |pgfcalendar|. + (Despite the code example above, this package is not set up to work with Con\TeX t.) +\end{package} + +%This package extends the |pgfcalendar| package. + +\begin{multicols}{2} + +\subsection{Extensions} + +The following tests are added. +\begin{itemize} +\itemcalendaroption{Jan} This test is passed by all dates that are in the month of January. +\itemcalendaroption{Feb} as above. +\itemcalendaroption{Mar} as above. +\itemcalendaroption{Apr} as above. +\itemcalendaroption{May} as above. +\itemcalendaroption{Jun} as above. +\itemcalendaroption{Jul} as above. +\itemcalendaroption{Aug} as above. +\itemcalendaroption{Sep} as above. +\itemcalendaroption{Oct} as above. +\itemcalendaroption{Nov} as above. +\itemcalendaroption{Dec} as above. +\itemcalendaroption{leap year}\opt{|=|\meta{year}} + This test checks whether the given year is a leap year. If + \meta{year} is omitted, it checks the year of the current date. +\itemcalendaroption{and}|=|\marg{tests} + This test passes when all \meta{tests} pass. +\itemcalendaroption{not}|=|\marg{tests} + This test passes when \meta{tests} do not pass. +\itemcalendaroption{yesterday}|=|\marg{tests} + This test passes when the previous day passes \meta{tests}. +\itemcalendaroption{week}|=|\meta{num} + This test passes when the current week of the year equals \marg{num}. +\end{itemize} + +The shorthands for |d-| and |m-| are slightly changed so that they are +expandable. This makes it possible to use these shorthands inside of PGFmath. +The shorthands for the week (see section~\ref{calendar:weeknumbering}) +are added. These are +\begin{itemize} +\item |n-| (shortest numerical representation), +\item |n=| (shortest but added horizontal space) and +\item |n0| (leading zero when below 10). +\end{itemize} + +\subsection{Week numbering (ISO~8601)} +\label{calendar:weeknumbering} +\begin{command}{\pgfcalendarjulianyeartoweek\marg{Julian day}\marg{year}\marg{week counter}} + This command calculates the week for the \meta{Julian day} of \meta{year}. + The \meta{week counter} must be a \TeX\space counter. + + The calculation follows the rule of ISO~8601 where the first week has that + year's first Thursday in it. +\end{command} + +Inside of |\pgfcalendar|\indexCommandO\pgfcalendar the command |\pgfcalendarcurrentweek| will be available. +\begin{command}{\pgfcalendarcurrentweek} + This command returns the current week number (always two digits -- use shorthand |n.| + to strip the leading zero). +\end{command} + +Inside of |\ifdate|\indexCommandO\ifdate the command |\pgfcalendarifdateweek| will be available. +\begin{command}{\pgfcalendarifdateweek} + This command returns the week number (always two digits). +\end{command} +\end{multicols}
\ No newline at end of file diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-intro.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-intro.tex index 5c90d0f5bf..ac5811ac6e 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-intro.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-intro.tex @@ -1,3 +1,12 @@ +% !TeX spellcheck = en_US +% !TeX root = tikz-ext-manual.tex +% Copyright 2022 by Qrrbrbirlbel +% +% This file may be distributed and/or modified +% +% 1. under the LaTeX Project Public License and/or +% 2. under the GNU Free Documentation License. +% \part{Introduction} \begin{multicols}{2} \section{Usage} diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex new file mode 100644 index 0000000000..14c78e9be0 --- /dev/null +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-calendar-plus.tex @@ -0,0 +1,69 @@ +% !TeX spellcheck = en_US +% !TeX root = tikz-ext-manual.tex +% Copyright 2022 by Qrrbrbirlbel +% +% This file may be distributed and/or modified +% +% 1. under the LaTeX Project Public License and/or +% 2. under the GNU Free Documentation License. +% + +\section{Calendar} +\begin{tikzlibrary}{ext.calendar-plus} + This library extends the \tikzname\space library |calendar|\indexLibraryO{calendar}. +\end{tikzlibrary} + +\begin{multicols}{2} + +\subsection{Value-keys and nestable \texttt{if} key} + +The values of following keys are originally stored in some macros that are not +accessible by the user. These are now simple value-keys. +The |@|-protected macros are still available, of course. + +\begin{key}{/tikz/day xshift (initially 3ex)} +\end{key} +\begin{key}{/tikz/day yshift (initially 3.5ex)} +\end{key} +\begin{key}{/tikz/month xshift (initially 9ex)} +\end{key} +\begin{key}{/tikz/month yshift (initially 9ex)} +\end{key} + +It is now also possible to nest |/tikz/if| occurrences. +\begin{key}{/tikz/if=|(|\meta{conditions}|)|\meta{code or options}\opt{|else|\meta{else code or options}}} +\end{key} + +\subsection{Week numbering (ISO~8601)} + +The actual week number algorithm is implemented by the |pgfcalendar-ext| package/module in section~\ref{calendar:weeknumbering}. +\begin{key}{/tikz/week code=\meta{code}} + Works like |/tikz/day code| or |/tikz/month code|, only for weeks.\indexKeyO{day code}\indexKeyO{month code} +\end{key} + +\begin{key}{/tikz/week text=\meta{text}} + Works like |/tikz/day text| or |/tikz/month text|, only for weeks.\indexKeyO{day text}\indexKeyO{month text} +\end{key} + +\begin{stylekey}{/tikz/every week} + Works like |/tikz/every day| or |/tikz/every month|, only for weeks.\indexKeyO{every day}\indexKeyO{every month} +\end{stylekey} + +\begin{stylekey}{/tikz/week label left} + Places the week label to the left of the first day of the month. (For + |week list| and |month list| where a week does not start on a Monday, the + position is chosen ``as if'' the week had started on a Monday -- which is + usually exactly what you want.) + % +\begin{codeexample}[preamble={\usetikzlibrary{ext.calendar-plus}}] +\tikz + \calendar [week list, month label above centered, + dates=2022-07-01 to 2022-07-31, + week label left, + every week/.append style={gray!50!black,font=\sffamily}]; +\end{codeexample} + % +\end{stylekey} + +\end{multicols} +\endinput
\ No newline at end of file diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-misc.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-misc.tex index dc9103b699..79cc9c21c3 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-misc.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-misc.tex @@ -8,13 +8,16 @@ % 2. under the GNU Free Documentation License. % -\begin{tikzlibrary}{misc} - This library adds miscelleaneos utilities to PGFmath, PGF or \tikzname. +\section{And a little bit more} +\begin{tikzlibrary}{ext.misc} + This library adds miscellaneous utilities to PGFmath, PGF or \tikzname. \end{tikzlibrary} -\section{PGFmath} +\subsection{PGFmath} -\subsection{Postfix operator \texttt{R}} +\begin{multicols}{2} +\pgfkeys{/codeexample/every codeexample/.append style={width=3cm}} +\subsubsection{Postfix operator \texttt{R}} Similar to |\segments[<num>]| in PSTricks, the postfix operator |R| allows the user to use an arbitrary number of segments of a circle to be used instead of an angle. @@ -31,14 +34,15 @@ The |R| operator can then be used. Multiplies \mvar{x} with $\frac{360}{\meta{num}}$. \end{math-operator} -\subsection{Functions} +\subsubsection{Functions} \begin{math-function}{strrepeat("\mvar{Text}", \mvar{x})} \mathcommand Returns a string with \mvar{Text} repeated \mvar{x} times. \begin{codeexample}[] -\pgfmathparse{strrepeat("foo", 5)} \pgfmathresult +\pgfmathparse{strrepeat("foo", 5)} +\pgfmathresult \end{codeexample} \end{math-function} @@ -48,9 +52,10 @@ The |R| operator can then be used. otherwise |0| (false). \begin{codeexample}[] -\pgfmathparse{isInString("foo", "bar")} \pgfmathresult -\ and\ -\pgfmathparse{isInString("foo", "foobar")} \pgfmathresult +\pgfmathparse{isInString("foo", "bar")} +\pgfmathresult \ and\ +\pgfmathparse{isInString("foo", "foobar")} +\pgfmathresult \end{codeexample} \end{math-function} @@ -59,7 +64,8 @@ The |R| operator can then be used. Returns the concatenation of all given parameters. \begin{codeexample}[] -\pgfmathparse{strcat("blue!", int(7*3), "!green")} \pgfmathresult +\pgfmathparse{strcat("blue!", int(7*3), "!green")} +\pgfmathresult \end{codeexample} \end{math-function} @@ -79,10 +85,8 @@ The |R| operator can then be used. \begin{math-function}{atanXY(\mvar{x},\mvar{y})} \mathcommand Arctangent of $\mvar y\div \mvar x$ in degrees. This also takes into account the quadrant. - This is just a argument-swapped version of |atan2| which makes it easier to use - the |\p| commands of the |calc| library. - \index{atan2@\protect\texttt{atan2} math function}% - \index{Math functions!atan2@\protect\texttt{atan2}}% + This is just a argument-swapped version of |atan2|\indexMathFunctionO{atan2} which makes it easier to use + the |\p| commands of the |calc|\indexLibraryO{calc} library. % \begin{codeexample}[] \pgfmathparse{atanXY(3,4)} \pgfmathresult @@ -96,7 +100,7 @@ The |R| operator can then be used. \end{codeexample} \end{math-function} -\subsection{Functions: using coordinates} +\subsubsection{Functions: using coordinates} The following functions can only be used with PGF and/or \tikzname. Since the arguments are usually plain text (and not numbers) one has to wrap them in |"|. @@ -112,7 +116,10 @@ them in |"|. \begin{math-function}{qdistancebetween("\mvar{p}")}\mathcommand Return the distance (in pt) between the origin and the center of the node \mvar{p}. \end{math-function} -\begin{codeexample}[width=6cm,preamble=\usetikzlibrary{calc,misc,through}] + +\end{multicols} + +\begin{codeexample}[width=6cm,preamble=\usetikzlibrary{calc,ext.misc,through}] \begin{tikzpicture} \path (0,0) coordinate (A) + (0:4) coordinate (B) +(75:4) coordinate (C); \draw (A) -- (B) -- (C) -- cycle; @@ -128,9 +135,11 @@ them in |"|. (intersection of @--[shift=(vecB)]@ and B--A) coordinate (A);} \end{tikzpicture} \end{codeexample} -\section{PGFkeys} +\subsection{PGFkeys} + +\begin{multicols}{2} -\subsection{Conditionals} +\subsubsection{Conditionals} \begin{key}{/utils/if=\meta{cond}\meta{true}\opt{\meta{false}}} This key checks the conditional \meta{cond} and applies the styles \meta{true} @@ -175,7 +184,7 @@ executions. \end{key} -\subsection{Handlers} +\subsubsection{Handlers} While already a lot of values given to keys are evaluated by PGFmath at some point, not all of them are. @@ -192,17 +201,22 @@ not all of them are. As above but uses the |strcat| function. In the example below, one could have used the |/pgf/foreach/evaluate| key from |\foreach|. -\begin{codeexample}[width=6cm,preamble=\usetikzlibrary{misc}] +\begin{codeexample}[width=3.7cm,preamble=\usetikzlibrary{misc}] \tikz\foreach \i in {0,10,...,100} - \draw[line width=+.2cm, color/.pgfmath strcat={"red!",sqrt(\i)*10,"!blue"}] - (0,\i/50) -- +(right:3); +\draw[ + line width=+.2cm, + color/.pgfmath strcat={"red!",sqrt(\i)*10,"!blue"} +] + (0,\i/50) -- +(right:3); \end{codeexample} \end{handler} \begin{handler}{{.List}|=|\meta{\meta{e1}, \meta{e2}, \dots, \meta{en}}} This handler evaluates the given list with |\foreach| and concatenates the element and the result is then given to the used key. -\begin{codeexample}[width=6cm,preamble=\usetikzlibrary{fit,misc}] +\end{handler} +\end{multicols} +\begin{codeexample}[width=6cm,preamble=\usetikzlibrary{fit,ext.misc}] \begin{tikzpicture}[nodes={draw, dashed, inner sep=+10pt}] \foreach \point [count=\cnt] in {(0,0), (0,2), (2,0), (2,2), (3,3), (-1,-1)} \fill \point circle[radius=.1] coordinate (point-\cnt); @@ -211,45 +225,8 @@ not all of them are. \node[blue, fit/.List={(point-1),(point-...),(point-6)}] {}; \end{tikzpicture} \end{codeexample} -\end{handler} -\begin{center} -\begin{codeexample}[width=10cm,preamble=\usetikzlibrary{graphs,graphdrawing} \usegdlibrary{force}] -\tikzset{ - mynode/.style={ - circle, minimum size=10mm, draw, densely dashdotted, thick, - decide color/.expand once=#1}, - decide color/.style 2 args={ - /utils/TeX/if=c#1 - {/utils/TeX/ifnum={#2<5}{bluelight}{bluedark}} - {/utils/TeX/ifnum={#2<8}{light}{dark}}}, - light/.style={fill=gray!20}, bluelight/.style={fill=blue!10}, - dark/.style ={fill=gray!60}, bluedark/.style ={fill=blue!30}} -\tikz\graph[ - spring electrical layout, vertical=c2 to p13, - node distance=1.5cm, typeset=$n_{\tikzgraphnodetext}$, - nodes={mynode=\tikzgraphnodetext}] { - % outer ring - c2 -- {p1, p11, p6}; - p1 -- {p8, c6, p11}; - p8 -- {p3, p10, c6}; - p3 -- {p13, p15, p10}; - p13 -- {p15, c7}; - c7 -- {c3, c4, p15}; - c3 -- {p14, c4}; - p14 -- {p7, c4}; - p7 -- {p9, p2, c4}; - p9 -- {c5, p12, p2}; - c5 -- {c1, p4, p12}; - c1 -- {p6, p4}; - p6 -- {p11, p4}; - % inner ring - p11 -- {c6, p12, p4}; - p5 -- {c6 -- {p10, p12}, p10 -- p15, p15 -- c4, c4 -- p2, p2 -- p12, p12 -- p4}; -}; -\end{codeexample} -\end{center} -\section{PGFfor} +\subsection{PGFfor} Instead of |\foreach \var in {start, start + delta, ..., end}| one can use |\foreach \var[use int=start to end step delta]|. @@ -259,7 +236,7 @@ The values \meta{start}, \meta{end} and \meta{delta} are evaluates by PGFmath at The part |step |\meta{delta} is optional (\meta{delta} = 1). \end{key} -\begin{key}{/pgf/foreach/use float=\meta{start}| o|\meta{end}opt{|step|\meta{delta}}} +\begin{key}{/pgf/foreach/use float=\meta{start}|to|\meta{end}\opt{|step|\meta{delta}}} Same as above, however the results are not truncated. \end{key} diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-node-families.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-node-families.tex new file mode 100644 index 0000000000..04ebb7c7a0 --- /dev/null +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-node-families.tex @@ -0,0 +1,102 @@ +% !TeX spellcheck = en_US +% !TeX root = tikz-ext-manual.tex +% Copyright 2022 by Qrrbrbirlbel +% +% This file may be distributed and/or modified +% +% 1. under the LaTeX Project Public License and/or +% 2. under the GNU Free Documentation License. +% +\section{Node Families} +\begin{tikzlibrary}{ext.node-families} + With this library the user can instruct multiple nodes to have the same + width, height, text width, text height or text width. + This uses the hook \referenceKeyandIndexO{execute at end picture} to write the nodes' + measurements to the \filetype{aux} file. + + Unfortunately, this does not work with the |external| library.\indexLibraryO{external}% + \footnote{Not only would the \texttt{external} library not notice the change of the value between compilations runs, + it also changes the way \texttt{\textbackslash pgfutil@writeout} works which suddenly writes to the \textsc{log} file instead.} +\end{tikzlibrary} + +This library introduces two new shapes called |Circle| and |Rectangle| +that are basically copies of the original shapes |circle|\indexShapeO{circle} and |rectangle|\indexShapeO{rectangle}. +However, their dimension will be set to the same maximum |minimum width| and |minimum height| +when one of the following \meta{name}s are declared. +\begin{key}{/tikz/node family/width=\meta{name} (initially |\{\}|)} +Nodes with the same \meta{name} will have the same \referenceKeyandIndexO[/pgf/]{minimum width}. +An empty \meta{name} disables the evaluation by the library. +\begin{codeexample}[preamble=\usetikzlibrary{positioning,ext.node-families},/tikz/node distance=.5cm] +\tikzexternaldisable % ext.node-families does not work with active externalization +\begin{tikzpicture}[nodes={Rectangle, draw, node family/width=manual}] +\node (a) {Foo}; +\node[below=of a] (b) {Foobar}; +\end{tikzpicture} +\end{codeexample} +\end{key} +\begin{key}{/tikz/node family/height=\meta{name} (initially |\{\}|)} +Nodes with the same \meta{name} will have the same \referenceKeyandIndexO[/pgf/]{minimum height}. +An empty \meta{name} disables the evaluation by the library. +\end{key} +\begin{key}{/tikz/node family/size=\meta{name}} +Sets both |height| and |width|. +\end{key} + +While |node family/width| and |node family/height| only work for the new shapes |Circle| and |Rectangle|, +the following keys~-- when setup, see below~-- work with every shape with one single node part. +Initially though, only |circle|, |rectangle|, |Circle| and |Rectangle| are set up that way. +\begin{key}{/tikz/node family/text height=\meta{name} (initially |\{\}|)} +Nodes with the same \meta{name} will have the same text height. +An empty \meta{name} disables the evaluation by the library. +\end{key} + +\begin{key}{/tikz/node family/text depth=\meta{name} (initially |\{\}|)} +Nodes with the same \meta{name} will have the same text depth. +An empty \meta{name} disables the evaluation by the library. +\end{key} + +\begin{key}{/tikz/node family/text width=\meta{name} (initially |\{\}|)} +Nodes with the same \meta{name} will have the same text width. +An empty \meta{name} disables the evaluation by the library. +\end{key} + +\begin{key}{/tikz/node family/text=\meta{name}} +Sets |text height|, |text depth| and |text width|. +\end{key} + +Since the width of the node's content's box is setup much earlier, +the previous key only extends the width of that box which would make the text +seem as if it where aligned to the left. +With |text width family align| this can changed. +\begin{key}{/tikz/node family/text width align=\meta{alignment}(initially |center|)} +\meta{alignment} is one of |left|, |center| or |right|. + +\begin{codeexample}[preamble=\usetikzlibrary{positioning,ext.node-families},/tikz/node distance=.5cm] +\tikzexternaldisable % ext.node-families does not work with active externalization +\begin{tikzpicture}[nodes={Rectangle, draw, node family={text width=manual, text width align=right}}] +\node (a) {Foo}; +\node[below=of a] (b) {Foobar}; +\end{tikzpicture} +\end{codeexample} +\end{key} + +\begin{key}{/tikz/node family/prefix=\meta{prefix}(initially \expandafter|\string\pgfpictureid-|)} +The family names are prefixed with the value of |/tikz/node family/prefix|. +\end{key} + +\begin{key}{/tikz/node family/setup shape=\meta{shape}} +This adds instructions to the \meta{shape}'s definition which +adjust the text box's dimensions according to the family. + +This should be only used once per shape. +\end{key} +\begin{codeexample}[width=9cm,preamble=\usetikzlibrary{ext.node-families,shapes.geometric}] +\tikzexternaldisable % ext.node-families does not work with active externalization +\begin{tikzpicture}[node family/setup shape=diamond] +\foreach \cnt[count=\Cnt] in {a,...,h} + \node[draw, diamond, node family/text=aTOh] (\cnt) + at (right:\Cnt) {\cnt}; +\draw[help lines] (a.south) -- (h.south) (a.north) -- (h.north) (a.base-|a.west) -- (h.base-|h.east); +\end{tikzpicture} +\end{codeexample} +\endinput
\ No newline at end of file diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.arcto.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.arcto.tex index f219f34691..8ed660b3a3 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.arcto.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.arcto.tex @@ -11,12 +11,12 @@ \section{Arc \emph{to} a point} \label{library:paths.arcto} -\begin{tikzlibrary}{paths.arcto} - This library adds new path specifications |arc to| that specifies an arc \emph{to} a point~-- +\begin{tikzlibrary}{ext.paths.arcto} + This library adds the new path operation |arc to| that specifies an arc \emph{to} a point~-- without the user having to specify any angles. \end{tikzlibrary} -\begin{codeexample}[width=.5\linewidth,preamble=\usetikzlibrary{paths.arcto}] +\begin{codeexample}[width=.5\linewidth,preamble=\usetikzlibrary{ext.paths.arcto}] \begin{tikzpicture}[ultra thick,dot/.style={label={#1}}] \coordinate[dot=below left:$a$] (a) at (0,0); \coordinate[dot=above right:$b$] (b) at (2,3); @@ -73,26 +73,29 @@ options that can be used inside of \meta{options}. \begin{key}{/tikz/arc to/rotate=\meta{degree}} Rotates the arc by \meta{degree}. - This only takes effect when |x radius| and |y radius| is different. + This is only noticeable when |x radius| and |y radius| are different. \end{key} \begin{key}{/tikz/arc to/x radius=\meta{value}} - This forwards the \meta{value} to |/tikz/x radius|. + This forwards the \meta{value} to \referenceKeyandIndexO{x radius}. + Its \meta{value} is used for the radius of the arc. \end{key} \begin{key}{/tikz/arc to/y radius=\meta{value}} - This forwards the \meta{value} to |/tikz/y radius|. + This forwards the \meta{value} to \referenceKeyandIndexO{y radius}. + Its \meta{value} is used for the radius of the arc. \end{key} \begin{key}{/tikz/arc to/radius=\meta{value}} This forwards the \meta{value} to both |/tikz/x radius| and |/tikz/y radius|. + Its \meta{value} is used for radius of the arc. \end{key} \begin{stylekey}{/tikz/every arc to} After |/tikz/every arc| this will also be applied before any \meta{options} are set. \end{stylekey} -It should be noted that this uses |\pgfpatharcto| where the \tikzname\space manual warns of: +It should be noted that this uses |\pgfpatharcto| for which the \tikzname\space manual warns:\indexCommandO\pgfpatharcto \begin{quote}\itshape The internal computations necessary for this command are numerically very unstable. In particular, the arc will not always really end at the \meta{target coordinate}, diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.ortho.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.ortho.tex index 32adea7af0..a46f6be023 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.ortho.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.ortho.tex @@ -11,13 +11,13 @@ \section{More Horizontal and Vertical Lines} \label{library:paths.ortho} -\begin{tikzlibrary}{paths.ortho} +\begin{tikzlibrary}{ext.paths.ortho} This library adds new path specifications \verb!|-|!, \verb!-|-! as well as |r-ud|, |r-du|, |r-lr| and |r-rl|. \end{tikzlibrary} \subsection{Zig-Zag} -Similar to the path operations \verb!|-! and \verb!-|! this library adds +Similar to the path operations \verb!|-! and \verb!-|! this library adds\indexPathOperationO{\protect\pgfmanualbar-}\indexPathOperationO{-\protect\pgfmanualbar} the path operations \verb!|-|! and \verb!-|-!. {\catcode`\|=12 \begin{pathoperation}[noindex]{|-|}{\opt{\oarg{options}}\meta{coordinate or cycle}} @@ -38,33 +38,33 @@ the path operations \verb!|-|! and \verb!-|-!. For values $\meta{ratio} < 0$ and $\meta{ratio} > 1$ the Zig-Zag lines will look more like Zig-Zig lines. - \begin{codeexample}[preamble=\usetikzlibrary{paths.ortho}] -\begin{tikzpicture}[very thick] +\begin{codeexample}[preamble=\usetikzlibrary{paths.ortho}] +\begin{tikzpicture}[very thick, rounded corners] \draw[help lines] (-.25, -1.25) grid (2.25, 1.25); \draw (0, 0) -|- (2, 1) -- (2, 0) -|-[ratio=.25] (0,-1) -- cycle; \end{tikzpicture} - \end{codeexample} +\end{codeexample} \end{key} -%TODO: hvvh/distance needs fixing. +%TODO: hvvh/distance needs fixing, maybe? \begin{key}{/tikz/hvvh/distance=\meta{distance}} This sets the distance between the start point and the middle part of the Zig-Zag connection. For values $\meta{distance} < 0$ the distance will be used for the target coordinate. -\begin{codeexample}[width=8cm,preamble=\usetikzlibrary{paths.ortho}] +\begin{codeexample}[width=8cm,preamble=\usetikzlibrary{ext.paths.ortho}] \begin{tikzpicture}[very thick,-latex] \draw[help lines,-] (-.25, -.25) grid (5.25, 3.25); -\draw (0, 0) -|-[distance= .5cm] ++(2, 1); -\draw (0, 1.5) -|-[distance=-.5cm] ++(2, 1); +\draw (0, 0) -|-[distance= .5cm] ++(2, 1); +\draw (0, 2) -|-[distance=-.5cm] ++(2, 1); \tikzset{xshift=3cm} -\draw (2, 1) -|-[distance= .5cm] ++(-2, -1); -\draw (2, 2.5) -|-[distance=-.5cm] ++(-2, -1); +\draw (2, 1) -|-[distance= .5cm] ++(-2, -1); +\draw (2, 3) -|-[distance=-.5cm] ++(-2, -1); \end{tikzpicture} \end{codeexample} \end{key} -\begin{key}{/tikz/hvvh/from center=\opt{\meta{true or false}} (initially false, default true)} +\begin{key}{/tikz/hvvh/from center=\opt{\meta{true or false}} (default true)} When nodes get connected the placement of the middle part of the Zig-Zag and the Zig-Zig (see below) connections will be calculated from the border of these nodes. @@ -82,7 +82,7 @@ these can be configured through the following keys. \begin{key}{/tikz/hvvh/spacing=\meta{number} (initially 4)} Unless $\meta{number} = 0$ is set \begin{itemize} - \item |pos = 0| will be at the start, + \item |pos = 0| will be at the start,\indexKeyO{pos} \item |pos = 1| will be at the end, \item |pos = |$\frac{1}{\meta{number}}$ will be at the first kink, \item |pos = |$\frac{\meta{number}-1}{\meta{number}}$ will be at the second kink and @@ -135,4 +135,51 @@ All distances can be set with on key. \begin{key}{/tikz/udlr/from center=\opt{\meta{true or false}} (initially false, default true)} This is an alias for |/tikz/hvvh/from center|. -\end{key}
\ No newline at end of file +\end{key} + +\subsection{Even more Horizontal and Vertical Lines} + +The following keys can be used to access vertical and horizontal line path operations. +\begin{stylekey}{/tikz/horizontal vertical} + This installs \verb!to path = -| (\tikztotarget) \tikztonodes! that can be used with\indexKeyO{to path} + the path operations |to| or |edge|. +\end{stylekey} +\begin{stylekey}{/tikz/vertical horizontal} + This installs \verb!to path = |- (\tikztotarget) \tikztonodes! that can be used with + the path operations |to| or |edge|. +\end{stylekey} +\begin{stylekey}{/tikz/horizontal vertical horizontal} + This installs \verb!to path = -|- (\tikztotarget) \tikztonodes! that can be used with + the path operations |to| or |edge|. +\end{stylekey} +\begin{stylekey}{/tikz/vertical horizontal vertical} + This installs \verb!to path = |-| (\tikztotarget) \tikztonodes! that can be used with + the path operations |to| or |edge|. +\end{stylekey} + +When connecting rectangular nodes, these keys could be useful as well. +They all need to be given to a |to| or |edge| path operation. +\begin{stylekey}{/tikz/only vertical second=\opt{\meta{length}} (default 0pt)} +This draws a vertical line from the start point to the target point so that +it connects to the target point in the center (or at its border in case it is a node). + +The optional \meta{length} can be used to shift the line orthogonally to its direction. +\end{stylekey} +\begin{stylekey}{/tikz/only horizontal second=\opt{\meta{length}} (default 0pt)} +This draws a horizontal line from the start point to the target point so that +it connects to the target point in the center (or at its border in case it is a node). + +The optional \meta{length} can be used to shift the line orthogonally to its direction. +\end{stylekey} +\begin{stylekey}{/tikz/only vertical first=\opt{\meta{length}} (default 0pt)} +This draws a vertical line from the start point to the target point so that +it connects to the start point in the center (or at its border in case it is a node). + +The optional \meta{length} can be used to shift the line orthogonally to its direction. +\end{stylekey} +\begin{stylekey}{/tikz/only horizontal first=\opt{\meta{length}} (default 0pt)} +This draws a horizontal line from the start point to the target point so that +it connects to the start point in the center (or at its border in case it is a node). + +The optional \meta{length} can be used to shift the line orthogonally to its direction. +\end{stylekey} diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.timer.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.timer.tex index d3670726d7..09049bf829 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.timer.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-paths.timer.tex @@ -7,31 +7,11 @@ % 1. under the LaTeX Project Public License and/or % 2. under the GNU Free Documentation License. % -\makeatletter -\newenvironment{pathoperation'}[3][]{ - \begin{pgfmanualentry} - \def\pgfmanualtest{#1}% - \pgfmanualentryheadline{% - \ifx\pgfmanualtest\@empty% - \pgfmanualpdflabel{#2}{}% - \fi% - %\textcolor{gray}{{\ttfamily\char`\\path}\ \ \dots} - %\declare{\texttt{\noligs{#2}}}#3\ \textcolor{gray}{\dots\texttt{;}} - }% - \ifx\pgfmanualtest\@empty% - \index{#2@\protect\texttt{#2} path operation}% - \index{Path operations!#2@\protect\texttt{#2}}% - \fi% - \pgfmanualbody -} -{ - \end{pgfmanualentry} -} -\makeatother + \section{Extending the Path Timers} \label{library:timer} -\begin{tikzlibrary}{paths.timer} +\begin{tikzlibrary}{ext.paths.timer} This library adds timers to the path specifications |rectangle|, |parabola|, |sin| and |cos|. \end{tikzlibrary} @@ -43,15 +23,13 @@ the other paths, nodes, coordinates, pics, etc. are placed on the last coordinat This library allows this. \subsection{Rectangle} -%\index{Path operations!\protect\texttt{rectangle}}% -%\index{\texttt{rectangle} path operation}% -\begin{pathoperation'}{rectangle}{}\end{pathoperation'} +\indexPathOperationO{rectangle} -For the |rectangle| path operator, the timer starts with |pos = 0| (= |at start|) from +For the |rectangle| path operator, the timer starts with |pos = 0| (= |at start|) from\indexKeyO{pos} the starting coordinate in a counter-clockwise direction along the rectangle. The corners will be at positions 0.0, 0.25, 0.5, 0.75 and 1.0. -\begin{codeexample}[width=10cm,preamble=\usetikzlibrary{paths.timer}] +\begin{codeexample}[width=10cm,preamble=\usetikzlibrary{ext.paths.timer}] \begin{tikzpicture}[scale=2, every pin edge/.style={latex-, gray}] \coordinate [label=above right:Target] (A) at (0,0); \coordinate [label=below left:Start] (B) at (1,2); @@ -65,13 +43,12 @@ The corners will be at positions 0.0, 0.25, 0.5, 0.75 and 1.0. \end{codeexample} \subsection{Parabola} -\index{Path operations!\protect\texttt{parabola}}% -\index{\texttt{parabola} path operation}% +\indexPathOperationO{parabola}% For the |parabola| path operator the timer is similar to the |.. controls ..| operator. The position 0.5 will lie at the |bend|. -\begin{codeexample}[width=.3\linewidth,preamble=\usetikzlibrary{paths.timer}] +\begin{codeexample}[width=.3\linewidth,preamble=\usetikzlibrary{ext.paths.timer}] \begin{tikzpicture} \draw[help lines] (-2.25, -1.25) grid (2.25, 3.25); \draw ( 2,-1) parabola bend (0,0) (-1,3); @@ -86,7 +63,7 @@ The position 0.5 will lie at the |bend|. If no |bend| is specified half the positions will collapse into one end of the curve. -\begin{codeexample}[width=.3\linewidth,preamble=\usetikzlibrary{paths.timer}] +\begin{codeexample}[width=.3\linewidth,preamble=\usetikzlibrary{ext.paths.timer}] \begin{tikzpicture}[every pin edge/.style={latex-, shorten <=1pt, gray}] \draw (-2,-2) parabola (1,0) foreach \pos in {0, 1, ..., 10} { @@ -96,14 +73,11 @@ If no |bend| is specified half the positions will collapse into one end of the c \end{codeexample} \subsection{Sine/Cosine} -\index{Path operations!\protect\texttt{sin}}% -\index{Path operations!\protect\texttt{cos}}% -\index{\texttt{sin} path operation}% -\index{\texttt{cos} path operation}% +\indexPathOperationO{sin}\indexPathOperationO{cos}% The |sin| and |cos| path operators also allow placing of nodes along their paths. -\begin{codeexample}[width=.3\linewidth,preamble=\usetikzlibrary{paths.timer}] +\begin{codeexample}[width=.3\linewidth,preamble=\usetikzlibrary{ext.paths.timer}] \begin{tikzpicture}[mark nodes on line/.style={insert path={ foreach \pos in {1, ..., 9} {node[ sloped, fill=white, font=\small, inner sep=+0pt, pos=\pos/10] {\pos}}}}] diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-patterns.images.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-patterns.images.tex index 2c02b157a9..10fa3aca6d 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-patterns.images.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-patterns.images.tex @@ -11,7 +11,7 @@ \section{Using Images as a Pattern} \label{library:patterns.images} -\begin{tikzlibrary}{patterns.images} +\begin{tikzlibrary}{ext.patterns.images} This library allows to use an image to be used as a repeating pattern for a path. \end{tikzlibrary} @@ -29,7 +29,7 @@ This is a two-step process: \begin{key}{/tikz/image as pattern=\meta{options} (default |\{\}|)} -\begin{codeexample}[preamble=\usetikzlibrary{patterns.images}] +\begin{codeexample}[preamble=\usetikzlibrary{ext.patterns.images}] \pgfsetupimageaspattern[width=.5cm]{grid}{example-image-1x1} \tikz \node[star, minimum size=3cm, draw, image as pattern={name=grid,options={left, bottom, y=-.5cm, rotate=45}}] {}; @@ -41,8 +41,8 @@ Specifies the name of the ``image-pattern'' to be used. \end{key} \begin{stylekey}{/tikz/image as pattern/option} -Options that's be used by the internal |\pgftext|, -only keys from |/pgf/text| should be used. +Options that's be used by the internal |\pgftext|,\indexCommandO{\pgftext} +only keys from |/pgf/text| should be used.\indexKeyO[/pgf/]{text} \end{stylekey} \begin{stylekey}{/tikz/image as pattern/options=\meta{style}} diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-positioning-plus.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-positioning-plus.tex new file mode 100644 index 0000000000..a0451a8fd7 --- /dev/null +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-positioning-plus.tex @@ -0,0 +1,183 @@ +% !TeX spellcheck = en_US +% !TeX root = tikz-ext-manual.tex +% Copyright 2022 by Qrrbrbirlbel +% +% This file may be distributed and/or modified +% +% 1. under the LaTeX Project Public License and/or +% 2. under the GNU Free Documentation License. +% +\clearpage +\section{Positioning Plus} +\label{library:positioning-plus} +\tikzsetnextfilename{posplus} +\begin{tikzlibrary}{ext.positioning-plus} + With the help of the |positioning|\indexLibrary{positioning} and the |fit|\indexLibrary{fit} library this extends the placement of nodes. +\end{tikzlibrary} + +\subsection{Useful corner anchors} +The anchors |corner north east|, |corner north west|, |corner south west| and |corner south east| +are defined as ``generic anchors'', i.\,e. they are defined for all shapes. +This is mostly useful for the placement of circular shapes. +\begin{stylekey}{/tikz/corner above left=\opt{\meta{specification}} (default 0pt)} + Similar as \referenceKeyandIndexO{above left} of the \tikzname\space library |positioning| + but uses the |corner north west| anchor. +\end{stylekey} +\begin{stylekey}{/tikz/corner below left=\opt{\meta{specification}} (default 0pt)} + Similar as \referenceKeyandIndexO{below left} of the \tikzname\space library |positioning| + but uses the |corner south west| anchor. +\end{stylekey} +\begin{stylekey}{/tikz/corner above right=\opt{\meta{specification}} (default 0pt)} + Similar as \referenceKeyandIndexO{above right} of the \tikzname\space library |positioning| + but uses the |corner north east| anchor. +\end{stylekey} +\begin{stylekey}{/tikz/corner below right=\opt{\meta{specification}} (default 0pt)} + Similar as \referenceKeyandIndexO{below right} of the \tikzname\space library |positioning| + but uses the |corner south east| anchor. +\end{stylekey} + +\begin{codeexample}[width=.6\linewidth,preamble=\usetikzlibrary{ext.positioning-plus}] +\Huge +\begin{tikzpicture} +\node[name=s,shape=circle,shape example] + {Circle\vrule width 1pt height 2cm}; +\foreach \anchor/\placement in { + north west/above left, north/above, north east/above right, + west/left, center/above, east/right, + mid west/right, mid/above, mid east/left, + base west/left, base/below, base east/right, + south west/below left, south/below, south east/below right, + text/left, 10/right, 130/above} + \draw[shift=(s.\anchor)] plot[mark=x] coordinates{(0,0)} + node[\placement] {\scriptsize\texttt{(s.\anchor)}}; +\draw (s.corner north west) rectangle (s.corner south east); +\foreach \anchor/\placement in { + corner north west/above left, corner north east/above right, + corner south west/below left, corner south east/below right} + \draw[red,shift=(s.\anchor)] plot[mark=x] coordinates{(0,0)} + node[\placement] {\scriptsize\texttt{(s.\anchor)}}; +\end{tikzpicture} +\end{codeexample} + +\subsection{Useful placement keys for vertical and horizontal alignment} +\begin{stylekey}{/tikz/north left=\opt{\meta{specification}} (default 0pt)} + Like \referenceKeyandIndexO{left} but aligns the nodes at their |north| border. + + This is basically the same as |left=of reference.north west, anchor=north east|. + % +\begin{codeexample}[preamble=\usetikzlibrary{ext.positioning-plus}] +\begin{tikzpicture}[nodes=draw] +\node[minimum height=2cm] (a) {}; +\node[minimum height=3cm, north right=of a] {}; +\end{tikzpicture} +\end{codeexample} +\end{stylekey} +\begin{stylekey}{/tikz/north right=\opt{\meta{specification}} (default 0pt)} + Like \referenceKeyandIndexO{right} but aligns the nodes at their |north| border. + + This is basically the same as |left=of reference.north east, anchor=north west|. +\end{stylekey} +\begin{stylekey}{/tikz/south left=\opt{\meta{specification}} (default 0pt)} + Like \referenceKeyandIndexO{left} but aligns the nodes at their |south| border. + + This is basically the same as |left=of reference.south west, anchor=south east|. +\end{stylekey} +\begin{stylekey}{/tikz/south right=\opt{\meta{specification}} (default 0pt)} + Like \referenceKeyandIndexO{right} but aligns the nodes at their |south| border. + + This is basically the same as |left=of reference.south east, anchor=south west|. +\end{stylekey} +\begin{stylekey}{/tikz/west above=\opt{\meta{specification}} (default 0pt)} + Like \referenceKeyandIndexO{above} but aligns the nodes at their |west| border. + + This is basically the same as |left=of reference.north west, anchor=south west|. +\end{stylekey} +\begin{stylekey}{/tikz/west below=\opt{\meta{specification}} (default 0pt)} + Like \referenceKeyandIndexO{below} but aligns the nodes at their |west| border. + + This is basically the same as |left=of reference.south west, anchor=north west|. +\end{stylekey} +\begin{stylekey}{/tikz/east above=\opt{\meta{specification}} (default 0pt)} + Like \referenceKeyandIndexO{above} but aligns the nodes at their |east| border. + + This is basically the same as |left=of reference.north east, anchor=south east|. +\end{stylekey} +\begin{stylekey}{/tikz/east below=\opt{\meta{specification}} (default 0pt)} + Like \referenceKeyandIndexO{below} but aligns the nodes at their |east| border. + + This is basically the same as |left=of reference.south east, anchor=north east|. +\end{stylekey} + +The same exist for the recently introduces corner anchors, too. +\begin{stylekey}{/tikz/corner north left=\opt{\meta{specification}} (default 0pt)} + The same as |/tikz/north left| but uses the new corner anchors. +\end{stylekey} +\begin{stylekey}{/tikz/corner north right=\opt{\meta{specification}} (default 0pt)} + The same as |/tikz/north right| but uses the new corner anchors. +\end{stylekey} +\begin{stylekey}{/tikz/corner south left=\opt{\meta{specification}} (default 0pt)} + The same as |/tikz/south left| but uses the new corner anchors. +\end{stylekey} +\begin{stylekey}{/tikz/corner south right=\opt{\meta{specification}} (default 0pt)} + The same as |/tikz/south right| but uses the new corner anchors. +\end{stylekey} +\begin{stylekey}{/tikz/corner west above=\opt{\meta{specification}} (default 0pt)} + The same as |/tikz/west above| but uses the new corner anchors. +\end{stylekey} +\begin{stylekey}{/tikz/corner west below=\opt{\meta{specification}} (default 0pt)} + The same as |/tikz/west below| but uses the new corner anchors. +\end{stylekey} +\begin{stylekey}{/tikz/corner east above=\opt{\meta{specification}} (default 0pt)} + The same as |/tikz/east above| but uses the new corner anchors. +\end{stylekey} +\begin{stylekey}{/tikz/corner east below=\opt{\meta{specification}} (default 0pt)} + The same as |/tikz/east below| but uses the new corner anchors. +\end{stylekey} + +While the \meta{specification} of all these keys still accept the same form as with \tikzname, +the |ext.positioning-plus| library extends this even more. + +The specification after |of| can contain a list of coordinates +(like the |fit| key of the |fit| library). +This means that the new node will be placed in relation to a rectangular bounding box +that fits around all this nodes in the list. + +If this list is prefixed with \verb!|!, |-| or |+|, +the new node will also have the same height (\verb!|!), +the same width (|-|) or both as this bounding box. + +\begin{codeexample}[preamble=\usetikzlibrary{ext.positioning-plus}] +\begin{tikzpicture}[nodes=draw] +\node (A) {A}; +\node[below=of A] (BCD) {BCD}; +\node[right=of |(A)(BCD)] (c) {}; +\node[below=.5:of -(A)(BCD)] (d) {}; +\draw[help lines] (BCD.south west) -- (c.south east) + (BCD.north east) -- (d.south east); +\end{tikzpicture} +\end{codeexample} + +This functionality is also available without the placement: +\begin{stylekey}{/tikz/fit bounding box=\meta{list of coordinates}} + Creates a rectangular node with the name |fit bounding box| that encompasses + the \meta{list of coordinates}. +\end{stylekey} +\begin{stylekey}{/tikz/span vertical=\meta{list of coordinates}} + Creates a rectangular node with the name |fit bounding box| that encompasses + the \meta{list of coordinates} \emph{and} sets the \referenceKeyandIndexO[/pgf]{minimum height} to + the height of this bounding box. +\end{stylekey} +\begin{stylekey}{/tikz/span horizontal=\meta{list of coordinates}} + Creates a rectangular node with the name |fit bounding box| that encompasses + the \meta{list of coordinates} \emph{and} sets the \referenceKeyandIndexO[/pgf]{minimum width} to + the width of this bounding box. +\end{stylekey} +\begin{stylekey}{/tikz/span=\meta{list of coordinates}} + Is a combination of |/tikz/span vertical| and |/tikz/span horizontal|. +\end{stylekey} + +As you maybe noticed in the example above, the \meta{specification} also allows a prefix +delimited by |:| which the |node distance| will be multiplied to with for the placement.% +\footnote{This is probably more useful when \referenceKeyandIndexO{on grid} is used.} + +\endinput
\ No newline at end of file diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-topaths.arcthrough.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-topaths.arcthrough.tex index 10b125a39b..1d9e5ba9df 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-topaths.arcthrough.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-topaths.arcthrough.tex @@ -10,11 +10,11 @@ \section{Arcs through Three Points} \label{library:topaths.arcthrough} -\begin{tikzlibrary}{topaths.arcthrough} +\begin{tikzlibrary}{ext.topaths.arcthrough} This library allows to use an arc defined by three points. \end{tikzlibrary} -\begin{codeexample}[width=10cm,preamble=\usetikzlibrary{topaths.arcthrough}] +\begin{codeexample}[width=10cm,preamble=\usetikzlibrary{ext.topaths.arcthrough}] \begin{tikzpicture} \coordinate[label=above right:$A$] (A) at ( 3, 1); \coordinate[label=above:$B$] (B) at ( 1, 2); @@ -33,6 +33,7 @@ This can only by used for circles in the |canvas| coordinate system. +\begin{multicols}{2} \begin{key}{/tikz/arc through/through=\meta{coordinate} (initially {(0,0)})} The coordinate on the circle that defines~-- together with the starting and target point~-- a circle. @@ -40,7 +41,7 @@ This can only by used for circles in the |canvas| coordinate system. \begin{key}{/tikz/arc through/center suffix=\meta{suffix} (initially {})} The |arc through| will define a coordinate named |arc through center|\meta{suffix} - so that it can referenced later. + so that it can be referenced later. \end{key} \begin{key}{/tikz/arc through/clockwise} @@ -54,7 +55,9 @@ This can only by used for circles in the |canvas| coordinate system. \end{key} \begin{key}{/tikz/arc through=\meta{key-value}} - This key should be used with |to| or |edge|. + This key should be used with |to|\indexPathOperationO{to} or |edge|\indexPathOperationO{edge}. A parameter other than |center suffix|, |clockwise| or |counter clockwise| will be assumed to be the |through| coordinate. \end{key} +\end{multicols} +\endinput
\ No newline at end of file diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-trans.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-trans.tex index ef1fb70ac2..b2aa0f8f7f 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-trans.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-library-trans.tex @@ -1,3 +1,5 @@ +% !TeX spellcheck = en_US +% !TeX root = tikz-ext-manual.tex % Copyright 2022 by Qrrbrbirlbel % % This file may be distributed and/or modified @@ -10,16 +12,16 @@ \section{Mirror, Mirror on the Wall} \label{library:mirror} -\begin{tikzlibrary}{transformations.mirror} +\begin{tikzlibrary}{ext.transformations.mirror} This library adds more transformations to \tikzname. \end{tikzlibrary} -As explained in section~\ref{pgflibrary:transformations}, they are two approaches to setting a mirror transformation. -As with the commands in PGF, we'll be using lowercase |m| for the ``Spiegelungsmatrix'' and uppercase |M| for the built-in approach. +As explained in section~\ref{pgflibrary:transformations}, there are two approaches to setting a mirror transformation. +As with the commands in PGF, we'll be using a lowercase |m| for the reflection matrix and an uppercase |M| for the built-in approach. -\subsection{Using the ``Spiegelungsmatrix''} +\subsection{Using the reflection matrix} -\begin{codeexample}[width=.4\linewidth,preamble=\usetikzlibrary{shapes.geometric,transformations.mirror}] +\begin{codeexample}[width=.4\linewidth,preamble=\usetikzlibrary{shapes.geometric,ext.transformations.mirror}] \begin{tikzpicture}[line join=round, thick, reg poly/.style={ shape=regular polygon, regular polygon sides={#1}}] \node[reg poly=5, minimum size=+2cm, draw, very thick] (a) {}; @@ -32,7 +34,7 @@ As with the commands in PGF, we'll be using lowercase |m| for the ``Spiegelungsm \begin{key}{/tikz/xmirror=\meta{value or coordinate}} Sets up a transformation that mirrors along a horizontal line that goes through point $(\text{\meta{value}}, 0)$ or \meta{coordinate}. -\begin{codeexample}[preamble=\usetikzlibrary{transformations.mirror}] +\begin{codeexample}[preamble=\usetikzlibrary{ext.transformations.mirror}] \begin{tikzpicture} \draw[help lines] (-0.25, -.25) grid (3.25, 1.25); \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); @@ -50,7 +52,7 @@ As with the commands in PGF, we'll be using lowercase |m| for the ``Spiegelungsm \begin{key}{/tikz/mirror x=\meta{coordinate}} Similar to |/tikz/xmirror|, this however uses the |xyz| coordinate system instead of the |canvas| system. -\begin{codeexample}[preamble=\usetikzlibrary{transformations.mirror}] +\begin{codeexample}[preamble=\usetikzlibrary{ext.transformations.mirror}] \begin{tikzpicture}[x=.5cm, y=(45:1cm)] \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); @@ -76,7 +78,7 @@ As with the commands in PGF, we'll be using lowercase |m| for the ``Spiegelungsm \subsection{Using built-in transformations} -\begin{codeexample}[width=.4\linewidth,preamble=\usetikzlibrary{shapes.geometric,transformations.mirror}] +\begin{codeexample}[width=.4\linewidth,preamble=\usetikzlibrary{shapes.geometric,ext.transformations.mirror}] \begin{tikzpicture}[line join=round, thick, reg poly/.style={ shape=regular polygon, regular polygon sides={#1}}] \node[reg poly=5, minimum size=+2cm, draw, very thick] (a) {}; @@ -89,7 +91,7 @@ As with the commands in PGF, we'll be using lowercase |m| for the ``Spiegelungsm \begin{key}{/tikz/xMirror=\meta{value or coordinate}} Sets up a transformation that mirrors along a horizontal line that goes through point $(\text{\meta{value}}, 0)$ or \meta{coordinate}. -\begin{codeexample}[preamble=\usetikzlibrary{transformations.mirror}] +\begin{codeexample}[preamble=\usetikzlibrary{ext.transformations.mirror}] \begin{tikzpicture} \draw[help lines] (-0.25, -.25) grid (3.25, 1.25); \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); @@ -107,7 +109,7 @@ As with the commands in PGF, we'll be using lowercase |m| for the ``Spiegelungsm \begin{key}{/tikz/Mirror x=\meta{coordinate}} Similar to |/tikz/xMirror|, this however uses the |xyz| coordinate system instead of the |canvas| system. -\begin{codeexample}[preamble=\usetikzlibrary{transformations.mirror}] +\begin{codeexample}[preamble=\usetikzlibrary{ext.transformations.mirror}] \begin{tikzpicture}[x=.5cm, y=(45:1cm)] \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); @@ -131,4 +133,4 @@ As with the commands in PGF, we'll be using lowercase |m| for the ``Spiegelungsm When only \meta{point A} is given that line goes through \meta{point A} and the origin. \end{key} -\endinput
\ No newline at end of file +\endinput diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-main-body.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-main-body.tex index 10deb02792..e4445d392b 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-main-body.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-main-body.tex @@ -8,7 +8,7 @@ % 2. under the GNU Free Documentation License. % \newcommand*\tikzextname{Ti\textit kZ-Extensions} -\newcommand*\tikzextversion{0.1} +\newcommand*\tikzextversion{0.2} %\includeonly{ % tikz-ext-manual-en-library-paths.arcto, @@ -40,7 +40,7 @@ These libraries only work with \tikzname. \vspace{1em} -\begin{center} +\begin{center}\tikzsetnextfilename{main-cover} \begin{tikzpicture}[ very thick, scale=2.7, @@ -74,24 +74,64 @@ These libraries only work with \tikzname. \end{tikzpicture} \end{center} -\include{tikz-ext-manual-en-library-paths.arcto} -\include{tikz-ext-manual-en-library-paths.ortho} -\include{tikz-ext-manual-en-library-paths.timer} -\include{tikz-ext-manual-en-library-patterns.images} -\include{tikz-ext-manual-en-library-topaths.arcthrough} -\include{tikz-ext-manual-en-library-trans} +\tikzsetfigurename{calendar-plus} \include{tikz-ext-manual-en-library-calendar-plus} +\tikzsetfigurename{node-families} \include{tikz-ext-manual-en-library-node-families} +\tikzsetfigurename{paths.arcto} \include{tikz-ext-manual-en-library-paths.arcto} +\tikzsetfigurename{paths.ortho} \include{tikz-ext-manual-en-library-paths.ortho} +\tikzsetfigurename{paths.timer} \include{tikz-ext-manual-en-library-paths.timer} +\tikzsetfigurename{patterns.images} \include{tikz-ext-manual-en-library-patterns.images} +\tikzsetfigurename{positioning-plus}\include{tikz-ext-manual-en-library-positioning-plus} +\tikzsetfigurename{topaths.arcthrough}\include{tikz-ext-manual-en-library-topaths.arcthrough} +\tikzsetfigurename{trans} \include{tikz-ext-manual-en-library-trans} \part{PGF Libraries} \label{part:pgf} These libraries (should) work with both PGF and \tikzname. -\include{tikz-ext-manual-en-pgf-trans} +\begin{center}\tikzsetnextfilename{main-graph} +\begin{codeexample}[width=10cm,preamble=\usetikzlibrary{graphs,graphdrawing,ext.misc} \usegdlibrary{force}] +\tikzset{ + mynode/.style={ + circle, minimum size=10mm, draw, densely dashdotted, thick, + decide color/.expand once=#1}, + decide color/.style 2 args={ + /utils/TeX/if=c#1 + {/utils/TeX/ifnum={#2<5}{bluelight}{bluedark}} + {/utils/TeX/ifnum={#2<8}{light}{dark}}}, + light/.style={fill=gray!20}, bluelight/.style={fill=blue!10}, + dark/.style ={fill=gray!60}, bluedark/.style ={fill=blue!30}} +\tikz\graph[ + spring electrical layout, vertical=c2 to p13, + node distance=1.5cm, typeset=$n_{\tikzgraphnodetext}$, + nodes={mynode=\tikzgraphnodetext}] { + % outer ring + c2 -- {p1, p11, p6}; + p1 -- {p8, c6, p11}; + p8 -- {p3, p10, c6}; + p3 -- {p13, p15, p10}; + p13 -- {p15, c7}; + c7 -- {c3, c4, p15}; + c3 -- {p14, c4}; + p14 -- {p7, c4}; + p7 -- {p9, p2, c4}; + p9 -- {c5, p12, p2}; + c5 -- {c1, p4, p12}; + c1 -- {p6, p4}; + p6 -- {p11, p4}; + % inner ring + p11 -- {c6, p12, p4}; + p5 -- {c6 -- {p10, p12}, p10 -- p15, p15 -- c4, c4 -- p2, p2 -- p12, p12 -- p4}; +}; +\end{codeexample} +\end{center} -\part{Miscellaneous} +\tikzsetfigurename{PGF.trans}\include{tikz-ext-manual-en-pgf-trans} + +\part{Utilities} \label{part:misc} -\vfill -\begin{codeexample}[width=6cm, preamble=\usetikzlibrary{misc}] +\vfill\tikzsetnextfilename{main-misc} +\begin{codeexample}[width=6cm, preamble=\usetikzlibrary{ext.misc}] \begin{tikzpicture}[ declare function={bigR(\n)=smallR+.05*\n;}, declare constant={smallR=1; segments=20;}, @@ -118,9 +158,34 @@ These libraries (should) work with both PGF and \tikzname. \end{codeexample} \vfill -\include{tikz-ext-manual-en-library-misc} +\tikzsetfigurename{misc.calendar}\include{tikz-ext-manual-en-calendar} +\tikzsetfigurename{misc.misc}\include{tikz-ext-manual-en-library-misc} %%% END +\newcommand*{\addTikz}[1]{Added \tikzname\space library \texttt{ext.#1}.} +\newcommand*{\addPGF}[1]{Added PGF library \texttt{ext.#1}.} +\part{Changelog \& Index} +\section*{Changelog} +\begin{multicols}{2} +Version 0.2 +\begin{itemize} +\item \addTikz{positioning-plus} +\item \addTikz{node-families} +\end{itemize} + +Version 0.1 +\begin{itemize} +\item \addTikz{calendar-plus} +\item \addTikz{misc} +\item \addTikz{paths.arcto} +\item \addTikz{paths.ortho} +\item \addTikz{paths.timer} +\item \addTikz{patterns.images} +\item \addTikz{topaths.arcthrough} +\item \addTikz{transformations.mirror} +\item \addPGF{transformations.mirror} +\end{itemize} +\end{multicols} \printindex %\typeout{Examples: \the\codeexamplecount}% diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-main-preamble.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-main-preamble.tex index a1897bbf70..238c10172f 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-main-preamble.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-main-preamble.tex @@ -85,13 +85,16 @@ \makeatother \usetikzlibrary{ - misc, - paths.arcto, - paths.ortho, - paths.timer, - patterns.images, - topaths.arcthrough, - transformations.mirror, + ext.calendar-plus, + ext.misc, + ext.node-families, + ext.paths.arcto, + ext.paths.ortho, + ext.paths.timer, + ext.patterns.images, + ext.positioning-plus, + ext.topaths.arcthrough, + ext.transformations.mirror, % calc, fit, @@ -103,3 +106,263 @@ %% needs Lua! \usetikzlibrary{graphs,graphdrawing} \usegdlibrary{force} + +\makeatletter +\def\endofcodeexample#1{% original from tex/latex/pgf/doc/pgfmanual-en-macros.tex by Till Tantau et al + \endgroup% + \ifpgfmanual@setup@code% + \gdef\pgfmanual@do@this{% + {% + \returntospace% + \commenthandler% + \xdef\code@temp{#1}% removes returns and comments + }% + \edef\pgfmanualmcatcode{\the\catcode`\^^M}% + \catcode`\^^M=9\relax% + \expandafter\scantokens\expandafter{\code@temp}% + \catcode`\^^M=\pgfmanualmcatcode% + }% + \fi% + \ifcode@hidden\else + \ifcode@execute% + \setbox\codeexamplebox=\hbox{% + \ifx\code@render\pgfutil@empty% + {% + {% + \returntospace% + \commenthandler% + \xdef\code@temp{#1}% removes returns and comments + }% + \catcode`\^^M=9% + \colorbox{graphicbackground}{\color{black}\ignorespaces% + \code@pre\expandafter\scantokens\expandafter{\code@temp\ignorespaces}\code@post\ignorespaces}% + }% + \else% + \global\let\code@temp\code@render% + \colorbox{graphicbackground}{\color{black}\ignorespaces% + \code@render}% + \fi% + }% + \ifx\code@animation@list\pgfutil@empty% + \else% + \setbox\codeexampleboxanim=\vbox{% + \rightskip0pt\leftskip0pt plus1filll% + \ifdim\wd\codeexamplebox>\codeexamplewidth% + \else% + \hsize\codeexamplewidth% + \advance\hsize by2cm% + \fi% + \leavevmode\catcode`\^^M=9% + \foreach \pgfmanualtime/\pgfmanualtimehow in\code@animation@list{% + \setbox\codeexampleboxanim=\hbox{\colorbox{animationgraphicbackground}{% + \tikzset{make snapshot of=\pgfmanualtime}% + \scalebox{\pgfmanualanimscale}{\color{black}\ignorespaces% + \code@animation@pre\expandafter\scantokens\expandafter{\code@temp\ignorespaces}\code@animation@post\ignorespaces}% + }}% + \space\raise4pt\hbox to0pt{\vrule width0pt height1em\hbox + to\wd\codeexampleboxanim{\hfil\scriptsize$t{=}\pgfmanualtimehow \mathrm s$\hfil}\hss}% + \lower\ht\codeexampleboxanim\box\codeexampleboxanim\hfil\penalty0\hskip0ptplus-1fil% + }% + }% + \setbox\codeexampleboxanim=\hbox{\hbox{}\hskip-2cm\box\codeexampleboxanim}% + \fi% + \ifdim\wd\codeexamplebox>\codeexamplewidth% + \def\code@start{\par}% + \def\code@flushstart{}\def\code@flushend{}% + \def\code@mid{\parskip2pt\par\noindent}% + \def\code@width{\linewidth-6pt}% + \def\code@end{}% + \else% + \def\code@start{% +% \linewidth=\textwidth% removed this line + \parshape \@ne 0pt \linewidth + \leavevmode% + \hbox\bgroup}% + \def\code@flushstart{\hfill}% + \def\code@flushend{\hbox{}}% + \def\code@mid{\hskip6pt}% + \def\code@width{\linewidth-12pt-\codeexamplewidth}% + \def\code@end{\egroup}% + \fi% + \code@start% + \noindent% + \begin{minipage}[t]{\codeexamplewidth}\raggedright + \hrule width0pt% + \footnotesize\vskip-1em% + \code@flushstart\box\codeexamplebox\code@flushend% + \vskip0pt% + \leavevmode% + \box\codeexampleboxanim% + \vskip-1ex + \leavevmode% + \end{minipage}% + \else% + \def\code@mid{\par} + \def\code@width{\linewidth-6pt} + \def\code@end{} + \fi% + \code@mid% + \ifpgfmanual@multipage@code% + {% + \pgfkeysvalueof{/codeexample/prettyprint/base color}% + \pgfmanualdolisting{#1}% + }% + \else% + \colorbox{codebackground}{% + \pgfkeysvalueof{/codeexample/prettyprint/base color}% + \begin{minipage}[t]{\code@width}% + \pgfmanualdolisting{#1}% + \end{minipage}}% + \fi% + \code@end% + \par% + \medskip + \fi + \endcodeexample\endgroup% +} + +\newenvironment{pathoperation'}[3][]{ + \begin{pgfmanualentry} + \def\pgfmanualtest{#1}% + \pgfmanualentryheadline{% + \ifx\pgfmanualtest\@empty% + \pgfmanualpdflabel{#2}{}% + \fi% + %\textcolor{gray}{{\ttfamily\char`\\path}\ \ \dots} + %\declare{\texttt{\noligs{#2}}}#3\ \textcolor{gray}{\dots\texttt{;}} + }% + \ifx\pgfmanualtest\@empty% + \index{#2@\protect\texttt{#2} path operation}% + \index{Path operations!#2@\protect\texttt{#2}}% + \fi% + \pgfmanualbody +} +{ + \end{pgfmanualentry} +} +\makeatother + +\usepackage{paracol} + +%% normal references +\newcommand*{\indexLibrary}[1]{% + \index{#1@\protect\texttt{#1} library}% + \index{Libraries!#1@\protect\texttt{#1}}% +} +\newcommand*{\indexMathFunction}[1]{% + \index{#1@\protect\texttt{#1} math function}% + \index{Math functions!#1@\protect\texttt{#1}}% +} +\newcommand*{\indexShape}[1]{% + \index{#1@\protect\texttt{#1} shape}% + \index{Shapes!#1@\protect\texttt{#1}}% +} +\newcommand*{\indexHandler}[1]{% + \index{\gobble#1@\protect\texttt{#1} handler}% + \index{Key handlers!#1@\protect\texttt{#1}} +} +\newcommand*{\indexKey}[2][/tikz/]{% + \def\mykey{#1#2}% + \def\mypath{}% + \gdef\myname{}% + \decompose#1#2/\nil +} +\newcommand*{\indexPathOperation}[1]{% + \index{#1@\protect\texttt{#1} path operation}% + \index{Path operations!#1@\protect\texttt{#1}}% +} + +%% references to original +\newcommand*{\indexLibraryO}[1]{% + \index{#1@\originalprefix\protect\texttt{\original{#1}} library\originalsuffix}% + \index{Libraries!#1@\originalprefix\protect\texttt{\original{#1}}\originalsuffix}% +} +\newcommand*{\indexMathFunctionO}[1]{% + \index{#1@\protect\texttt{\original{#1}} math function\originalsuffix}% + \index{Math functions!#1@\protect\texttt{\original{#1}}\originalsuffix}% +} +\newcommand*{\indexShapeO}[1]{% + \index{#1@\originalprefix\protect\texttt{\original{#1}} shape\originalsuffix}% + \index{Shapes!#1@\originalprefix\protect\texttt{\original{#1}}\originalsuffix}% +} +\newcommand*{\indexHandlerO}[1]{% + \index{\gobble#1@\originalprefix\protect\texttt{\original{#1}} handler\originalsuffix}% + \index{Key handlers!#1@\originalprefix\protect\texttt{\original{#1}}\originalsuffix} +} +\newcommand*{\indexKeyO}[2][/tikz/]{%TODO + \begingroup\let\decomposetoodeep\decomposetoodeepO + \def\mykey{#1#2}% + \def\mypath{}% + \gdef\myname{}% + \firsttimetrue + \decomposeO#1#2/\nil + \endgroup +} +\def\decomposetoodeepO#1/#2/\nil{% + % avoid too-deep nesting in index + \index{#1/#2@\originalprefix\protect\texttt{\original{#1/#2}} key\originalsuffix}% + \index{\mypath#1/#2@\originalprefix\protect\texttt{\original{#1/#2}}\originalsuffix}% + \decomposefindlast/#1/#2/\nil% +} +\def\decomposeO/#1/#2\nil{% + \def\test{#2}% + \ifx\test\empty% + % aha. + \index{#1@\originalprefix\protect\texttt{\original{#1}} key\originalsuffix}% + \index{\mypath#1@\originalprefix\protect\texttt{\original{#1}}\originalsuffix}% + \gdef\myname{#1}% + \pgfmanualpdflabel{#1}{} + \else% + \advance\pgfmanualdecomposecount by1\relax% + \ifnum\pgfmanualdecomposecount>2\relax% + \decomposetoodeepO#1/#2\nil% + \else% + \iffirsttime% + \begingroup% + % also make a pdf link anchor with full key path. + \def\hyperlabelwithoutslash##1/\nil{% + \pgfmanualpdflabel{##1}{}% + }% + \hyperlabelwithoutslash/#1/#2\nil% + \endgroup% + \def\mypath{#1@\protect\texttt{/#1/}!}% + \firsttimefalse% + \else% + \expandafter\def\expandafter\mypath\expandafter{\mypath#1@\protect\texttt{#1/}!}% + \fi% + \def\firsttime{}% + \decomposeO/#2\nil% + \fi% + \fi% +} +\newcommand*{\indexPathOperationO}[1]{% + \index{#1@\originalprefix\protect\texttt{\original{#1}} path operation\originalsuffix}% + \index{Path operations!#1@\originalprefix\protect\texttt{\original{#1}}\originalsuffix}% +} + +\newcommand*{\indexCommandO}[1]{% + \removeats{#1}% + \index{\strippedat @\originalprefix\protect\texttt{\original{\protect\string\protect#1}}\originalsuffix}% +} + +\newcommand*{\referenceKeyandIndexO}[2][/tikz/]{\texttt{#1#2}\indexKeyO[#1]{#2}}% + +\colorlet{originalindex}{gray} +\newcommand*{\original}[1]{\textcolor{originalindex}{#1}} +\newcommand*{\originalsuffix}{}%\textsuperscript{\textdagger}}%\normalsize +\newcommand*{\originalprefix}{}%\footnotesize + +%\newcommand*{\original}[1]{\textcolor{originalindex}{#1}} +%\newcommand*{\original}[1]{#1}%\textcolor{originalindex}{#1}} +%\newcommand*{\originalsuffix}{}%\textsuperscript{\color{blue}\tikzname}} +%\DeclareRobustCommand*{\originalprefix}{\smash{\footnotesize\llap{\textbullet\space}}} + +\newcommand*{\filetype}[1]{\textsc{#1}} + +\makeatletter +\def\index@prologue{\section*{Index}\addcontentsline{toc}{section}{Index} + This index contains automatically generated entries as well as {\originalprefix\original{references}\originalsuffix} to + original functionalities of PGF/\tikzname. + \bigskip +} +\makeatother
\ No newline at end of file diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-pgf-trans.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-pgf-trans.tex index 3788e0c9a4..b0f0f2906d 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-pgf-trans.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual-en-pgf-trans.tex @@ -11,28 +11,30 @@ \section{Transformations: Mirroring} \label{pgflibrary:transformations} -\begin{pgflibrary}{transformations.mirror} +\begin{purepgflibrary}{ext.transformations.mirror} This library adds mirror transformations to PGF. -\end{pgflibrary} +\end{purepgflibrary} Two approaches to mirror transformation exist: \begin{enumerate} -\item Using the ``Spiegelmatrix`` (see section~\ref{pgflibrary:transformations:spiegelungsmatrix}). +\item Using the reflection matrix (see left column). - This depends on |\pgfpointnormalised| which involves the sine and the cosine functions of PGFmath. + This depends on |\pgfpointnormalised|\indexCommandO\pgfpointnormalised which involves + the sine\indexMathFunctionO{sin} and the cosine\indexMathFunctionO{cos} functions of PGFmath. -\item Using built-in transformations (see section~\ref{pgflibrary:transformations:builtin}). +\item Using built-in transformations (see right column). - This depends on |\pgfmathanglebetween| which involves the arctangent (|atan2|) function of PGFmath. + This depends on |\pgfmathanglebetween|\indexCommandO\pgfmathanglebetween which involves the arctangent (|atan2|\indexMathFunctionO{atan2}) function of PGFmath. \end{enumerate} Which one is better? I don't know. Choose one you're comfortable with. -\subsection{Using the ``Spiegelungsmatrix''} -\label{pgflibrary:transformations:spiegelungsmatrix} +\begin{paracol}{2} -The following commands use the ``Spiegelungsmatrix'' that sets the transformation matrix following +\subsection{Using the reflection matrix} + +The following commands use the reflection matrix that sets the transformation matrix following \begin{equation*} A = \frac{1}{\Vert\vec l\Vert^2} \begin{bmatrix} l_x^2-l_y^2 & 2l_xl_y \\ @@ -40,6 +42,18 @@ The following commands use the ``Spiegelungsmatrix'' that sets the transformatio \end{bmatrix}. \end{equation*} +\switchcolumn% > + +\stepcounter{subsection} +\subsection{Using built-in transformations} + +The following commands use a combination of shifting, rotating, $-1$ scaling, +rotating back and shifting back to reach the mirror transformation. + +The commands are named the same as on the left side, +only the |m| in |mirror| is capitalized. + +\switchcolumn*% < \begin{command}{\pgftransformxmirror\marg{value}} Sets up a transformation that mirrors along a vertical line that goes through point $(\text{\meta{value}}, 0)$. @@ -57,87 +71,90 @@ The following commands use the ``Spiegelungsmatrix'' that sets the transformatio \end{codeexample} \end{command} -\begin{command}{\pgftransformymirror\marg{value}} - Sets up a transformation that mirrors along a horizontal line that goes through point $(0, \text{\meta{value})}$. -\end{command} +\switchcolumn% > + +\begin{command}{\pgftransformxMirror\marg{value}} + Sets up a transformation that mirrors along a vertical line that goes through point $(\text{\meta{value}}, 0)$. -\begin{command}{\pgftransformmirror\marg{point A}\marg{point B}} - Sets up a transformation that mirrors along the line that goes through \meta{point A} and \meta{point B}. - \begin{codeexample}[preamble=\usepgflibrary{transformations.mirror}] \begin{tikzpicture} -\draw[help lines] (-.25, -2.25) grid (2.5, 1.25); +\draw[help lines] (-0.25, -.25) grid (3.25, 1.25); \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); -\draw[dashed] (0, -1) -- (2, 0); -\pgftransformmirror{\pgfpointxy{0}{-1}}{\pgfpointxy{2}{0}} +\draw[dashed] (1.5, -.25) -- (1.5, 1.25); +\pgftransformxMirror{1.5} \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); \end{tikzpicture} \end{codeexample} \end{command} -\begin{command}{\pgfqtransformmirror\marg{point A}} - Sets up a transformation that mirrors along the line that goes through the origin and \meta{point A}. +\switchcolumn*% < + +\begin{command}{\pgftransformymirror\marg{value}} + Sets up a transformation that mirrors along a horizontal line that goes through point $(0, \text{\meta{value})}$. +\end{command} +\begin{command}{\pgftransformmirror\marg{point A}\marg{point B}} + Sets up a transformation that mirrors along the line that goes through \meta{point A} and \meta{point B}. + \begin{codeexample}[preamble=\usepgflibrary{transformations.mirror}] \begin{tikzpicture} -\draw[help lines] (-.25, -.25) grid (2.25, 1.25); +\draw[help lines] (-.25, -2.25) grid (2.5, 1.25); \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); -\draw[dashed] (0, 0) -- (2, 1); -\pgfqtransformmirror{\pgfpointxy{2}{1}} +\draw[dashed] (0, -1) -- (2, 0); +\pgftransformmirror{\pgfpointxy{0}{-1}} + {\pgfpointxy{2}{ 0}} \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); \end{tikzpicture} \end{codeexample} \end{command} +\switchcolumn% > -\subsection{Using built-in transformations} -\label{pgflibrary:transformations:builtin} - -The following commands use a combination of shifting, rotating, $-1$ scaling, rotating back and shifting back to reach the mirror transformation. - -The commands are named the same as above, only the |m| in |mirror| is capitalized. - - -\begin{command}{\pgftransformxMirror\marg{value}} - Sets up a transformation that mirrors along a vertical line that goes through point $(\text{\meta{value}}, 0)$. +\begin{command}{\pgftransformyMirror\marg{value}} + Sets up a transformation that mirrors along a horizontal line that goes through point $(0, \text{\meta{value})}$. +\end{command} +\begin{command}{\pgftransformMirror\marg{point A}\marg{point B}} + Sets up a transformation that mirrors along the line that goes through \meta{point A} and \meta{point B}. + \begin{codeexample}[preamble=\usepgflibrary{transformations.mirror}] \begin{tikzpicture} -\draw[help lines] (-0.25, -.25) grid (3.25, 1.25); +\draw[help lines] (-.25, -2.25) grid (2.5, 1.25); \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); -\draw[dashed] (1.5, -.25) -- (1.5, 1.25); -\pgftransformxMirror{1.5} +\draw[dashed] (0, -1) -- (2, 0); +\pgftransformMirror{\pgfpointxy{0}{-1}} + {\pgfpointxy{2}{ 0}} \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); \end{tikzpicture} \end{codeexample} \end{command} -\begin{command}{\pgftransformyMirror\marg{value}} - Sets up a transformation that mirrors along a horizontal line that goes through point $(0, \text{\meta{value})}$. -\end{command} +\switchcolumn*% < + +\begin{command}{\pgfqtransformmirror\marg{point A}} + Sets up a transformation that mirrors along the line that goes through the origin and \meta{point A}. -\begin{command}{\pgftransformMirror\marg{point A}\marg{point B}} - Sets up a transformation that mirrors along the line that goes through \meta{point A} and \meta{point B}. - \begin{codeexample}[preamble=\usepgflibrary{transformations.mirror}] \begin{tikzpicture} -\draw[help lines] (-.25, -2.25) grid (2.5, 1.25); +\draw[help lines] (-.25, -.25) grid (2.25, 1.25); \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); -\draw[dashed] (0, -1) -- (2, 0); -\pgftransformMirror{\pgfpointxy{0}{-1}}{\pgfpointxy{2}{0}} +\draw[dashed] (0, 0) -- (2, 1); +\pgfqtransformmirror{\pgfpointxy{2}{1}} \draw[-latex] (0,0) .. controls (.5,1) .. (1,1); \end{tikzpicture} \end{codeexample} \end{command} +\switchcolumn + \begin{command}{\pgfqtransformMirror\marg{point A}} Sets up a transformation that mirrors along the line that goes through the origin and \meta{point A}. @@ -154,4 +171,5 @@ The commands are named the same as above, only the |m| in |mirror| is capitalize \end{codeexample} \end{command} -\endinput
\ No newline at end of file +\end{paracol} +\endinput diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual.pdf b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual.pdf Binary files differindex 57ce1debf8..7879c7cd9b 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual.pdf +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual.pdf diff --git a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual.tex b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual.tex index 1b9754d629..2375904d80 100644 --- a/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual.tex +++ b/graphics/pgf/contrib/tikz-ext/doc/tikz-ext-manual.tex @@ -14,18 +14,20 @@ \input{tikz-ext-manual-en-main-preamble.tex} \usetikzlibrary{external} -\newif\iftikzextmanualexternalize -\tikzextmanualexternalizetrue -\iftikzextmanualexternalize +%\newif\iftikzextmanualexternalize +%\tikzextmanualexternalizetrue +%\iftikzextmanualexternalize \tikzexternalize[ - prefix=doc/tikz/, - mode=graphics if exists, + prefix=tikz/, +% prefix=../../tikz-extensions-tikz/, +% mode=convert with system call, %mode=list and make, %mode=list only,export=true,% simply skips EVERY picture -> good for debugging the text. ] + \tikzexternalenable \tikzifexternalizing{% \pgfkeys{/pdflinks/codeexample links=false}% }{}% -\fi +%\fi \input{tikz-ext-manual-en-main-body.tex} |