Skip to content

Latest commit

 

History

History
169 lines (131 loc) · 7.88 KB

readme.md

File metadata and controls

169 lines (131 loc) · 7.88 KB
Raw

webtrees module hh_extended_family

License: GPL v3

webtrees major version webtrees major version

Maintainability Latest Release

This webtrees module creates an additional tab in the Individual view which lists the members of the core and the extended family of that person: great-grandparents, grandparents, parents, parents-in-law, co-parents-in-law, uncles, aunts, partners, siblings, siblings-in-law, co-siblings-in-law, cousins, nephews, nieces, children, children-in-law, grandchildren, and grandchildren-in-law.

Contents

This Readme contains the following main sections

Description

There is a module description in German language available.

This module presents the core and the extended family of a proband. It is based on the Eskimo kinship system.

The user can filter the shown results by

  • gender and
  • dead/alive persons.

The admin can decide in the control panel

  • which extended family parts should be shown and in which sequence they should be presented
  • if filter options should be presented for users
  • if a button "copy to clippings cart" should be shown
  • how empty parts of extended family should be presented
  • whether the name of proband is a full name or a short version
  • whether a compact design should be used or an enriched version, showing a photo as well as complete birth and death information
  • whether labels should be shown for each part of the extended family showing the generation shift and information about the related coefficient of relationship
  • whether labels like "adopted child", "foster child", "triplet", "stillborn", or "linkage challenged" should be used to indicate special situations
    • GEDCOM records to indicate that a person
      • is e.g. a triplet, should look like "1 BIRT\n2 _ASSO @I123@\n3 RELA triplet" or "1 ASSO @I123@\n2 RELA triplet")
      • is stillborn or died as an infant, should look like "1 BIRT\n2 AGE STILLBORN" or "1 DEAT\n2 AGE INFANT"
      • has a special linkage status to the parent family (challenged, disproven, proven), should look like "1 FAMC @F123@\n2 STAT CHALLENGED"

The default presentation sequence of the extended family parts is oriented at the generation of the people in this part, relative to the proband

  • great-grandparents // generation +3
  • grandparents // generation +2
  • uncles and aunts // generation +1
  • uncles and aunts by marriage // generation +1
  • parents // generation +1
  • parents-in-law // generation +1
  • co-parents-in-law // generation 0
  • partners and partner chains // generation 0
  • siblings // generation 0
  • siblings-in-law // generation 0
  • co-siblings-in-law // generation 0
  • cousins // generation 0
  • nephews and nieces // generation -1
  • children // generation -1
  • children-in-law // generation -1
  • grandchildren // generation -2
  • grandchildren-in-law // generation -2

Screenshots

Screenshot of tab using the compact design

Screenshot of tab

Screenshot showing photo as well as birth and death information

Screenshot showing photo as well as birth and death information

Screenshot showing chain of partners (partner of partner of partner of ...)

Screenshot showing chain of partners

Screenshot of control panel menu

Screenshot of control panel menu

Requirements

This module requires webtrees version 2.1 or later. This module has the same requirements as webtrees#system-requirements. The last version for webtrees 2.0 is 2.0.16.58.

This module was tested with webtrees 2.1.5 version and all available themes and all other custom modules.

Installation

This section documents installation instructions for this module.

  1. Make database backup
  2. Download the latest release
  3. Unzip the package into your webtrees/modules_v4 directory of your web server
  4. Rename the folder to hh_extended_family
  5. Login to webtrees as administrator, go to Control Panel/Modules/Individual page/Tabs, and find the module. It will be called "Extended family". Check if it has a tick for "Enabled".
  6. Finally, click SAVE, to complete the installation.

Upgrade

To update simply replace the hh_extended_family files with the new ones from the latest release.

Translation

You can help to translate this module. The language information is stored in the file "resources/lang/ExtendedFamilyTranslation.php". The German part is the most actual and can be used as a base for your translation. Use a local editor, like notepad++ to make the translations and send it back to me. You can do this via a pull request (if you know how) or by e-mail. Updated translations will be included in the next release of this module.

There are now, beside English and German, translations to

  • Catalan by @bernatbanyuls
  • Chinese by @olor (=iyoua)
  • Czech by @jpretired
  • Dutch by @TheDutchJewel
  • French by @PalmyreSG1 and @fa10175
  • Hindi by @mrqd9
  • Italian by @tonio (under preparation)
  • Norwegian Bokmål by @eyolf
  • Russian by @aurbo
  • Slovak by @ro-la
  • Spanish by @yako1984 and @bernatbanyuls
  • Ukrainian by @z-yurets
  • Vietnamese by @ngohuuthuan

Support

Issues: you can report errors raising an issue in this GitHub repository.

Forum: general webtrees support can be found at the webtrees forum

License

  • Copyright (C) 2022 Hermann Hartenthaler
  • Derived from webtrees - Copyright 2022 webtrees development team.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.