summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/tikz-qtree
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-12-24 18:43:43 +0000
committerKarl Berry <karl@freefriends.org>2009-12-24 18:43:43 +0000
commitfe52c4d4865ceba78cbad065cc6595ffd0423800 (patch)
tree0123274db309eb900bfce0dbeeb66c406740c6bf /Master/texmf-dist/doc/latex/tikz-qtree
parent6a8a6fa9af6af314e192d593ec496d112f909ff8 (diff)
new package tikz-qtree (23dec09)
git-svn-id: svn://tug.org/texlive/trunk@16498 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/tikz-qtree')
-rw-r--r--Master/texmf-dist/doc/latex/tikz-qtree/README30
-rw-r--r--Master/texmf-dist/doc/latex/tikz-qtree/tikz-qtree-manual.pdfbin0 -> 107819 bytes
-rw-r--r--Master/texmf-dist/doc/latex/tikz-qtree/tikz-qtree-manual.tex297
3 files changed, 327 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/tikz-qtree/README b/Master/texmf-dist/doc/latex/tikz-qtree/README
new file mode 100644
index 00000000000..6d1fa677a8f
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tikz-qtree/README
@@ -0,0 +1,30 @@
+tikztree
+David Chiang <chiang at isi dot edu>
+Version 1 (22 Dec 2009)
+
+This package provides a macro for drawing trees with TikZ using the
+easy syntax of Alexis Dimitriadis' Qtree. It improves on TikZ's
+standard tree-drawing facility by laying out tree nodes without
+collisions; it improves on Qtree by adding lots of features from TikZ
+(for example, edge labels, arrows between nodes); and it improves on
+pst-qtree in being usable with pdfTeX and XeTeX.
+
+Please see tikztree-manual.pdf for instructions and examples.
+
+-----
+
+Copyright (C) 2002, 2009 by David Chiang
+
+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
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
diff --git a/Master/texmf-dist/doc/latex/tikz-qtree/tikz-qtree-manual.pdf b/Master/texmf-dist/doc/latex/tikz-qtree/tikz-qtree-manual.pdf
new file mode 100644
index 00000000000..8cbca53ce45
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tikz-qtree/tikz-qtree-manual.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/tikz-qtree/tikz-qtree-manual.tex b/Master/texmf-dist/doc/latex/tikz-qtree/tikz-qtree-manual.tex
new file mode 100644
index 00000000000..46c795fb1c7
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tikz-qtree/tikz-qtree-manual.tex
@@ -0,0 +1,297 @@
+\documentclass{article}
+
+\usepackage{xltxtra,fontspec}
+\setmainfont[Mapping=tex-text]{DejaVu Serif}
+\setmonofont[Scale=0.95]{DejaVu Sans Mono}
+\newfontfamily\verbfont[Scale=0.8]{DejaVu Sans Mono}
+\newfontfamily\ar[Script=Arabic]{DejaVu Sans}
+\newfontfamily\ja{VL Gothic}
+\newfontfamily\javerbfont[Scale=0.85,LetterSpace=5.0]{VL Gothic}
+
+\usepackage{tikz}
+\usepackage{tikz-qtree}
+
+\usepackage{fullpage}
+
+\usepackage{fancyvrb,fvrb-ex}
+\fvset{gobble=0,xleftmargin=0.5in,xrightmargin=2.75in,formatcom=\verbfont}
+\VerbatimFootnotes
+
+\newcommand\tikztree{\texttt{tikz-qtree}}
+
+\title{\tikztree: better trees with TikZ}
+\author{David Chiang}
+\date{Version 1 (22 Dec 2009)}
+
+\begin{document}
+
+\maketitle
+
+The \tikztree{} package provides a macro for drawing trees with
+TikZ\footnote{\texttt{http://sourceforge.net/projects/pgf/}} using the
+easy syntax of Alexis Dimitriadis'
+Qtree\footnote{\texttt{http://www.ling.upenn.edu/advice/latex/qtree/}}. It
+improves on TikZ's standard tree-drawing facility by laying out tree
+nodes without collisions; it improves on Qtree by adding lots of
+features from TikZ; and it improves on \verb|pst-qtree| in being
+usable with pdf\TeX{} and
+\XeTeX{}.
+
+\section{Basics}
+
+To load the package in \LaTeX{}:
+\begin{Verbatim}
+\usepackage{tikz}
+\usepackage{tikz-qtree}
+\end{Verbatim}
+%
+The simplest usage is identical to Qtree:
+\begin{center}
+\begin{SideBySideExample}
+\Tree [.S [.NP [.Det the ] [.N cat ] ]
+ [.VP [.V sat ]
+ [.PP [.P on ]
+ [.NP [.Det the ] [.N mat ] ] ] ] ]
+\end{SideBySideExample}
+\end{center}
+Subtrees are delimited by square brackets. A subtree's root label is
+joined by a dot (\verb|.|) to its opening bracket.\footnote{You can
+also write the label after the closing bracket instead of the opening
+bracket, or both, or neither. Please see the Qtree documentation for
+details.} As in Qtree, spaces are required after every (internal or
+leaf) node label.
+
+\verb|\Tree| works inside or outside a
+\verb|tikzpicture| environment, but many of the features described
+below require the explicit \verb|tikzpicture| environment.
+
+\goodbreak
+
+\paragraph{Options} Some options for standard TikZ trees work for \verb|\Tree| as
+well:
+\begin{itemize}
+\item \verb|level distance|: vertical distance between the anchors of a parent and child
+\item \verb|sibling distance|: horizontal distance between the boundaries of sister subtrees (not the anchors of their roots, as in standard TikZ trees). Note that TikZ nodes already have some horizontal space around them (\verb|inner xsep|, by default \verb|0.3333em|), so even \verb|sibling distance=0pt| leaves some room.
+\item \verb|grow=up| or \verb|down|: trees grow up or down from their root. Other directions are not currently supported. The \verb|grow'| option is the same, but children appear clockwise with respect to their parent instead of counterclockwise.
+\end{itemize}
+These are set either by writing
+\verb|\tikzset{|\textit{option}\verb|=|\textit{value}\verb|}| or by
+writing \verb|[|\textit{option}\verb|=|\textit{value}\verb|]| after a
+\verb|\begin{tikzpicture}| or \verb|\begin{scope}|.\footnote{Allowing
+options after \verb|\Tree| would have made sense, but there would be
+no way to disambiguate the two uses of square brackets.} For example:
+
+\begin{center}
+\begin{SideBySideExample}
+\begin{tikzpicture}
+\tikzset{level distance=72pt}
+\Tree [.NP [.Adj tall ] [.N tree ] ]
+\end{tikzpicture}
+%
+\begin{tikzpicture}[grow'=up]
+\Tree [.NP [.Adj upside-down ] [.N tree ] ]
+\end{tikzpicture}
+\end{SideBySideExample}
+\end{center}
+
+\paragraph{Styles} TikZ lets you define \emph{styles}\/ which encapsulate multiple options:
+\begin{Verbatim}
+\tikzset{small/.style={level distance=20pt,sibling distance=0pt}}
+\end{Verbatim}
+Then the option \verb|small| causes the options in its definition to be used:
+\begin{center}
+\tikzset{small/.style={level distance=20pt,sibling distance=0pt}}
+\begin{SideBySideExample}
+\begin{tikzpicture}[small]
+\Tree [.NP [.Adj small ] [.N tree ] ]
+\end{tikzpicture}
+%
+\begin{tikzpicture}
+\Tree [.NP [.Adj normal ] [.N tree ] ]
+\end{tikzpicture}
+\end{SideBySideExample}
+\end{center}
+The following TikZ styles are automatically applied inside trees,
+providing a hook for you to change the appearance of particular kinds
+of tree parts:
+\begin{itemize}
+\item \verb|every tree node| to every (internal and leaf) node (default: \verb|anchor=base|)
+\item \verb|every internal node| to every internal node
+\item \verb|every leaf node| to every leaf node
+\item \verb|edge from parent| to every edge (default: \verb|draw|)
+\end{itemize}
+
+The options for nodes and edges are all handled by TikZ and are
+described in detail in the TikZ documentation. For example, if you
+have a font named \verb|\ar| and want to set all the leaf labels in
+this font:
+\begin{center}
+\begin{SideBySideExample}
+\begin{tikzpicture}
+\tikzset{grow'=down}
+\tikzset{every leaf node/.style={font=\ar}}
+\Tree [.S [.NP القط ]
+ [.VP [.V وجلس ]
+ [.PP [.P على ] [.NP حصيرة ] ] ] ]
+\end{tikzpicture}
+\end{SideBySideExample}
+\end{center}
+If you want the edges to be darker:
+\begin{center}
+\begin{SideBySideExample}
+\tikzset{edge from parent/.style={draw,thick}}
+\Tree [.S [.NP [.Det the ] [.N cat ] ]
+ [.VP [.V sat ]
+ [.PP [.P on ]
+ [.NP [.Det the ] [.N mat ] ] ] ] ]
+\end{SideBySideExample}
+\end{center}
+The \verb|draw| option is necessary, as by default they will not be
+drawn. As a more complex example, edges have an
+\verb|edge from parent path| option which lets you change the shape of
+the edge. Its value is a TikZ path expressed in terms of
+\verb|\tikzparentnode|, the parent node, and \verb|\tikzchildnode|,
+the child node.
+\begin{center}
+\begin{SideBySideExample}
+\tikzset{edge from parent/.style=
+ {draw,
+ edge from parent path={(\tikzparentnode.south)
+ -- +(0,-8pt)
+ -| (\tikzchildnode)}}}
+\Tree [.S [.NP [.Det the ] [.N cat ] ]
+ [.VP [.V sat ]
+ [.PP [.P on ]
+ [.NP [.Det the ] [.N mat ] ] ] ] ]
+\end{SideBySideExample}
+\end{center}
+
+\clearpage
+
+\section{Embedding TikZ nodes}
+
+Inside a \verb|\Tree|, in place of a node label, you can use a TikZ
+\verb|\node| command.\footnote{\verb|\Tree| specifically watches out
+for the token \verb|\node|; do not use \verb|\path node| or other
+equivalents.}
+\begin{quote}
+\verb|\node [|\textit{options}\verb|] (|\textit{name}\verb|) {|\textit{label}\verb|};|
+\end{quote}
+Don't forget the terminating semicolon. The
+\verb|[|\textit{options}\verb|]|, which are optional, let you change
+the appearance of the node; for example, the \verb|draw| option draws
+a border around the node. The \verb|(|\textit{name}\verb|)|, which is
+also optional, can be used for drawing lines/arrows to/from the node.
+\begin{center}
+\tikzset{>=latex}
+\begin{Example}
+\begin{tikzpicture}
+\Tree [.CP [.NP \node(wh){what}; ]
+ [.C$'$ [.I did ]
+ [.\node[draw]{IP};
+ [.NP [.Det the ] [.N cat ] ]
+ [.VP [.V sit ]
+ [.PP [.P on ]
+ [.\node[draw]{NP};
+ [.NP [.Det a ] [.N book ] ]
+ [.PP [.P about ] [.NP \node(t){$t$}; ] ] ] ] ] ] ] ]
+\draw[semithick,->] (t)..controls +(south west:5) and +(south:5) .. (wh);
+\end{tikzpicture}
+\end{Example}
+\end{center}
+
+\clearpage
+
+\noindent Another example for machine translation people:
+\begin{center}
+\fvset{formatcom=\javerbfont}
+\begin{SideBySideExample}
+\begin{tikzpicture}
+\Tree [.S [.NP [.Det \node(e1){the}; ]
+ [.N \node(e2){cat}; ] ]
+ [.VP [.V \node(e3){sat}; ]
+ [.PP [.P \node(e4){on}; ]
+ [.NP [.Det \node(e5){the}; ]
+ [.N \node(e6){mat}; ] ] ] ] ]
+
+\begin{scope}[yshift=-5in,grow'=up]
+\tikzset{every leaf node/.style={font=\ja}}
+\Tree [.S [.NP \node(j1){猫が}; ]
+ [.VP [.PP [.NP [.NP \node(j2){マット}; ]
+ [.Part \node(j3){の}; ]
+ [.NP \node(j4){上}; ] ]
+ [.P \node(j5){に}; ] ]
+ [.V \node(j6){土}; ] ] ]
+\end{scope}
+
+\begin{scope}[dashed]
+\draw (e1)--(j1);
+\draw (e2)--(j1);
+\draw (e3)..controls +(south:5) and +(north:4)..(j6);
+\draw (e4)--(j4);
+\draw (e4)--(j5);
+\draw (e5)--(j2);
+\draw (e6)--(j2);
+\end{scope}
+
+\end{tikzpicture}
+\end{SideBySideExample}
+\end{center}
+
+\section{Explicit edges}
+
+The edge from a parent to a child node is normally automatically drawn
+for you, but you can do it yourself with an \verb|\edge| command
+\emph{before}\/ the corresponding child node. It is similar to the
+TikZ \verb|edge from parent| command.\footnote{Except that a TikZ
+\texttt{edge from parent} comes after the child node. I thought it was
+more logical to put it before.}
+\begin{quote}
+\verb|\edge [|\textit{options}\verb|];|
+\end{quote}
+Again, don't forget the semicolon. The
+\verb|[|\textit{options}\verb|]|, which are optional, let you change
+the appearance of the edge. You can also add an edge label:
+\begin{quote}
+\verb|\edge [|\textit{options}\verb|] node [|\textit{options}\verb|] {|\textit{label}\verb|};|
+\end{quote}
+Typically one will use the \verb|auto| option for edge labels, which
+places the label to the side of the edge.
+\begin{center}
+\begin{SideBySideExample}[xrightmargin=1.25in]
+\newcommand{\initial}[1]{\ensuremath{\alpha_{\textrm{\scriptsize #1}}}}
+\newcommand{\auxiliary}[1]{\ensuremath{\beta_{\textrm{\scriptsize #1}}}}
+
+\begin{tikzpicture}[level distance=36pt,sibling distance=12pt]
+\Tree [.\initial{sat}
+ \edge node[auto=right]{1}; \initial{cat}
+ \edge[dashed] node[auto=left]{2};
+ [.\auxiliary{on}
+ \edge node[auto=left]{2}; \initial{mat} ] ]
+\end{tikzpicture}
+\end{SideBySideExample}
+\end{center}
+The fact that \verb|auto=left| draws a label on the right and
+\verb|auto=right| draws a label on the left makes sense if you think
+about the tree growing from the root to the leaves.
+
+There is a predefined style that draws a ``roof'' over a node, like Qtree's \verb|\qroof|:
+\begin{center}
+\begin{Example}
+\begin{tikzpicture}[level distance=36pt]
+\Tree [.S [.NP [.N this ] ]
+ [.VP [.V is ]
+ [.NP \edge[roof]; {a noun phrase
+ the complexity of which
+ is too great for me to parse} ] ] ]
+\end{tikzpicture}
+\end{Example}
+\end{center}
+
+\section*{Acknowledgements}
+This was all Dan Gildea's idea.
+
+\section*{Contact}
+Please send suggestions to \verb|chiang@isi.edu|.
+
+\end{document}