path: root/Master/texmf-dist/doc/latex/forest-quickstart/ForestQuickstart.tex

\documentclass[12pt]{article}
\usepackage[T1]{fontenc}
\usepackage[utf8]{inputenc}
\usepackage{tipa} %phonetic symbols
%\usepackage{ulem}
\usepackage{multirow}
\usepackage[authoryear]{natbib}
\usepackage[dutch,english]{babel}
\usepackage{enumitem}
\usepackage{varioref} 
\usepackage{amssymb}
\usepackage{textcomp}
\usepackage{subscript} 
\usepackage{xyling} % for trees
\usepackage{stmaryrd}
\usepackage{framed}
\usepackage{listings}
\usepackage{multicol}
\usepackage[normalem]{ulem}
\usepackage{gentium}
\usepackage[colorlinks]{hyperref}
\usepackage[linguistics]{forest}
\usepackage{linguex} %for linguistic example numbers
\setlist{nolistsep} %reduce space between items in lists
\renewcommand{\firstrefdash}{} %no dash in example references eg (3a) not (3-a)
\bibpunct[:]{(}{)}{,}{a}{}{,}

\title{Forest Quickstart Guide for Linguists}
\author{Guido Vanden Wyngaerd\\
guido.vandenwyngaerd@kuleuven.be}

\begin{document}

\maketitle

\section{Introduction}

\texttt{Forest} is a package for drawing linguistic trees developed by \href{http://spj.ff.uni-lj.si/zivanovic/}{Sašo Živanović}. This manual provides a quickstart guide for linguists with just the essential things that you need to get started. More extensive documentation is available from the \href{https://www.ctan.org/pkg/forest}{CTAN-archive}. \texttt{Forest} is based on the TikZ package; more information about its commands, in particular those controlling the appearance of the nodes, the arrows, and the highlighting can be found in the \href{https://sourceforge.net/projects/pgf/}{TikZ documentation}.

\section{Loading Forest}

In your preamble, put \begin{verbatim}
\usepackage[linguistics]{forest}\end{verbatim}
The \texttt{linguistics} option makes for nice trees, in which the branches meet above the two nodes that they join; it will also align the example number (provided by \texttt{linguex}) with the top of the tree:

\ex.\label{1}
\begin{forest}
[CP [C] 
	[IP [I] 
		[VP [V]
			[NP]  
		] 
	] 
]
\end{forest}


\section{Basic Usage}

\texttt{Forest} uses a familiar labelled brackets syntax. The code below will output the tree in \Last above (\verb|\ex.| requires the \texttt{linguex} package and provides the example number):

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
[CP[C][IP[I][VP[V][NP]]]]
\end{forest}
\end{lstlisting}
\texttt{Forest} will parse the above code without problem, but you will soon get lost in your labelled brackets with more complicated trees if you write the code this way. The better alternative is to arrange the nodes over multiple lines:

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
[CP 
	[C] 
	[IP 
		[I]
		[VP [V] [NP]]
	] 
]
\end{forest}
\end{lstlisting}
One important caveat: be careful not to insert any empty lines in your code, as \texttt{forest} will not be able to parse those.

\texttt{Forest} automatically positions nodes in the tree depending on their internal complexity, i.e. the material that they dominate, as shown in the following example. Notice in particular how the horizontal spacing between the nodes varies according to what the nodes dominate.

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
[TP
	[NP
		[Det [whatever]]
		[N$'$
			[N [material]] [PP]
		]
	] 
	[T$'$
		[T [might] ] 
		[AgrP [\ldots]] 
	]
]
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
[TP
	[NP
		[Det [whatever]]
		[N$'$
			[N [material]] [PP]
		]
	] 
	[T$'$
		[T [might] ] 
		[AgrP [\ldots]] 
	]
]
\end{forest}


\section{Adjusting node spacing}

Although \texttt{forest} will arrange the nodes in the tree for you, you can still adjust both the horizontal and the vertical spacing, and the empty space around the nodes. The horizontal spacing is controlled by the \texttt{s sep} command, the vertical (or level) spacing by the \texttt{l} command. The \texttt{inner sep} command controls the empty space around the nodes. 

You can specify absolute values for these parameters, as in the example below, or increase or decrease their default values as calculated by \texttt{forest}. This is done either by multiplication (e.g. \texttt{l*=3} multiplies the default by 3), or by addition or subtraction (e.g. \texttt{l+=3mm} adds 3mm to the default, \texttt{l-=3mm} subtracts 3mm). 

These parameters can be applied globally, to the entire tree, as follows:

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP 
	[C] 
	[IP 
		[I] 
		[VP [V] [NP]] 
	] 
]
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP [C] 
	[IP [I] 
		[VP [V] [NP]  
		] 
	] 
]
\end{forest}

