tikz-timing (21dec17)

git-svn-id: svn://tug.org/texlive/trunk@46111 c570f23f-e606-0410-a88d-b1316a301751

1 files changed, 64 insertions, 8 deletions

diff --git a/Master/texmf-dist/source/latex/tikz-timing/tikz-timing.dtx b/Master/texmf-dist/source/latex/tikz-timing/tikz-timing.dtx
index add0b335868..f972865720e 100644
--- a/Master/texmf-dist/source/latex/tikz-timing/tikz-timing.dtx
+++ b/Master/texmf-dist/source/latex/tikz-timing/tikz-timing.dtx
@@ -24,10 +24,10 @@
 %<*driver>
 \ProvidesFile{tikz-timing.dtx}[%
 %<=*DATE>
-    2017/12/10
+    2017/12/20
 %<=/DATE>
 %<=*VERSION>
-    v0.7e
+    v0.7f
 %<=/VERSION>
     DTX-File of 'tikz-timing' package.]
 \newif\ifprintversion % \fi
@@ -547,7 +547,9 @@
 %     \end{itemize}
 % \end{Changes}
 % \changes{v0.7d}{2011/01/09}{Fix for end macro of extracode environment to support etoolbox's environment hooks.}
+% \changes{v0.7e}{2017/12/10}{Fixed advnodes library to support current PGF version.}
 % \changes{v0.7e}{2017/12/10}{Documentation update: added usage as float with caption due to user request.}
+% \changes{v0.7f}{2017/12/20}{Documentation update: added description of several existing styles.}
 %
 %
 % \endgroup
@@ -991,7 +993,11 @@
 % \subsection*{Scaling the Table}
 % The standard "scale" setting of TikZ will not scale all parts of the table correctly,
 % \eg the line width and nodes will keep their original size. However there are scaled
-% relative to the font size. Alternatively the table can be scaled using the
+% relative to the font size (which needs to be set using \texttt{timing/font}).
+% If the timing diagrams should be scaled the keys \texttt{timing/unit}, \texttt{timing/xunit} and/or
+% \texttt{timing/yunit} can be used.
+%
+% Alternatively the table can be scaled using the
 % \cs{scalebox}\marg{factor}\marg{content} macro from the \pkg{graphicx} package or
 % be placed inside a scaled \cs{node} inside another \env{tikzpicture} environment.
 %
@@ -1126,7 +1132,7 @@
 % \end{figure}
 %
 % \clearpage
-% \section{Macros for use inside the Character String}
+% \section{Macros for use inside the Character String}\label{sec:maccharstr}
 % The modifiers "@" and `\texttt{\$}' allow the user to include macros.  These
 % macros are evaluated when the |tikz-timing| parser encounters them in the
 % input character string, \ie before any diagram element is drawn or any single
@@ -1357,13 +1363,16 @@
 % using `|.append style=|\meta{value}'.
 %
 % Settings are TikZ keys which await an argument and set an internal macro or length. They are
-% like \cs{setlength} and \cs{renewcommand}. They should not be redefined by the user.
+% like \cs{setlength} and \cs{renewcommand}. They should only by used as stated and not be redefined like styles as
+% shown above.
 %
 % Action are TikZ keys which perform a drawing or other action on the current element, either directly or
 % by en-/disable an internal setting which then in turn triggers the drawing process. Therefore some
 % actions can be globally and/or locally but others only make sense if used locally on a single |tikz-timing|
 % macro or environment or even a scope inside a \env{tikztimingtable}.
 % Action can be very similar to settings but they always execute code instead of only setting/redefining it.
+% The actions are defined and can be redefined using
+% \css{tikzset}|{|\meta{action name}|/.code=|\meta{code}|}|%
 %
 % \begingroup
 % \def\C{Action}
@@ -1381,10 +1390,32 @@
 %     timing/intext                              & \S & Used for \cs{texttiming}. Depends on \texttt{timing}.\\
 %     timing/picture                             & \S & Usable for own \texttt{tikzpictures} to set timing settings.\\
 %     timing/inline node                         & \S & Used for nodes created by the \texttt{N} character. Defaults to \texttt{coordinate}.\\
+%     timing/every char                          & \S & Used in the \cs{draw} TikZ command for every drawn timing character.\\
+%     timing/every bg                            & \S & Used for every background path of characters like \texttt{D}.\\
+%     timing/text format=\meta{code}             & \s & Sets formatting code for the text of characters like \texttt{D}. The code is placed directly for the text wrapped in braces, so that the code can be a macro awaiting the text as an argument. By default the code is empty.\\
 %     \midrule
 %     timing/initchar=\meta{char}                & \s & Sets initial character.  Only valid as first optional argument in table rows or in \cs{texttiming}.\\
 %     \midrule
-%     timing/metachar=\marg{C}\oarg{\#arg}\marg{G}& \C& Sets meta-character \meta{C} to character group \meta{G}.\\
+%     timing/metachar=\marg{C}\oarg{\#arg}\marg{G}& \s& Sets meta-character \meta{C} to character group \meta{G}.\\
+%     \midrule
+%     timing/before                              & \C & Code executed direct before the timing TikZ code inside the internal
+%     \cs{tikzpicture}. \\
+%     timing/after                               & \C & Code executed direct after the timing TikZ code inside the internal
+%     \cs{tikzpicture}.\\
+%     \bottomrule
+%   \end{tabularx}
+%
+% \section*{Scaling}
+%   \begin{tabularx}{\textwidth}{>{\ttfamily}ll>{\raggedright\arraybackslash}X}
+%     \toprule
+%     \normalfont TikZ Key      & Type & Description \\
+%     \midrule
+%     timing/unit=\meta{length expression}        & \s & Sets both the x- and y-unitlength. \\
+%     timing/xunit=\meta{length expression}        & \s & Sets the x-unitlength (\texttt{\textbackslash xunit}) for the timing diagrams.  \\
+%     timing/yunit=\meta{length expression}        & \s & Sets the y-unitlength (\texttt{\textbackslash yunit}) for the timing diagrams.  \\
+%     timing/font=\meta{code}         & \s & Can be used to set font macros. Needs to be used instead of the normal TikZ \texttt{font} as it resets \texttt{unit}
+%     etc.\ if it is font sized dependent.\\
+%     timing/wscale=\meta{math expression} & \s & Sets the width-scale \texttt{\textbackslash wscale} by calling \texttt{\textbackslash tikztimingsetwscale}. See section~\ref{sec:maccharstr} for further details. \\
 %     \bottomrule
 %   \end{tabularx}
 %
@@ -1408,6 +1439,13 @@
 %     timing/outer sep=\meta{dim}                & \s & Sets outer separation around \cs{texttiming} macros. \\
 %     timing/outer xsep=\meta{dim}               & \s & See above. Only X-Coordinate. (Default:~0pt) \\
 %     timing/outer ysep=\meta{dim}               & \s & See above. Only Y-Coordinate. (Default:~0pt) \\
+%     \midrule
+%     timing/before text                         & \C & Code executed direct before the timing TikZ code inside the internal
+%     \cs{tikzpicture} for \cs{texttiming}. This code is executed just after the \texttt{timing/before} code. Defaults
+%     to \cs{texttimingbefore}.\\
+%     timing/after text                          & \C & Code executed direct after the timing TikZ code inside the internal
+%     \cs{tikzpicture}. This code is executed just before the \texttt{timing/after} code. Defaults to
+%     \cs{texttimingafter}.\\
 %     \bottomrule
 %   \end{tabularx}
 %
@@ -1427,17 +1465,23 @@
 %     \toprule
 %     \normalfont TikZ Key      & Type & Description \\
 %     \midrule
+%     timing/name                                & \S & Used for the signal name column in \env{tikztimingtable}.\\
 %     timing/table                               & \S & Used for \env{tikztimingtable}. Depends on \texttt{timing}.\\
 %     timing/table/grid                          & \S & Used for table grid. Depends on \texttt{timing/grid}.\\
 %     timing/table/lines                         & \S & Used for \cs{horlines} and \cs{vertlines}. \\
 %     timing/table/rules                         & \S & Used for \cs{tablerules} for top and bottom lines. \\
 %     timing/table/midrules                      & \S & Used for \cs{tablerules} between table head and body.  \\
-%     timing/table/header                        & \S & Used for \cs{tableheader}. \\
-%     timing/table/title header                  & \S & Used for label header in \cs{tableheader}. \\
+%     timing/table/header                        & \S & Used for \cs{tableheader}. Defaults to \texttt{timing/name}.\\
+%     timing/table/label header                  & \S & Used for label header in \cs{tableheader}. \\
 %     timing/table/row header                    & \S & Used for timing row header in \cs{tableheader}. \\
 %     \midrule
 %     timing/rowdist=\meta{distance}             & \s & Sets (baseline) distance between rows in a tikztimingtable. Default: 2 (=$2\times$signal height)\\
 %     timing/coldist=\meta{distance}             & \s & Sets distance between columns in a tikztimingtable. Default: 1 (=$1\times$period width)\\
+%     \midrule
+%     timing/before table                         & \C & Code placed before the tables TikZ code inside the internal
+%     \texttt{tikzpicture}.\\
+%     timing/after table                         & \C & Code placed after the tables TikZ code at the end of the
+%     internal \texttt{tikzpicture}.\\
 %     \bottomrule
 %   \end{tabularx}
 %
@@ -1472,6 +1516,18 @@
 %     \bottomrule
 %   \end{tabularx}
 %
+% \section*{Other}
+%   \begin{tabularx}{\textwidth}{>{\ttfamily}ll>{\raggedright\arraybackslash}X}
+%     \toprule
+%     \normalfont TikZ Key      & Type & Description \\
+%     \midrule
+%     timing/expand count=\meta{integer}         & \s & Sets the maximum expand count for the underlying
+%     \texttt{tikzpicture}.  TikZ only expands the content this number of times. The TikZ default value
+%     of 100 is to small for timing diagrams and is changed to 1000 by default. This should be raised
+%     (only) if TikZ throws an to-many-expands error.\\
+%     \bottomrule
+%   \end{tabularx}
+%
 % \endgroup
 %
 % \clearpage