key Log In or Register to edit

Family Tree Plugin

The Family Tree Plugin is a simple database that uses TWiki searches to perform queries over genealogical data in a TWiki web and generate family trees.

example_tree.png

Each person in the family, and each union (marriage or other union), are stored as TWiki topics. Each person topic includes a standard "person topic" (StdPerson) that defines some basic searches, and has a form that records basic details about the person. Extra detail can be added freeform to the topic, or can be recorded in a "records" table to ease searching.

The standard person include defines the following queries over the data:

  • Female line (ancestors of this person)
  • Male line (ancestors of this person)
  • Family tree (rooted at this person)

Union topics similarly have a standard include (StdUnion) and a form. Union topics are named for the couple they represent, male then female, separated by a capital 'X'. Children of the union are listed in a simple one-column table in the union topic.

The plugin installs a new web, called FamilyTreePlugin?. This web contains an example family tree (a small fragment of my own family tree), a left bar topic, and two "creator topics", NewPerson and NewUnion, that help you in creating person and union records respectively. You should not edit directly in this web, as it may be overwritten when you upgrade the plugin. Instead you should create your own new web (see Managing Webs) and manually copy what you need over to the new web (copy everything and then remove all files with 'Currie' in the name).

The schema of the database was inspired by the standard LDS "GED" format, so translation back and forth from this format should be fairly straightforward. it would be great if someone could write some scripts to do this.....!

Note: searches over my family tree (360 persons, 120 unions) are just about fast enough. If you are planning on capturing a much bigger tree, then there is a next generation of the plugin in development which will use the Form Query Plugin for faster searching.

Syntax Rules

  • %MANCESTORS("person"}% - generate a representation of the male line leading to the given person
  • %FANCESTORS{"person"}% - generate a representation of the female line leading to the given person
  • %DESCENDANTS{"person"}% - generate a complete family tree rooted at the given person

Plugin Settings

  • Set SHORTDESCRIPTION = A simple genealogy database

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

  • Unzip the plugin over your TWiki installation
  • Enable the plugin in configure

Plugin Info

Plugin Author: TWiki:Main.CrawfordCurrie http://c-dot.co.uk
Plugin Version: %$VERSION%
License: GPL (GNU General Public License)
CPAN Dependencies: none
Other Dependencies: %$DEPENDENCIES%
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/FamilyTreePlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/FamilyTreePluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/FamilyTreePluginAppraisal

Related Topics: Developer Documentation Category, Admin Documentation Category, T Wiki Preferences, T Wiki Plugins

 
Ad Sponsor
Back to Redbourn
Copyright © We make no guarantee of the correctness of the content of this site. All material on this collaboration platform is the property of Martin Cleaver and the contributing authors.