Open main menu

Gramps β

Changes

Addon:GenealogyTree

6,118 bytes added, 23:12, 10 November 2025
no edit summary
{{Third-party pluginaddon}}{{languages|Addon:GenealogyTree}} 
[[File:Menu-trees-gramps50.png|450px|right|thumb|Main menu showing all four reports for Addon:GenealogyTree]]
 The "'''GenealogyTree" ''' addon uses creates professional looking trees for the active person in the [[Addon:GenealogyTree#Prerequisites|LaTeX genealogytree (the Pedigree and genealogical tree diagrams package)]] to create professional looking trees for the active personfile format. Four The following reports are available:
* {{man label|[[Addon:GenealogyTree#Ancestor_tree|Ancestor Tree]]}}
* {{man label|[[Addon:GenealogyTree#Descendant_tree|Descendant Tree]]}}
== Usage ==
From the menu select {{man menu|Reports > Trees > [Xxxxx] Tree...}} where [Xxxxx] is one of the available reports.
 
{{man tip|For a large family tree|Make sure to select a large enough paper size in the {{man label|Paper Options}} tab as the reports [[Addon:GenealogyTree#Issues|currently]] do not scale well.}}
 
 
* Output is to {{man label|[https://www.latex-project.org/ LaTeX File]}}(<code>*.tex</code>) by default. This format is generally intended for print production and may not be suitable for ''viewing'' the resulting tree chart. Installing an [[Addon:GenealogyTree#Prerequisites|additional program]] to automatically convert to a <code>.pdf</code> format file is highly recommended.
 
See [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_4#Common_options|Common options]]
From the menu select {{man menu|Reports > Trees > [Xxxxx] Tree...}} where [Xxxxx] is one of the available reports.<!--
== Features =Legend to Symbols===##found on page 230 of GenealogyTree documentation pdf##Legend to symbols used on chart.
* Creates professional looking family trees for = born, (*) born out of wedlock, +* = stillborn, *+ = died on the active person.* Output is only to <code>tex</code> or <code>pdf</code> files.birthday,
{{stub}}-->
== Tree examples ==
===Descendant tree===
[[File:xxxGenealogyTree-Addon-descendant-example-50.png|450px|right|thumb|Descendant tree - example for Addon:GenealogyTree]]
Creates a tree chart showing the descendants of the active person.
===Grandparent tree===
[[File:xxxGenealogyTree-grandparent-example-50.png|450px|right|thumb|Grandparent tree - example for Addon:GenealogyTree]]Creates a Grandparent tree for the selected person.
{{-}}
 
===Sandclock tree===
[[File:xxxGenealogyTree-Addon-sandclock-example-51.png|450px|right|thumb|Sandclock tree - example for Addon:GenealogyTree]]Creates a Sandclock tree for the selected person. A sandclock connects ancestors and descendants starting from a single proband (active person).
{{-}}
===Sandclock Tree for a Family===
[[File:xxxGenealogyTree-Addon-sandclock_family-example-51.png|450px|right|thumb|Sandclock Tree for a Family - example for Addon:GenealogyTree]]Creates a Sandclock tree for the selected family.
{{-}}
== Prerequisites ==
Before any of these reports can be used Output is only to {{man label|[[Output_formats#LaTeX|LaTex]] File}} (<code>*.tex</code>) which by default is displayed as plain text with layout annotation in the preferred Text viewing application for your OS unless you have installed a LaTex helper application. The following prerequisite "helper" applications will need interpret the layout annotation to view the following prerequisites installedfully formatted LaTex(*.tex) file or automatically convert it to a <code>pdf</code> file:* [https://www.tug.org/texlive/ texlive] including the <code>textlive-pictures </code> package which contains [https://ctan.org/pkg/genealogytree LaTeX genealogytree] (the Pedigree and genealogical tree diagrams package) The <code>texlive-pictures</code> package contains <code>genealogytree</code>.
The <code>texlive-pictures fonts-extra</code> package contains genealogytreeis required for non-latin fonts.
The texlive-fontsextra package is required See specific instructions for non-latin fontsyour operating system.* [[Addon:GenealogyTree#Linux|Linux]]* [[Addon:GenealogyTree#Apple MacOS|Apple MacOS]]* [[Addon:GenealogyTree#Microsoft Windows|Microsoft Windows]]
===Linux===
 
====Debian/Ubuntu====
 
* TeX support, at least 'texlive-base', 'texlive-binaries', 'tex-common', 'luatex' packages
* for internal PDF output file format needs LaTex support (e.g., 'texlive-latex-base' package)
* for genealogytree needs 'texlive-pictures' package
or download and install '[https://www.ctan.org/pkg/genealogytree genealogytree]' for the last version:
 
<code>$ mkdir -p ~/texmf/tex/latex/genealogytree</code>
or ''/var/lib/texmf'', ''/usr/local/share/texmf''
 
<code>$ cp ./genealogytree/* ~/texmf/tex/latex/genealogytree</code>
 
<code>$ texhash ~/texmf</code>
 
Same for '[https://www.ctan.org/pkg/tcolorbox tcolorbox]', and maybe
for fonts : '[https://www.ctan.org/pkg/libertine libertines]', '[https://www.ctan.org/pkg/mweights mweights], etc ...
 
<code>$ cp ~/texmf/tex/latex/libertine/map/libertine.map ~/.texmf-var/fonts/map/pdftex/updmap/pdftex.map</code>
 
<code>$ updmap --enable Map=~/texmf/tex/latex/libertine/map/libertine.map</code>
 
<code>$ sudo mktexlsr</code>
 
<code>$ sudo updmap-sys --enable Map=~/texmf/tex/latex/libertine/map/libertine.map</code>
 
* need 'texlive-latex-extra' (for xkeyval) and 'latex-tools' (for [https://github.com/T-F-S/csvsimple/issues/1 shellesc]) or install the base [http://mirrors.ctan.org/macros/latex/base.zip]!
* can also update '[https://www.ctan.org/pkg/pdftexcmds pdftexcmds]' and '[https://www.ctan.org/pkg/pgf pgf]'
 
{{stub}}
 
===Apple MacOS===
Install the MacTeX distribution.
* https://www.tug.org/mactex/
{{stub}}
 
===Microsoft Windows===
Quick instruction how You can enable automatic output to enable PDF on Microsoft Windows as by default these reports only output to the LaTeX(".tex" extension) file type which are not suitable for viewing. For our Microsoft Windows TeX/LaTeX environment you will use [https://miktex.org/ MiKTeX] we only need to download the basic installer from:* https://miktex.org/download/ Start the MiKTeX installer and during install:* select {{man label|[ ]Install MiKTeX only for me(YOURUSERNAME)}} * and change {{man label|Install missing packages on -the-fly}} to ''Yes''after successful installation of MiKTeX do the following once only: Start the [https://www.howtogeek.com/235101/10-ways-to-open-the-command-prompt-in-windows-10/ Microsoft Windowscommand console prompt] (cmd.exe) and type:
Install it and run, create one of several type of reports in {{man menu|Reports<code>lualatex --version</code>Trees}} menu.
Make sure If that works then you are ready to select large enough paper size have MiKTex install the additional missing packages, start Gramps and create a one of the {{man menu|Reports > Trees > [Xxxxx] Tree...}} reports and for the LaTeX(".tex" extension). Now in options as these report currently don't scale wellthe Microsoft Windows command console prompt (cmd.exe) type:
You can output PDF(".pdf" extension) and LaTeX(".tex" extension) type files for the reports.<code>lualatex FILENAME</code>
As our Microsoft Windows TeXwhere FILENAME is full pathname of <code>.tex</LaTeX environment code> file you will use MiKTeX(from https://miktexpreviously create in Gramps.org/ ) The MiKTeX program environment package manager will then automatically download the missing packages. When all is pretty large so we download finished pdf file will be created in directory in which you start this command, along with two other files of the basic installation same name but with different extensions (190MB in size*.log) from https://miktexand (*.org/download/ctan/systems/win32/miktex/setup/basic-miktex-2.9.6520-x64aux) which you can ignore.exe
Start If everything goes well you will now have an additional {{man label|Output format:}} option in Gramps to output the MiKTeX installer and during install select reports to the PDF("install for me only.pdf" extension) format and "Install missing packages on-the-fly"builtin LaTex(*.tex) format.
After successful installation of The last optional step is from the Windows StartMenu run the {{man label|MiKTeX Console}} and in {{man label|Settings}} change {{man label|[ ]Always install missing packages on-the-fly}} settings to {{man label|[ ]Ask me}}(it can take some timerecommended) start or {{man label|[ ]Never install missing packages on-the Windows command console (cmd-fly}}.exe) and type: lualatex FILENAME
where FILENAME is full pathname of .tex file you previously create in Gramps{{man tip|PDF's created automatically with lualatex|are output to the PDF Version 1. MiKTeX package manager will automatically download missing packages5 (Acrobat 6. When all is finished pdf file will be created in directory in 0)format which you start this command. I recommend then that you run has a maximum PDF page size of 200"MiKTeX Settingsx 200" from Windows StartMenu and change "on-inches (508cm x 508cm) so choose your custom paper sizes accordingly or Gramps will show the{{man label|[[Gramps_{{man version}}_Wiki_Manual_-fly" settings to "No" or "Always ask"_Error_and_Warning_Reference#Report_could_not_be_created|Report could not be created]]}} dialog}}
If everything goes well you will now have option in Gramps to create such ==See also==* Feature request {{bug|10223}} LaTeX genealogytree reports in both * https://github.com/gramps-project/gramps/blob/master/gramps/gen/plug/docgen/treedoc.py (creates the *.tex file and checks for the presence of lualatex.exe on Windows or lualatex on Linux )*[https://sourceforge.net/p/gramps/mailman/message/36223716/ Original instructions for installing PDF output support for Microsoft Windows]* [https://ctan.org/pkg/genealogytree LaTeX genealogytree] (the Pedigree and genealogical tree diagrams package) - By Prof. Dr. Dr. Thomas F. Sturm, [http://mirrors.ctan.org/macros/latex /contrib/genealogytree/genealogytree.pdf documentation] & examples ([https://github.com/T-F-S/genealogytree github])- CTAN(Comprehensive TeX Archive Network) - Pedigree and pdf formatgenealogical tree diagrams are proven tools to visualize genetic and relational connections between individuals. The naming (“tree”) derives from historical family diagrams. However, even the smallest family entity consisting of two parents and several children is hardly a ‘mathematical’ tree — it is a more general graph. The package provides a set of tools to typeset genealogical trees (i.e., to typeset a set of special graphs for the description of family-like structures). The package uses an autolayout algorithm which can be customized, e.g., to prioritize certain paths.* Questions tagged [https://tex.stackexchange.com/questions/tagged/genealogytree genealogytree] on tex.stackexchange.com
'''Discussions on Gramps community support forum (Instructions based on Discourse)'''* [https://sourceforgegramps.netdiscourse.group/pt/grampsrecurring-people-not-visible-on-exported-descendant-graph/mailman4328/message/36223716/ )5 rendering of cousins marrying] and [[Addon:Family_Tree|Family Tree]] addon report as an alternative.
== Issues ==
See issues tagged with [https://gramps-project.org/bugs/tag_view_page.php?tag_id=294 GenealogyTree] on the bugtracker.
* The diagram doesn't scale to fit the page. For a large tree you will have to select a large paper size.
** Only the smallest value on Paper size item will be used
** {{bug|10512}}Sandclock tree generates one page of (possibly) a larger report
* {{bug|10494}} LaTeX report includes full images uncropped
* Help button url does not come here.
* No support for localized month names
* If you install only one of the reports the rest are installed also!
See also[[Category:* Feature request {{bug|10223}} LaTeX genealogytree reportsAddons]]
[[Category:Plugins]]
[[Category:Developers/General]]
[[Category:Prerequisites|G]]
15,091
edits