summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-11-20 21:50:34 +0000
committerKarl Berry <karl@freefriends.org>2018-11-20 21:50:34 +0000
commitb770ac87eac01c038c8933df77490016f4265514 (patch)
tree6d3942c51925d0bdb0d4419a222aa606a479c67f /Master/texmf-dist/doc
parentfbb567638ba8f9cda1f8079bd3111b74ab356738 (diff)
tikz-cd (20nov18)
git-svn-id: svn://tug.org/texlive/trunk@49201 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
-rw-r--r--Master/texmf-dist/doc/latex/tikz-cd/README13
-rw-r--r--Master/texmf-dist/doc/latex/tikz-cd/README.md16
-rw-r--r--Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.pdfbin341186 -> 266756 bytes
-rw-r--r--Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex65
4 files changed, 63 insertions, 31 deletions
diff --git a/Master/texmf-dist/doc/latex/tikz-cd/README b/Master/texmf-dist/doc/latex/tikz-cd/README
deleted file mode 100644
index 9f7eee20ada..00000000000
--- a/Master/texmf-dist/doc/latex/tikz-cd/README
+++ /dev/null
@@ -1,13 +0,0 @@
-tikz-cd -- Commutative diagrams with tikz
-=========================================
-
-The general-purpose drawing package tikz can be used to typeset
-commutative diagrams and other kinds of mathematical pictures,
-generating high-quality results. The present package facilitates the
-creation of such diagrams by providing a convenient set of macros and
-reasonable default settings. It also includes an arrow tip library
-closely matching the Computer Modern arrow tips, as well as a general
-mechanism to use the arrow tips from any math font in TikZ graphics.
-
-This software is distributed under the GNU General Public License,
-version 3 or later.
diff --git a/Master/texmf-dist/doc/latex/tikz-cd/README.md b/Master/texmf-dist/doc/latex/tikz-cd/README.md
new file mode 100644
index 00000000000..b988d1dc069
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tikz-cd/README.md
@@ -0,0 +1,16 @@
+tikz-cd — Commutative diagrams with TikZ
+========================================
+
+The general-purpose drawing package [TikZ][pgf] can be used to typeset
+commutative diagrams and other kinds of mathematical pictures,
+generating high-quality results. This TikZ library facilitates the
+creation of such diagrams by providing a convenient set of macros and
+reasonable default settings. It can be used in plain TeX, LaTeX and
+ConTeXt. See [the manual][tikz-cd-doc] for further details and many
+examples.
+
+This software is distributed under the terms of the GNU General Public
+License, version 3 or later.
+
+[pgf]: https://ctan.org/pkg/pgf
+[tikz-cd-doc]: http://mirrors.ctan.org/graphics/pgf/contrib/tikz-cd/tikz-cd-doc.pdf
diff --git a/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.pdf b/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.pdf
index f1d5a3a68cf..e4f8c8d40d0 100644
--- a/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.pdf
+++ b/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex b/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex
index 3fa1f0b9c14..b2e6cd6652e 100644
--- a/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex
+++ b/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex
@@ -1,4 +1,4 @@
-% Copyright 2011, 2012, 2014 by Florêncio Neves <florencioneves@gmail.com>
+% Copyright 2011, 2012, 2014, 2018 by Augusto Stoffel
%
% This program is free software: you can redistribute it and/or modify
% it under the terms of the GNU General Public License as published by
@@ -23,6 +23,7 @@
\def\pgfautoxrefs{1}
\documentclass[a4paper]{ltxdoc}
+\usepackage[hyphens]{url}
\def\xcolorversion{2.00}
@@ -178,7 +179,7 @@ directory}{}}
{\Large\bfseries Commutative diagrams with \tikzname}
\vspace{1em}
-{Version 0.9e \qquad October 30, 2014}
+{Version 0.9f \qquad November 19, 2018}
\end{center}
\vspace{1.5em}
@@ -215,7 +216,7 @@ To invoke this package in \LaTeX, type
\begin{verse}
\index{tikz-cd@\protect\texttt{tikz-cd} package}%
\index{Packages and files!tikz-cd@\protect\texttt{tikz-cd}}%
- |\usepackage{tikz-cd}|
+ |\usepackage{tikz-cd}|%
\end{verse}
or load \tikzname{} and then type
\begin{verse}%
@@ -636,10 +637,10 @@ it.
\begin{verse}
|/tikz/commutative diagrams/row sep/|\meta{size}
\end{verse}
-stores a
- \meta{value}, then it is read and |/tikz/row sep|=\meta{value} is
- set. If the key above is not initialized, then \meta{size} is
- presumably a dimension, and |/tikz/row sep|=\meta{size} is set.
+ stores a \meta{value}, then it is read and
+ |/tikz/row sep|=\meta{value} is set. If the key above is not
+ initialized, then \meta{size} is presumed to be a dimension, and
+ |/tikz/row sep|=\meta{size} is set.
The initially available sizes, and their values, are
the following:
@@ -706,13 +707,10 @@ Section \ref*{pgfman-section-matrices}.3.2 of the \pgfname{} manual
cells, which is appropriate for large, displayed diagrams. The
present style removes some of this extra white space, and is
intended for smaller diagrams that should blend with the surrounding
- text, or very wide material that wouldn't fit on the page otherwise.
+ text, or very wide material that wouldn't fit the page otherwise.
\end{stylekey}
-Keep in mind that while there are some legitimate uses for |{tikzcd}|
-diagrams on inline formulas, standard \LaTeX\ constructs such as
-|\overset| and |\xrigthtarrow| are often sufficient and should be
-preferred. The picture below shows the (somewhat subtle) difference
+The picture below shows the (somewhat subtle) difference
between the cramped and the non-cramped styles.
\begin{codeexample}[pre=\minipage{6cm},post=\endminipage]
@@ -721,6 +719,11 @@ This \begin{tikzcd}[cramped, sep=small] A \arrow[r] & B \end{tikzcd} is a crampe
This $A \to B$ is just a formula.
\end{codeexample}
+Keep in mind that while there are some legitimate uses for |{tikzcd}|
+diagrams on inline formulas, standard \LaTeX\ constructs such as
+|\overset| and |\xrigthtarrow| are often sufficient and should be
+preferred.
+
\begin{key}{/tikz/commutative diagrams/math mode=\meta{boolean}
(default true)}
This key determines whether or not the contents of a diagram are
@@ -821,7 +824,8 @@ Recall that it is possible to give a specific entry of a \tikzname{}
matrix a name by using the \verb!|[!\meta{options}\verb!]|! syntax, as
done for entry $C$ in the example below. You must be careful not to
create nodes whose name contains only the characters |l|, |r|, |u|,
-|d| if you want to refer to them using |from| or |to|.
+|d| if you want to refer to them using |from| or |to|. The following
+illustrates several different uses of these keys.
{\catcode`\|=12
\begin{codeexample}[]
@@ -967,6 +971,21 @@ possible values for \meta{anchor}.
\end{tikzcd}
\end{codeexample}
+\begin{key}{/tikz/commutative diagrams/shorten=\meta{dimension}}
+ This key shortens each end of the arrow by \meta{dimension}.
+
+\begin{codeexample}[]
+\begin{tikzcd}
+ A \arrow[r, shift left]
+ \ar[r, shorten=2mm, shift right]
+ & B
+\end{tikzcd}
+\end{codeexample}
+\end{key}
+
+Note that the ends of an arrow can be shortened individually using
+\tikzname's built-in keys |shorten <| and |shorten >|.
+
\subsection{Three-dimensional diagrams}
\label{sec:crossing-over}
@@ -1027,6 +1046,20 @@ the distance between a label and the corresponding arrow.
This key appends \meta{options} to |every label|.
\end{key}
+\begin{stylekey}{/tikz/commutative diagrams/marking}
+ This style causes the label to be placed over the arrow. It is
+ useful to decorate arrows using ordinary math symbols.
+
+\begin{codeexample}[]
+\begin{tikzcd}
+ A \arrow[r, "/" marking]
+ \arrow[rd, "\circ" marking]
+ & B \\
+ & C
+\end{tikzcd}
+\end{codeexample}
+\end{stylekey}
+
\begin{stylekey}{/tikz/commutative diagrams/description}
This style causes the label to be placed over the arrow, with the
background filled. The clearance around the label is determined by
@@ -1393,10 +1426,6 @@ stem makes certain assumptions about the font design and could fail in
cases where unusual design choices are made.
\begin{thebibliography}{9}
-% \bibitem{knuth}
-% Donald Knuth,
-% \emph{Important message to all users of \TeX}.
-% Available at \url{http://www-cs-staff.stanford.edu/~uno/cm.html}
\bibitem{lenders}
Felix Lenders,
\emph{Commutative diagrams using \tikzname}.
@@ -1407,7 +1436,7 @@ cases where unusual design choices are made.
Available at \url{http://www.jmilne.org/not/CDGuide.html}.
\bibitem{pgfman}
Till Tantau,
- \emph{The \tikzname{} and \pgfname{} packages: Manual for version 3.0.0}.
+ \emph{The \tikzname{} and \pgfname{} packages: Manual for version 3.0.1a}.
Available at \url{http://mirrors.ctan.org/graphics/pgf/base/doc/pgfmanual.pdf}.
\end{thebibliography}