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 (pedigrees). It is a TWikiApplication combined with a simple plugin that provides some standard searches over the data and generates pedigree pictures. Pedigrees can be generated using either HTML (as in the example) or using the DirectedGraphPlugin to generate a nice graphical picture of the tree.

Each person in the family, and each union (e.g. marriage), 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 some standard topics, 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 will be overwritten if you ever upgrade the plugin. Instead you should create your own new web based on the FamilyTreePlugin web (see ManagingWebs) and then remove all topics in the new web 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 paternal family tree (360 persons, 120 unions) are just about fast enough. If you are planning on capturing a much bigger tree, then you should probably look at commercial tools for handling family trees, of which there are hundreds.

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
• %GRDESCENDANTS{"person"}% - generate a complete family tree rooted at the given person using GraphViz. Only works if DirectedGraphPlugin is installed.

Plugin Settings

• Set SHORTDESCRIPTION = A simple genealogy database

Plugin Installation Instructions

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

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.

• If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • See the installation supplement on TWiki.org for more information.
• If you have any problems, then you can still install manually from the command-line:
  1. Download one of the .zip or .tgz archives
  2. Unpack the archive in the root directory of your TWiki installation.
  3. Run the installer script ( perl <module>_installer )
  4. Run configure and enable the module, if it is a plugin.
  5. Repeat for any missing dependencies.
• If you are still having problems, then instead of running the installer script:
  1. Make sure that the file permissions allow the webserver user to access all files.
  2. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
  3. Manually edit LocalSite.cfg to set any configuration variables.

Plugin Info

Plugin Author:	TWiki:Main.CrawfordCurrie http://c-dot.co.uk, TWiki:Main.GeorgeClark
Plugin Version:	16895 (14 Jun 2008)
License:	GPL (GNU General Public License)
Dependencies:	Name Version Description TWiki::Plugins >=1.026 Required, TWiki 4.0 or later TWiki::Plugins::EditTablePlugin >=0 Optional, used for editing record tables TWiki::Plugins::DateFieldPlugin >=0 Optional, only required for TWiki 4.0
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: DeveloperDocumentationCategory? , AdminDocumentationCategory? , TWikiPreferences, TWikiPlugins