Changes

From Gramps

Addon:GenealogyTree

5,629 bytes added, 23:12, 10 November 2025
no edit summary
{{Third-party pluginaddon}} 
[[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. 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.
From {{man tip|For a large family tree|Make sure to select a large enough paper size in the menu select {{man menulabel|Reports > Trees > Paper Options}} tab as the reports [[XxxxxAddon:GenealogyTree#Issues|currently]] Treedo not scale well.}}  * Output is to {{man label|[https://www.latex-project.org/ LaTeX File]}} where (<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 [Xxxxx[Addon:GenealogyTree#Prerequisites|additional program]] to automatically convert to a <code>.pdf</code> format file is one of the available reportshighly recommendedSee [[Gramps_{{man version}}_Wiki_Manual_-_Reports_-_part_4#Common_options|Common options]]
For a large tree you will have to select a large paper size.<!--
== 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 following prerequisites installedlayout annotation to view the fully 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-fontsextra fonts-extra</code> package is required for non-latin fonts. See specific instructions for your operating system.* [[Addon:GenealogyTree#Linux|Linux]]* [[Addon:GenealogyTree#Apple MacOS|Apple MacOS]]* [[Addon:GenealogyTree#Microsoft Windows|Microsoft Windows]]
===Linux===
{{stub}}
====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)* need 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 maybefor 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>$ mkdir -p ~/.texmf/tex/latex/genealogytreesudo mktexlsr</code>or ''/usr/local/share/texlive/texmf-dist/tex/latex/''
<code>$ cp ./genealogytree/* sudo updmap-sys --enable Map=~/.texmf/tex/latex/genealogytreelibertine/map/libertine.map</code>
<code>$ sudo texhash ~* 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.texmf<ctan.org/pkg/code>pgf pgf]'
Same for '[https://www.ctan.org/pkg/tcolorbox tcolorbox]'.{{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 on Windowsonly output to the LaTeX(".tex" extension) file type which are not suitable for viewing.
Install it and run, create one of several type of reports in {{man menu|Reports->Trees}} menuFor 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/
Make sure 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 select large enough paper size in options as these report currently don't scale well.'Yes''after successful installation of MiKTeX do the following once only:
You can output PDFStart the [https://www.howtogeek.com/235101/10-ways-to-open-the-command-prompt-in-windows-10/ Microsoft Windows command console prompt] ("cmd.pdf" extensionexe) and LaTeX(".tex" extension) type files for the reports.:
As our Microsoft Windows TeX/LaTeX environment you will use MiKTeX(from https://miktex.org/ ) The MiKTeX program environment is pretty large so we download the basic installation (190MB in size) from https://miktex.org/download/ctan/systems/win32/miktex/setup/basic<code>lualatex -miktex-2.9.6520-x64.exeversion</code>
Start If that works then you are ready to have MiKTex install the MiKTeX installer additional missing packages, start Gramps and create a one of the {{man menu|Reports > Trees > [Xxxxx] Tree...}} reports and during install select "install for me onlythe LaTeX(" and .tex"Install missing packages on-extension). Now in the-fly"Microsoft Windows command console prompt (cmd.exe) type:
After successful installation of MiKTeX (it can take some time) start the Windows command console (cmd.exe) and type: <code>lualatex FILENAME</code>
where FILENAME is full pathname of <code>.tex </code> file you previously create in Gramps. The MiKTeX package manager will then automatically download the missing packages. When all is finished pdf file will be created in directory in which you start this command, along with two other files of the same name but with different extensions (*.log) and (*. I recommend then that aux) which you run "MiKTeX Settings" from Windows StartMenu and change "on-the-fly" settings to "No" or "Always ask"can ignore.
If everything goes well you will now have an additional {{man label|Output format:}} option in Gramps to create such output the reports in both latex to the PDF(".pdf" extension) format and pdf the builtin LaTex(*.tex) format.
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}}(Instructions based recommended) or {{man label|[ ]Never install missing packages on -the-fly}}. {{man tip|PDF's created automatically with lualatex|are output to the PDF Version 1.5 (Acrobat 6.0)format which has a maximum PDF page size of 200" x 200" inches (508cm x 508cm) so choose your custom paper sizes accordingly or Gramps will show the {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Error_and_Warning_Reference#Report_could_not_be_created|Report could not be created]]}} dialog}} ==See also==* Feature request {{bug|10223}} LaTeX genealogytree reports* 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 genealogical 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 (Discourse)'''* [https://gramps.discourse.group/t/recurring-people-not-visible-on-exported-descendant-graph/4328/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

Navigation menu