Skip to content

Latest commit

 

History

1 Commit

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Potts Relationship Context

Potts Relationship Context is a custom module for webtrees 2.2.x. It shows how the person being viewed is related to a selected reference individual.

Examples:

  • Beryl Patricia Potts is your aunt.
  • John Maxwell Duthie is your 2nd cousin.
  • No relationship could be found between Patrick Boyle and John Henry Potts.

Features

  • Shows a relationship summary on individual pages.
  • Places the summary near the page title, above the individual tabs or inside the Facts and events panel.
  • Adds a visitor-controlled Relationship checkbox to Facts and events.
  • Links confirmed relationships to the built-in webtrees Relationships chart.
  • Reports clearly when no relationship can be found and omits the path link.
  • Adds fallback relationship labels to close-relative and associate events when webtrees does not already show them.
  • Supports compact labels or sentence-style event labels.
  • Uses responsive cards on desktop, tablet and mobile layouts.
  • Uses active theme colours or the module's teal-and-gold appearance.
  • Recognises Potts Modern automatically while retaining compatibility with Xenea, Clouds and other webtrees themes.
  • Prevents fallback calculations from traversing records hidden from the current visitor.

Reference Person

The module selects a reference person in this order:

  1. The signed-in user's linked individual.
  2. The signed-in user's favourite individual.
  3. The configured public reference individual.
  4. The tree root individual.

Each source can be enabled or disabled in the module settings. A public reference must be visible to signed-out visitors before it can be saved.

Requirements

  • webtrees 2.2.x
  • PHP 8.3 or later, as required by webtrees 2.2.x

Installation

  1. Download potts_relationship_context-1.0.0-beta.1.zip from the GitHub release assets.
  2. Extract the zip.
  3. Upload the potts_relationship_context folder to your webtrees modules_v4 directory.
  4. Enable Potts Relationship Context in Control panel > Modules > All modules.
  5. Open the module settings and configure the reference-person and display options.

Do not install GitHub's automatically generated source-code zip. It does not provide the release package in the intended installation layout.

Settings

Administrators can configure:

  • which reference-person sources are used
  • the public reference individual's XREF
  • whether to fall back to the tree root individual
  • the maximum number of generations used by fallback relationship calculations
  • whether relationship summaries, event labels and path links are shown
  • summary placement
  • compact or sentence-style event labels
  • active-theme or Potts card colours

Privacy

The module relies on webtrees privacy rules. It validates that a public reference person is visible to signed-out visitors, does not label private associates and does not traverse hidden records during fallback calculations.

Administrators remain responsible for testing their tree's privacy settings while signed out before enabling the module publicly.

Diagnostics

For troubleshooting, open the browser console on an individual page and inspect:

window.pottsRelationshipContextStatus

Bug reports should include the webtrees version, active theme, module settings, page type and this diagnostic output with private information removed.

Known Limitations

  • This is a public beta and should be tested before use on a production site.
  • Browser-injected relationship text is currently supplied in English.
  • Custom themes with substantially altered individual-page markup may need additional compatibility work.

Support

Report bugs and request enhancements through the GitHub issue tracker.

Licence

GPL-3.0-or-later. See LICENSE.

About

A webtrees module that shows how individuals are related to a selected reference

Topics

Resources

Contributing

Security policy

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages