webtrees module hh_relation_is_descriptor

This webtrees custom module provides additional relation descriptors.

Contents

This Readme contains the following main sections

• Description
• Usage
• Requirements
• Installation
• Upgrade
• Contact Support
• License

Description

This custom module provides additional relation descriptors.

Such a descriptor is a word or a phrase that states object 1's relation is object 2. For example, you would read the following GEDCOM code as "The person pointed to by the XREF @S1@ is the landlord of Joe Jacob":

0 INDI

1 NAME Joe /Jacob/

1 ASSO @S1@

2 RELA landlord

The module supports

• INDI:ASSO:RELA (GEDCOM standard like in the example above)
• INDI:*:ASSO:RELA (no standard GEDCOM, but supported by webtrees)
• INDI:*:_ASSO:RELA (using a custom tag _ASSO like in INDI:BIRT:_ASSO)
• FAM:*:_ASSO:RELA (using a custom tag _ASSO like in FAM:MARR:_ASSO).

Usage

To add your custom relation descriptors you have to modify the file ExtendedRelationIsDescriptor.php. Replace the example lines in the function valuesAddon() by your custom descriptors. The text values depend on the sex of the linked individual.

If you like to add translations for your custom relation descriptors you have to add them at the end of the file RelationIsDescriptorAddon.php.

Requirements

This module requires webtrees version 2.1. This module has the same requirements as webtrees#system-requirements.

This module was tested with webtrees 2.1.2 version.

Installation

This section documents installation instructions for this custom module.

1. Download the latest release.
2. Unzip the package on your local computer.
3. Rename the folder to hh_relation_is_descriptor.
4. Modify the functions in the above-mentioned files as you like (initial modification).
5. Make a backup copy of your modifications.
6. Transfer the modified folder to your webtrees/modules_v4 directory at your web server.
7. Login to webtrees as administrator, go to Control Panel/Modules/Other, and find the module. It will be called "Custom Relation Descriptors". Check if it is enabled.

Upgrade

To upgrade to a new version of this custom module

1. Downlad the files from the latest release.
2. Unzip the package on your local computer.
3. Rename the folder to hh_relation_is_descriptor.
4. Modify the functions in the above-mentioned files as you like (based on your backup copy or based on the files at your webtrees server).
5. Make a backup copy of your modifications.
6. Transfer the modified folder to your webtrees/modules_v4 directory at your web server.
7. Reload (refresh) your webtrees page in the browser.

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
• 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/.

---