The Family Historian API

The fhUtils Module


The fhUtils module is a library of functions (and one object: PCite) that was created to make it easier to write Source-driven Data Entry Plugins.  However, it can be used for other purposes too.  To make use of the fhutils module, you must include a link like this near the start of your plugin:

fh = require("fhUtils");

Thereafter you can call fhUtils functions like this:

local PCite = fh.LoadPreparedCitation();

You don't have to use 'fh' as the module name.  That is just a convention.

The module implements an object called PCite, which represents a prepared citation.  In the example above, a PCite object has been created and returned by the LoadPreparedCitation function.

The documentation for the fhUtils module is located at http://pluginstore.family-historian.co.uk/fhutils/files/fhUtils.html.