Debian Codegraph @

texmf-dist/doc/latex/binarytree/README

raw
1 Package 'binarytree' for LaTeX: Draw binary trees with TikZ.
2
3 ========================== LICENCE =========================
4 Copyright (C) 2016 by Aleksandrina Nikolova
5 <[email protected]@gmail.com>
6
7 This work may be distributed and/or modified under the
8 conditions of the LaTeX Project Public License, either
9 version 1.3 of this license or (at your option) any later
10 version. The latest version of this license is in:
11 http://www.latex-project.org/lppl.txt
12 and version 1.3 or later is part of all distributions of
13 LaTeX version 2005/12/01 or later.
14
15 =========================== ABOUT ==========================
16 The 'binarytree' package provides an easy but flexible way
17 to draw binary trees using TikZ. It provides a macro
18 \BinaryTree which takes two arguments: a path specification
19 and a number indicating the maximum depth of the tree. The
20 path specification and the setting of various options
21 determine the style for each edge of the tree. The options
22 can be set either by passing them as an optional argument to
23 \BinaryTree, or by calling \btreeset.
24
25 There is support for the external library of TikZ which does
26 not affect externalization of the rest of the TikZ figures
27 in the document (externalization is enabled locally for each
28 \BinaryTree). There is an option to use automatic file
29 naming: this is useful if the trees are often moved around
30 or new ones are added in between, in which case using the
31 default naming will cause all of them to be rebuilt.
32 Instead, giving a unique name to each tree will have TikZ
33 use the already compiled image no matter where in the
34 document it is or how many times it has been used. This
35 feature is still in its very infancy and more control over
36 how the file name is generated is planned for the future.
37
38 ======================= INSTALLATION =======================
39 Extract all of the files and run latex on binarytree.ins:
40 latex binarytree.ins
41
42 Move the generated binarytree.sty into a TeX searchable
43 directory, for example on Linux:
44 mkdir -p <TeX folder>/tex/latex/binarytree
45 mv binarytree.sty <TeX folder>/tex/latex/binarytree
46 The local user TeX directory is in
47 'C:\Documents and Settings\<user name>\texmf' on Windows,
48 '~/texmf' on Linux or '~/Library/texmf' on OS X.
49
50 If you wish to (re)create the documentation:
51 pdflatex binarytree.dtx
52 pdflatex binarytree.dtx
53 makeindex -s gglo.ist -o binarytree.gls binarytree.glo
54 makeindex -s gind.ist -o binarytree.ind binarytree.idx
55 pdflatex binarytree.dtx
56 pdflatex binarytree.dtx
57
58 ========================== TESTING =========================
59 Provided are four files to test the package (also included
60 as examples in the documentation:
61 * 'examples/binarytree-ex1.tex' draws two trees, names them
62 as nodes and uses them in a simple graph. To recompile it,
63 simply run:
64 pdflatex examples/binarytree-ex1.tex
65 * 'examples/binarytree-ex2.tex' draws 4 identically
66 structured trees using different level and sibling
67 distance scalings. To recompile it, simply run:
68 pdflatex examples/binarytree-ex2.tex
69 * 'examples/binarytree-ex3.tex' draws a square with arrows
70 on each side! To recompile it, simply run:
71 pdflatex examples/binarytree-ex3.tex
72 * 'examples/binarytree-ex4.tex' draws a similar square twice
73 and exports them using the external library. It uses the
74 'list and make' mode, so it generates
75 'examples/binarytree-ex4.figlist' and
76 'examples/binarytree-ex4.makefile', requiring manual
77 compilation of the exported figure:
78 pdflatex examples/binarytree-ex4.tex
79 make -f examples/binarytree-ex4.makefile
80 pdflatex examples/binarytree-ex4.tex
81
82 ========================== CHANGES =========================
83 v1.0 First published version of the 'binarytree' package