diff options
author | Karl Berry <karl@freefriends.org> | 2016-07-14 21:39:25 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2016-07-14 21:39:25 +0000 |
commit | d8177aef8ca941d4ac68c7002d67e411025a03e2 (patch) | |
tree | e4b6e299fea15c764c89b731dd2b55d3fedcb750 /Master/texmf-dist/doc | |
parent | 71d433e6039c736a93e0dfeb0e90d058ddc6fc60 (diff) |
binarytree (14jul16)
git-svn-id: svn://tug.org/texlive/trunk@41694 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
11 files changed, 133 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/binarytree/README b/Master/texmf-dist/doc/latex/binarytree/README new file mode 100644 index 00000000000..3cc69561cba --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/README @@ -0,0 +1,51 @@ +Package 'binarytree' for LaTeX: Draw binary trees with TikZ. + +========================== LICENCE ========================= +Copyright (C) 2016 by Aleksandrina Nikolova +<aayla.secura.1138@gmail.comaayla.secura.1138@gmail.com> + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either +version 1.3 of this license or (at your option) any later +version. The latest version of this license is in: + http://www.latex-project.org/lppl.txt +and version 1.3 or later is part of all distributions of +LaTeX version 2005/12/01 or later. + +=========================== ABOUT ========================== +The 'binarytree' package provides an easy but flexible way to draw binary trees using TikZ. It provides a macro \BinaryTree which takes two arguments: a path specification and a number indicating the maximum depth of the tree. The path specification and the setting of various options determine the style for each edge of the tree. The options can be set either by passing them as an optional argument to \BinaryTree, or by calling \btreeset. + +There is support for the external library of TikZ which does not affect externalization of the rest of the TikZ figures in the document (externalization is enabled locally for each \BinaryTree). There is an option to use automatic file naming: this is useful if the trees are often moved around or new ones are added in between, in which case using the default naming will cause all of them to be rebuilt. Instead, giving a unique name to each tree will have TikZ use the already compiled image no matter where in the document it is or how many times it has been used. This feature is still in its very infancy and more control over how the file name is generated is planned for the future. + +======================= INSTALLATION ======================= +Extract all of the files and run latex on binarytree.ins: + latex binarytree.ins + +Move the generated binarytree.sty into a TeX searchable directory, for example on Linux: + mkdir -p <TeX folder>/tex/latex/binarytree + mv binarytree.sty <TeX folder>/tex/latex/binarytree +for example the local user TeX directory is in 'C:\Documents and Settings\<user name>\texmf' on Windows, '~/texmf' on Linux or '~/Library/texmf' on OS X. + +If you wish to (re)create the documentation: + pdflatex binarytree.dtx + pdflatex binarytree.dtx + makeindex -s gglo.ist -o binarytree.gls binarytree.glo + makeindex -s gind.ist -o binarytree.ind binarytree.idx + pdflatex binarytree.dtx + pdflatex binarytree.dtx + +========================== TESTING ========================= +Provided are four files to test the package (also included as examples in the documentation: +* 'examples/binarytree-ex1.tex' draws two trees, names them as nodes and uses them in a simple graph. To recompile it, simply run: + pdflatex examples/binarytree-ex1.tex +* 'examples/binarytree-ex2.tex' draws 4 identically structured trees using different level and sibling distance scalings. To recompile it, simply run: + pdflatex examples/binarytree-ex2.tex +* 'examples/binarytree-ex3.tex' draws a square with arrows on each side! To recompile it, simply run: + pdflatex examples/binarytree-ex3.tex +* 'examples/binarytree-ex4.tex' draws a similar square twice and exports them using the external library. It uses the 'list and make' mode, so it generates 'examples/binarytree-ex4.figlist' and 'examples/binarytree-ex4.makefile', requiring manual compilation of the exported figure: + pdflatex examples/binarytree-ex4.tex + make -f examples/binarytree-ex4.makefile + pdflatex examples/binarytree-ex4.tex + +========================== CHANGES ========================= +v1.0 First published version of the 'binarytree' package
\ No newline at end of file diff --git a/Master/texmf-dist/doc/latex/binarytree/binarytree.pdf b/Master/texmf-dist/doc/latex/binarytree/binarytree.pdf Binary files differnew file mode 100644 index 00000000000..3c3498728bf --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/binarytree.pdf diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex1.pdf b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex1.pdf Binary files differnew file mode 100644 index 00000000000..886beb31500 --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex1.pdf diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex1.tex b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex1.tex new file mode 100644 index 00000000000..64a1bf3dc35 --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex1.tex @@ -0,0 +1,16 @@ +\documentclass{standalone} +\usepackage{binarytree} +\usetikzlibrary{graphs} + +\begin{document} +\btreeset{math labels,scale=0.7} +\begin{tikzpicture} + \BinaryTree[local bounding box=INIT]{% + :1!l:w!r:x:red!l:\sigma,ll!l:\sigma,lr!r:\sigma, + r:w!r:y!r:\sigma,rr!l:\sigma,rl!l:\sigma}{3} + \BinaryTree[local bounding box=FINAL,xshift=10cm]{ + :1!l:w!l:x':red!l:\sigma,lr!r:\sigma,ll!r:\sigma, + r:w!r:y!r:\sigma,rr!l:\sigma,rl!l:\sigma}{3} + \graph[use existing nodes]{ INIT -> FINAL}; +\end{tikzpicture} +\end{document} diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex2.pdf b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex2.pdf Binary files differnew file mode 100644 index 00000000000..2785a68ce2a --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex2.pdf diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex2.tex b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex2.tex new file mode 100644 index 00000000000..4c7b07fd49b --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex2.tex @@ -0,0 +1,22 @@ +\documentclass{standalone} +\usepackage{binarytree} + +\begin{document} +\btreeset{% + draw missing,% + separate,% + level distance scales=false,% + sibling distance scales=false,% + scale=0.5} + +\def\arraystretch{1.5} +\begin{tabular}{cc} + none scales & both scale \\ + \BinaryTree{}{3} & + \BinaryTree[yscale=1.7,level distance scales,% + sibling distance scales]{}{3} \\ + level distance scales & sibling distance scales \\ + \BinaryTree[yscale=1.7,level distance scales]{r}{3} & + \BinaryTree[sibling distance scales]{}{3} +\end{tabular} +\end{document} diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex3.pdf b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex3.pdf Binary files differnew file mode 100644 index 00000000000..ea1ebb79bd4 --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex3.pdf diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex3.tex b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex3.tex new file mode 100644 index 00000000000..8d8d765cb94 --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex3.tex @@ -0,0 +1,16 @@ +\documentclass{standalone} +\usepackage{binarytree} + +\begin{document} +\btreeset{% + math labels,% + separate,% + level distance scales=false,% + sibling distance scales=false,% + continue after turn=false,% + continue at path end=false,% + left label anchor=center,% + right label anchor=center} + +\BinaryTree{l:\nwarrow!r:\nearrow,r:\nearrow!l:\nwarrow}{3} +\end{document} diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex4.pdf b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex4.pdf Binary files differnew file mode 100644 index 00000000000..0cfc20a4c74 --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex4.pdf diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex4.tex b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex4.tex new file mode 100644 index 00000000000..77ed55bb5e6 --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/binarytree-ex4.tex @@ -0,0 +1,28 @@ +\documentclass{standalone} +\usepackage{binarytree} +\usetikzlibrary{external} +\tikzexternalize +\tikzexternaldisable + +\begin{document} +\btreesetexternal{% + use automatic file name,% + mode=list and make} +\btreeset{% + top padding=0pt,% + left padding=0pt,% + right padding=0pt,% + bottom padding=0pt,% + external=false,separate=true,% + label on every edge,% + left label anchor=center,% + right label anchor=center,% + continue after turn=false,% + continue at path end=false,% + level distance scales=false,% + sibling distance scales=false,% + scale=0.7} + +\BinaryTree{lrr:x,llrr:x,rll:x,rrll:x}{5}% +\BinaryTree{lrr:x,llrr:x,rll:x,rrll:x}{5} +\end{document} diff --git a/Master/texmf-dist/doc/latex/binarytree/examples/btree-5_up_0,0,0_3729359_7458719_655360_0.7_0.7_-lrr-x--_-llrr-x--_-rll-x--_-rrll-x--.pdf b/Master/texmf-dist/doc/latex/binarytree/examples/btree-5_up_0,0,0_3729359_7458719_655360_0.7_0.7_-lrr-x--_-llrr-x--_-rll-x--_-rrll-x--.pdf Binary files differnew file mode 100644 index 00000000000..b29870f4645 --- /dev/null +++ b/Master/texmf-dist/doc/latex/binarytree/examples/btree-5_up_0,0,0_3729359_7458719_655360_0.7_0.7_-lrr-x--_-llrr-x--_-rll-x--_-rrll-x--.pdf |