magicsunday / webtrees-descendants-chart
This modules provides an SVG descendants chart for the [webtrees](https://www.webtrees.net) genealogy application.
Fund package maintenance!
paypal.me/magicsunday
Installs: 51
Dependents: 0
Suggesters: 0
Security: 0
Stars: 27
Watchers: 4
Forks: 9
Open Issues: 3
Language:JavaScript
Type:webtrees-module
Requires
- ext-dom: *
- ext-json: *
- fisharebest/webtrees: ~2.2.0
- magicsunday/webtrees-module-base: ^1.0
- magicsunday/webtrees-module-installer-plugin: ^1.3
Requires (Dev)
- friendsofphp/php-cs-fixer: 3.63.2
- overtrue/phplint: ^3.4 || ^9.0
- phpstan/phpstan: ^1.10
- phpstan/phpstan-deprecation-rules: ^1.1
- phpstan/phpstan-strict-rules: ^1.5
- rector/rector: ^1.0
README
Descendants chart
This module provides an SVG descendant chart for the webtrees genealogical application. It is capable of displaying up to 25 generations of descendants from 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.2.
There are several ways to install the module. The method using composer is suitable for experienced users, as a developer you can also use git to get a copy of the repository. For all other users, however, manual installation is recommended.
Manual installation
To manually install the module, perform the following steps:
- Download the latest release of the module.
- Upload the downloaded file to your web server.
- Unzip the package into your
modules_v4
directory. - Rename the folder to
webtrees-descendants-chart
If everything was successful, you should see a subdirectory webtrees-descendants-chart
with the unpacked content
in the modules_v4
directory.
Then follow the steps described in configuration and usage.
Using Composer
Typically, to install with composer, just run the following command from the command line, from the root of your Webtrees installation.
composer require magicsunday/webtrees-descendants-chart --update-no-dev
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 --update-no-dev
Then follow the steps described in configuration and usage.
Latest version
If you are using the development version of Webtrees (main branch), you may also need to install the development version of the module. For this, please use the following command:
composer require magicsunday/webtrees-descendants-chart:dev-main --update-no-dev
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
Then follow the steps described in configuration and usage.
Configuration
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 descendant 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 composer ci:test composer ci:test:php:phpstan composer ci:test:php:lint composer ci:test:php:rector