README

• Fan chart
  • Installation
    • Manual installation
    • Using Composer
      • Latest version
    • Using Git
  • Configuration
  • Usage
  • Development
    • Run tests

Fan chart

This module provides an SVG ancestor fan chart for the webtrees genealogy application.

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:

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

If everything was successful, you should see a subdirectory webtrees-fan-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, run the following command from the command line, from the root of your Webtrees installation.

composer require magicsunday/webtrees-fan-chart --update-no-dev

The module will automatically install into the modules_v4 directory of your Webtrees installation.

To remove the module run:

composer remove magicsunday/webtrees-fan-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-fan-chart:dev-master --update-no-dev

Using Git

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

git clone https://github.com/magicsunday/webtrees-fan-chart.git modules_v4/webtrees-fan-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 Fan chart custom module (optionally disable the original installed fan chart module) and save your settings.

Usage

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

Right-clicking on an individual opens a tooltip providing more detailed information of the current individual.

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