summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-03-09 00:12:30 +0000
committerKarl Berry <karl@freefriends.org>2014-03-09 00:12:30 +0000
commit43a57ed22fe612f300d51efd5fed0ff2d8a7df48 (patch)
tree8a5c1e5e9896f9fd7a1186ea84957480cfdf74a6 /Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex
parentc3d483970e1b19c27183b44654a77ef45f9a1dc6 (diff)
tikz-cd (8mar14)
git-svn-id: svn://tug.org/texlive/trunk@33126 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/tikz-cd/tikz-cd-doc.tex125
1 files changed, 49 insertions, 76 deletions
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 2d0e1b53c2c..0e8e93f2921 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
+% Copyright 2011, 2012, 2014 by FlorĂȘncio Neves <florencioneves@gmail.com>
%
% 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
@@ -126,12 +126,8 @@
inner ysep=0.5cm}
}
-\usepackage{iftex,tikz-cd,xr}
-\ifLuaTeX
- \usepackage{fontspec}
-\else
- \usepackage[utf8]{inputenc}
-\fi
+\usepackage{tikz-cd,xr,multicol,microtype}
+\usepackage[utf8]{inputenc}
\hypersetup{unicode,
pdftitle={The tikz-cd package},
@@ -153,25 +149,11 @@
\title{The \texttt{tikz-cd} package}
\author{FlorĂȘncio Neves}
-\date{Version 0.9, of February 28, 2014}
+\date{Version 0.9b, of March 8, 2014}
\tikzset{/codeexample/every codeexample/.append style={/tikz/commutative diagrams/background color=graphicbackground}}
-\pgfarrowsdeclare{gray x}{gray x}
-{
- \pgfarrowsrightextend{4\pgflinewidth}
-}
-{
- \pgfsetdash{}{0pt}
- \pgfsetlinewidth{0.8\pgflinewidth}
- \pgfsetstrokecolor{gray}
- \pgfpathmoveto{\pgfpoint{5\pgflinewidth}{5\pgflinewidth}}
- \pgfpathlineto{\pgfpoint{-5\pgflinewidth}{-5\pgflinewidth}}
- \pgfusepathqstroke
- \pgfpathmoveto{\pgfpoint{-5\pgflinewidth}{5\pgflinewidth}}
- \pgfpathlineto{\pgfpoint{5\pgflinewidth}{-5\pgflinewidth}}
- \pgfusepathqstroke
-}
+\tikzset{gray x/.tip={Rays[color=gray]}}
\newcommand{\displayarrow}[2][]{%
\index{#2@\protect\texttt{#2} arrow tip}%
@@ -189,8 +171,6 @@
\tikz[baseline=-axis_height, line width=rule_thickness] \draw[arrows=gray
x-gray x,commutative diagrams/.cd, #1] (0,0) -- (0.6,0);}
-\usepackage{multicol,microtype,ellipsis}
-
\begin{document}
\maketitle
@@ -202,8 +182,8 @@ reasonable default settings. Familiarity with Ti\emph{k}Z is helpful
but not necessary, since the examples contained here cover the most
common situations.
-This software is distributed under the GNU General Public License,
-version 3 or later.
+This software is distributed under the terms of the GNU General Public
+License, version 3 or later.
\tableofcontents
@@ -254,7 +234,7 @@ between matrix entries can be created with the |\arrow| command
described below.
Everything inside |{tikzcd}| is typeset in math mode, but you will
-probably want use it inside an |{equation}| environment or |\[| \dots\
+probably want use it inside an |{equation}| environment or |\[| \dots
|\]|, so that the diagram is placed on a new line and centered.
It is important to note that \textsc{dvi} viewers will not display
@@ -322,8 +302,7 @@ of the arrow.
\end{tikzcd}
\end{codeexample}
-We provide one more example, reproduced from the
-X\raisebox{-0.3ex}{Y}-pic user's guide.
+We provide two real-life examples.
\begin{codeexample}[]
\begin{tikzcd}
@@ -338,6 +317,21 @@ X\raisebox{-0.3ex}{Y}-pic user's guide.
\end{tikzcd}
\end{codeexample}
+\begin{codeexample}[]
+\begin{tikzcd}[column sep=tiny]
+ & \pi_1(U_1) \ar[dr] \ar[drr, "j_1", bend left=20]
+ &
+ &[1.5em] \\
+ \pi_1(U_1\cap U_2) \ar[ur, "i_1"] \ar[dr, "i_2"']
+ &
+ & \pi_1(U_1) \ast_{ \pi_1(U_1\cap U_2)} \pi_1(U_2) \ar[r, dashed, "\simeq"]
+ & \pi_1(X) \\
+ & \pi_1(U_2) \ar[ur]\ar[urr, "j_2"', bend right=20]
+ &
+ &
+\end{tikzcd}
+\end{codeexample}
+
\subsection{Changing arrow tips}
\label{sec:changing-arrow-tips}
@@ -374,6 +368,8 @@ style key located in |/tikz/commutative diagrams|).
\displayarrowstyle{maps to}\\
\displayarrowstyle{mapsto}\\
\displayarrowstyle{mapsfrom}\\
+ \displayarrowstyle{Mapsto}\\
+ \displayarrowstyle{Mapsfrom}\\
\end{tabular}
\subsubsection*{Arrows with hook}
@@ -432,18 +428,9 @@ style key located in |/tikz/commutative diagrams|).
\end{tabular}
\end{multicols}
-A gray cross
-(\begin{tikzpicture}[baseline=0pt, yshift=axis_height]
- \pgfsetdash{}{0pt} \pgfsetlinewidth{0.8\pgflinewidth}
- \pgfsetstrokecolor{gray}
- \pgfpathmoveto{\pgfpoint{5\pgflinewidth}{5\pgflinewidth}}
- \pgfpathlineto{\pgfpoint{-5\pgflinewidth}{-5\pgflinewidth}}
- \pgfusepathqstroke
- \pgfpathmoveto{\pgfpoint{-5\pgflinewidth}{5\pgflinewidth}}
- \pgfpathlineto{\pgfpoint{5\pgflinewidth}{-5\pgflinewidth}}
- \pgfusepathqstroke
-\end{tikzpicture}) in the samples above indicates that the corresponding tip
-is kept unchanged. This allows several arrow styles to be superimposed.
+A gray cross (\tikz \path[/pgf/tips=true,gray x-] (0,0) -- (1mm,0);)
+in the samples above indicates that the corresponding tip is kept
+unchanged. This allows several arrow styles to be superimposed.
\begin{codeexample}[]
\begin{tikzcd}
@@ -726,28 +713,21 @@ Section \ref*{pgfman-section-matrices}.3.2 of the \pgfname{} manual
This key appends \meta{options} to the style |every arrow|.
\end{key}
-\begin{key}{/tikz/commutative diagrams/arrow style=\meta{style} (initially Computer Modern)}
+\begin{key}{/tikz/commutative diagrams/arrow style=\meta{style}}
This key determines which collection of arrow tips is used by the
arrow tip selection styles listed in
- \S\ref{sec:changing-arrow-tips}. Currently, \meta{style} can be one
- of the following:
+ \S\ref{sec:changing-arrow-tips}. The initial setting is suitable
+ for documents using the Computer Modern font at any size. The
+ available choices for \meta{style} are:
\begin{description}
- \item[\texttt{Computer Modern}] This is the initial setting and is suitable
- for documents using the Computer Modern font.
- \item[\texttt{Latin Modern}] A small variant of the above, intended
- for documents using the Latin Modern font.
+ \item[\texttt{Latin Modern}] A small variant of the initial
+ settings, intended for documents using the Latin Modern font at
+ any size.
\item[\texttt{math font}] This setting uses the |Glyph| meta arrow
tip described in \S\ref{sec:font-arrow-tips}.
- \item[\texttt{arrows.meta}] This setting uses the arrow tips defined
- in \tikzname's |arrows.meta| library (which has to be loaded
- manually before setting this option). It honors the option
- |/tikz/>|.
\item[\texttt{tikz}] This setting uses the arrow tips defined in
- \tikzname's older \texttt{arrows} library (which has to be loaded
- manually before setting this option). It honors the option
- |/tikz/>|. Unless you have backwards compatibility requirements,
- you should use the \texttt{arrows.meta} option and library
- instead.
+ \tikzname's |arrows.meta| library. It honors the option
+ |/tikz/>|.
\end{description}
\end{key}
@@ -756,15 +736,13 @@ Modern, you may find the best results by selecting the |math font|
style. As detailed in \S\ref{sec:font-arrow-tips}, this is not
guaranteed to work perfectly with all fonts, but gives good results in
many cases. If the \texttt{math font} style gives unsatisfactory
-results, you can try selecting the \texttt{arrows.meta} style, and
-setting |/tikz/>| to the value that best matches your font (among
-those shown in \cite[\S\ref*{pgfman-section-arrows-meta}]{pgfman}).
+results, you can try selecting the \texttt{tikz} style, and setting
+|/tikz/>| to the value that best matches your font (among those shown
+in \cite[\S\ref*{pgfman-section-arrows-meta}]{pgfman}).
\begin{codeexample}[]
-\usetikzlibrary{arrows.meta}
-
\tikzcdset{
- arrow style=arrows.meta,
+ arrow style=tikz,
diagrams={>={Straight Barb[scale=0.8]}}
}
@@ -1173,7 +1151,7 @@ line to your document after all packages have been loaded:
|\def\temp{&} \catcode`&=\active \let&=\temp|
\end{quote}
However, this may interfere in unexpected ways with other
-packages. Use it at your own risk.
+packages. Use this trick at your own risk.
\section{Additional goodies}
\label{sec:general-infra}
@@ -1185,7 +1163,8 @@ its goals. These additional goodies are documented in this section.
\label{sec:asymm-rect-shape}
The following shape is used inside |{tikzcd}| to ensure that arrows
-between nodes in the same row are horizontal.
+between nodes in the same row are perfectly horizontal, even if the
+nodes contain text with different heights and depths.
\begin{shape}{asymmetrical rectangle}
This shape is similar to the |rectangle| shape, but its |center| is
@@ -1254,8 +1233,6 @@ The following arrow tips mimic the Computer Modern designs. It is
useful to know that at size 10\,pt, the Computer Modern arrow stems
are 0.4\,pt thick; for larger font sizes, this parameter should be
scaled accordingly, or replaced by the equivalent figure 0.0928\,ex.
-Two tips that look significantly different in the Latin Modern font
-are also supplied.
Notice that by using the mechanism explained in
\S\ref{sec:changing-arrow-tips}, it is not necessary, and in fact not
@@ -1268,19 +1245,15 @@ inside a |{tikzcd}|.
\displayarrow[/tikz/commutative diagrams/double line]{cm implies}\\
\displayarrow[line width=1.5*rule_thickness]{cm bold to}\\
\displayarrow{cm double to}\\
- \displayarrow{cm left hook}\\
- \displayarrow{cm right hook}\\
+ \displayarrow{cm to reversed}\\
\end{tabular}
\begin{tabular}{ll}
\displayarrow{cm bar}\\
-% \displayarrow{cm o}\\
-% \displayarrow{cm *}\\
\displayarrow{cm left to}\\
\displayarrow{cm right to}\\
- \displayarrow{cm to reversed}\\
- \displayarrow{lm left hook}\\
- \displayarrow{lm bar}\\
+ \displayarrow{cm left hook}\\
+ \displayarrow{cm right hook}\\
\end{tabular}
\end{multicols}
@@ -1380,7 +1353,7 @@ cases where unusual design choices are made.
\bibitem{pgfman}
Till Tantau,
\emph{The \tikzname{} and \pgfname{} packages: Manual for version 3.0.0}.
- Available at \url{http://www.ctan.org/tex-archive/graphics/pgf/base/doc/generic/pgf/pgfmanual.pdf}.
+ Available at \url{http://mirrors.ctan.org/graphics/pgf/base/doc/pgfmanual.pdf}.
\end{thebibliography}
\printindex