README

A webtrees custom module that adds a Cousins tab to the individual page, listing the cousins of the person you are viewing.

Originally based on the simpl_cousins module by Nigel Osborne (kiwtrees.net), ported to webtrees by Vytautas Krivickas (vytux.com).

Features

Lists first cousins, grouped by their parents' family, split into Father's family and Mother's family.
Optional half cousins: children of a parent's half-siblings (that is, cousins who share only one grandparent). Tick Include half cousins at the top of the tab. Half cousins are labelled in the list, and the choice is remembered for your browser session.
Optional distant cousins: choose Cousin degree at the top of the tab to include second, third, fourth and fifth cousins. Each is labelled by degree (for example "second cousin" or "third half cousin"), and the choice is remembered for your browser session. Ancestors are followed through each person's first (usually birth) parent family.
Cousin labels use the cousin's sex where the language needs it, for example pusbrolis or pusseserė in Lithuanian.
A cousin related through both parents is listed and counted on both sides, but only once in the overall total.
Respects webtrees privacy settings.
Translated into Czech, Chinese (Simplified and Traditional), Danish, Dutch, Finnish, French, German, Hebrew, Lithuanian, Norwegian (Bokmål and Nynorsk), Russian and Swedish. Strings without a translation fall back to English.

Requirements

webtrees 2.2 or later
PHP 8.3 or later

Installation

With Composer (recommended)

From your webtrees root folder:

composer require vytux/vytux_cousins

The module is installed into modules_v4/vytux_cousins.

Manually

Download the latest release, unzip it and upload the folder to modules_v4/vytux_cousins/ on your web server.

Enable the tab

Sign in to webtrees as an administrator and go to Control panel → Modules → All modules. Find Cousins and make sure it is enabled.
Go to Control panel → Modules → Tabs. Set the access level and position for the Cousins tab. By default it may be shown to managers only.
Click Save.

Upgrading

With Composer run composer update vytux/vytux_cousins. Otherwise replace the module folder with the files from the latest release.

Adding more cousin types

Cousin types are defined in cousinTypes() in src/VytuxCousinsTabModule.php. Each type describes which relatives of an ancestor count as the starting point (full siblings for ordinary cousins, half-siblings for half cousins). Types marked optional automatically get a check-box on the tab, and every type works at each cousin degree.

The degree is handled separately: Nth cousins are found by walking up N−1 generations from each parent, taking that ancestor's siblings and walking N generations down. The generation walking lives in src/CousinWalker.php, and the highest degree offered is MAX_DEGREE in src/VytuxCousinsTabModule.php.

Development

Run the unit tests with:

composer install
composer test

CI runs these tests on PHP 8.3 to 8.6 for every push and pull request.

Translations

Translations live in src/VytuxCousinsTabModule.php, one method per language. Cousin labels (e.g. second cousin) can also have gendered translations, keyed as 'MALE' . Translation::CONTEXT_SEPARATOR . 'second cousin' (or 'FEMALE' …); see the Lithuanian translations for an example. Pull requests adding or improving a language are welcome.

Support

Please report bugs and request features on the issue tracker. You can also email webtrees@vytux.com, or ask general webtrees questions on the webtrees forum.

Licence

Released under the GNU General Public License, version 2 or (at your option) any later version. See the licence header in the source files.

vytux / vytux_cousins

Package info

Security

Statistics