This tree has wider horizontal spacing, less level distance, and less empty space around the nodes than the tree in \ref{1}.

The commands that adjust horizontal and vertical spacing can also be applied locally, either to a single node, or to all the nodes dominated by a node (i.e. a subtree). Applying the parameter to a single node is done by putting a comma after the node label and then issuing the relevant command.

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP, s sep=20mm 
	[C] 
	[IP 
		[I]
		[VP [V]]]]
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP, s sep=20mm [C] 
	[IP [I] 
		[VP [V]] 
	] 
]
\end{forest}

In \Last, the daughters of the CP node get an increased horizontal spacing; the setting at the CP node overrides the global setting for the rest of the tree. You can also apply the setting to a subtree by applying the \texttt{for tree} command  to a particular node:

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP 
	[C] 
	[IP, for tree={s sep=20mm} 
		[I] 
		[VP [V] [NP]] 
	] 
]
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP 
	[C] 
	[IP, for tree={s sep=20mm} [I] 
		[VP [V] [NP]] 
	] 
]
\end{forest}

Here increased horizontal distance has been applied to the subtree dominated by IP.

In order to produce a slanted rather than a vertical line under a nonbranching node, you can insert a phantom node. A phantom node has no label; the \texttt{phantom} command tells \texttt{forest} not to draw a line to this phantom node, as in the example below. Without the phantom node, a vertical line would connect CP to IP: 

\pagebreak
\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP	[,phantom]
	[IP
		[NP] [VP] 
	] 
]
\end{forest}
\end{lstlisting}

\ex.
\begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP	[,phantom]
	[IP
		[NP] [VP] 
	] 
]
\end{forest}

\section{Triangles}

Triangles are easy to produce with the \texttt{roof} command, which you put before the closing bracket of the node that you want a triangle above.

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP [C] 
	[IP
		[NP [the woman, roof]]
		[I$'$ [I] 
			[VP [walked the dog, roof]] 
		] 
	]
]
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP 
	[C] 
	[IP
		[NP [the woman, roof]]
		[I$'$ [I] 
			[VP [walked the dog, roof]] 
		] 
	]
]
\end{forest}

Sometimes you may want to reduce the width of a triangle in order to get a more balanced tree. This is easily done by putting a double backslash before the terminals that you want to move to a line below:

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP 
	[C] 
	[IP
		[NP [the woman, roof]]
		[I$'$ [I] 
			[VP [walked \\ the dog, roof]] 
		]
	]
]
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP 
	[C] 
	[IP
		[NP [the woman, roof]]
		[I$'$
			[I] 
			[VP [walked \\ the dog, roof]] 
		] 
	]
]
\end{forest}

\clearpage
\section{Horizontal alignment of terminals}

You can align all the terminals horizontally with the \texttt{tier=word} command.

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP 
	[C [that, tier=word]] 
	[IP
		[NP [the woman, roof, tier=word]]
		[I$'$ 
			[I [\textsc{pst}, tier=word]] 
			[VP [walk the dog, roof, tier=word]] 
		] 
	]
]
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP [C [that, tier=word]] 
	[IP
		[NP [the woman, roof, tier=word]]
		[I$'$ [I [\textsc{pst}, tier=word]] 
			[VP [walk the dog, roof, tier=word]] 
		] 
	]
]
\end{forest}

\section{Arrows}

Arrows are drawn using the \verb|\draw| command. This command takes two arguments, which specify the source and the target of the movement, respectively. The source and the target are defined by giving a name to the relevant nodes in the tree with the \texttt{name} command. In the example below, the target is named \texttt{tgt}, and the source \texttt{src}. The \verb|\draw| command tells \texttt{forest} to draw a line from \texttt{src} to \texttt{tgt}. Place the command following the final closing bracket of your tree.

