• Installation
  • Using Composer
  • Using Git
  • Manual installation
• Enable module
• Usage
• Development
  • Run tests

Descendants chart

This module provides an SVG descendant chart for the webtrees genealogical application. It is able to display up to 25 generations of descendants of an individual.

But beware, if you select too many generations, it may take a while and even slow down your system significantly.

In addition to the descendants, the respective spouses are also displayed for a person. The display can be deactivated via the configuration form so that only the direct descendants are displayed.

Fig. 1: A four generations descendants chart with spouses (drawn top to bottom)

Installation

Requires webtrees 2.1.

Using Composer

To install using composer, just run the following command from the command line at the root directory of your webtrees installation.

composer require magicsunday/webtrees-descendants-chart

The module will automatically install into the modules_v4 directory of your webtrees installation. To make this possible, the "magicsunday/webtrees-module-base" package is used. Approval within Composer may be required here to authorize the execution of the package.

To remove the module run:

composer remove magicsunday/webtrees-descendants-chart

Using Git

If you are using git, you could also clone the current main branch directly into your modules_v4 directory by calling:

git clone https://github.com/magicsunday/webtrees-descendants-chart.git modules_v4/webtrees-descendants-chart

Manual installation

To manually install the module, perform the following steps:

1. Download the latest release.
2. Upload the downloaded file to your web server.
3. Unzip the package into your modules_v4 directory.
4. Rename the folder to webtrees-descendants-chart

Enable module

Go to the control panel (admin section) of your installation and scroll down to the Modules section. Click on Charts (in subsection Genealogy). Enable the Descendants chart custom module (optionally disable the original installed descendants chart module) and save your settings.

Fig. 2: Control panel - Module administration

Usage

At the charts' menu, you will find a new link called Descendants chart. Use the provided configuration options to adjust the layout of the charts according to your needs.

Furthermore, it is possible to export the generated tree diagram as an SVG or PNG image in order to be able to use it elsewhere.

Development

To build/update the javascript, run the following commands:

nvm install node
npm install
npm run prepare

Run tests

composer update
vendor/bin/phpstan analyse -c phpstan.neon
vendor/bin/phpcs src/ --standard=PSR12