Debian Codegraph @

texmf-dist/doc/latex/gtrlib-largetrees/README.md

raw
1 The gtrlib.largetrees Package
2 =======================
3
4 Copyright (C) 2015-2018 Richard Grewe
5
6 Released under the [LaTeX Project Public License](http://www.latex-project.org/lppl/) version 1.2 or later
7
8 ## Purpose
9
10 The main goal of the `gtrlib.largetrees` package is to offer
11 additional database fields and formats for the `genealogytree`
12 package, particularly for typesetting large trees.
13 This package is the side product of typesetting an actual genealogy tree
14 with almost 400 persons on 16 levels and on a DIN-A0 poster.
15
16 ## Availability
17
18 The `gtrlib.largetrees` package is on [github](https://github.com/Ri-Ga/gtrlib.largetrees).
19
20 ## Manual Installation
21
22 The `gtrlib.largetrees` package comes with (at least) the following files
23 * gtrlib.largetrees.ins
24 * gtrlib.largetrees.dtx
25 * README.md
26
27 and possibly also with
28 * Makefile
29 * gtrlib.largetrees.pdf (generated from gtrlib.largetrees.dtx)
30 * gtrlib.largetrees.sty (generated from gtrlib.largetrees.dtx)
31 * gtrlib.largetrees.code.tex (generated from gtrlib.largetrees.dtx)
32
33 To install the `gtrlib.largetrees` package, you additionally need
34 * docstrip.tex
35
36 To build the package (`gtrlib.largetrees.sty`) as well as the library
37 for the genealogytree package (`gtrlib.largetrees.code.tex`),
38 run one of the following
39 ```
40 latex gtrlib.largetrees.ins
41 make package (needs Makefile)
42 ```
43
44 Put the resulting `gtrlib.largetrees.sty` and `gtrlib.largetrees.code.tex`
45 somewhere where LaTeX can find it.
46 Read the documentation of your LaTeX system to find out where this
47 might be.
48
49 ## Building Documentation
50
51 To build the documentation of the `gtrlib.largetrees` package, you
52 need the following dependencies of the package itself
53 * etoolbox
54 * genealogytree
55
56 and additionally need the following classes and packages:
57 * ltxdoc
58 * idxlayout
59 * enumitem
60 * biblatex
61 * filecontents
62 * showexpl
63 * pbox
64 * hypdoc
65 * cleveref
66
67 as well as the tools
68 * pdflatex
69 * biber
70 * makeindex
71
72 To build the documentation (`gtrlib.largetrees.pdf`), either run
73 ```
74 make docs
75 ```
76 or the following sequence of commands
77 ```
78 pdflatex gtrlib.largetrees.dtx
79 biber gtrlib.largetrees
80 makeindex -s gind.ist -o gtrlib.largetrees.ind gtrlib.largetrees.idx
81 makeindex -s gglo.ist -o gtrlib.largetrees.gls gtrlib.largetrees.glo
82 pdflatex gtrlib.largetrees.dtx
83 pdflatex gtrlib.largetrees.dtx
84 ```
85
86
87 Happy TeX'ing