The optional argument of \texttt{draw} is used to specify the placement of the arrow (up \texttt{[->]}, or down \texttt{[<-]}, both \texttt{[<->]}, or none \texttt{[-]}), and the line style (e.g. \texttt{dotted}). You can also specify where exactly at the source and target nodes the line should start and end by specifying this as an option with the \texttt{to} command; this is done using the option setting \texttt{south} for the bottom of the node, \texttt{north} for the top, \texttt{south west} for bottom left, etc.

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex.\begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP
	[DP,name=tgt] 	
	[IP
		[,phantom] 
		[VP
			[DP] 
			[V$'$ [V] [\sout{DP},name=src]]
		]
	]
]
\draw[->] (src) to[out=south west,in=south] (tgt);
\end{forest}
\end{lstlisting}

\ex.\begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP
	[DP,name=tgt] 	
	[IP [,phantom] 
		[VP
			[DP] [V$'$
				[V]
				[\sout{DP},name=src]]
		]
	]
]
\draw[->] (src) to[out=south west,in=south] (tgt);
\end{forest}

Do not forget the semicolon at the end of the \verb|\draw| command. Note that the \verb|\sout| command (to produce strikeout in the moved DP) requires the following line in your preamble: \verb|\usepackage[normalem]{ulem}|.

The settings of the \texttt{in} and \texttt{out} options allow you to control the placement of  arrows. This is shown in \Next, where the arrow appears at the right hand side of the tree. 

\pagebreak
\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex.\begin{forest} 
for tree={s sep=10mm, inner sep=0, l=0}
[CP	
	[IP [,phantom]
		[VP 
			[DP] 
			[V$'$ [V] [\sout{DP},name=src]]]]
	[DP,name=tgt]]
\draw[->] (src) to[out=north east,in=south east] (tgt);
\end{forest}
\end{lstlisting}

\ex.\begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP	
	[IP [,phantom] 
		[VP
			[DP] [V$'$
				[V]
				[\sout{DP},name=src]]
		]
	]
	[DP,name=tgt] 
]
\draw[->] (src) to[out=north east,in=south east] (tgt);
\end{forest}


\section{Highlighting}

The simplest type of highlighting of individual nodes is done by applying formatting (like bold or italic) to the node labels. Fancier forms of highlighting are achieved with the \texttt{draw} command, as in the following example:

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest} 
for tree={s sep=10mm, inner sep=1mm, l=0}
[VP,circle,draw,fill=lightgray 
	[\textbf{DP}] 
	[V$'$ 
		[V] 
		[DP,draw,red]
	]
]
\end{forest}
\end{lstlisting}

\ex. \begin{forest} 
for tree={s sep=10mm, inner sep=1mm, l=0}
[VP,circle,draw,fill=lightgray 
	[\textbf{DP}] [V$'$ 
		[V] [DP,draw,red] ]]
\end{forest}

A subtree can be highlighted as follows:

\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0mm, l=0}
[CP
	[XP] [IP
		[DP$_1$] 
		[VP,tikz={\node [draw,fit to=tree]{};}
			[t$_1$] 
			[V$'$
				[V] 
				[DP$_2$] 
			]
		]
	]
]
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[CP
	[XP] [IP
		[DP$_1$] [VP,tikz={\node [draw,fit to=tree]{};}
			[t$_1$] [V$'$
				[V] [DP$_2$] ]]]]
\end{forest}
 	
Other types of highlighting include annotations near nodes in the tree, as in \Next below. In this case, the \verb|\draw| command is put following the closing bracket of the node where you want the annotation to appear, and the entire command needs to be enclosed within \verb|{ }|. The option \texttt{node[right]} controls whether the annotation appears to the left or the right of the node. The option \texttt{(.west)} controls the point of attachment or anchor of the annotation.


\begin{lstlisting}[basicstyle=\ttfamily,basewidth=0.5em]
\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0, l=0}
[NegP [Neg] 
{\draw (.west) node[left]{\textit{negation} $\Leftarrow$}; }
	[QP]
] 
{ \draw (.east) node[right]{$\Rightarrow$ \textit{adjective}}; }
\end{forest}
\end{lstlisting}

\ex. \begin{forest}
for tree={s sep=10mm, inner sep=0}
[NegP [Neg] { \draw (.west) node[left]{\textit{negation} $\Leftarrow$}; }
	[QP]
] { \draw (.east) node[right]{$\Rightarrow$ \textit{adjective}}; }
\end{forest}

Notice how \texttt{forest} automatically moves the entire tree to the right to make room for the annotation on the left side of the tree.

\end{document}