/GVExport

Repository for GVExport module for Webtrees

Primary LanguagePHPGNU General Public License v2.0GPL-2.0

GVExport

This is a repository for a webtrees module known as GVExport. GVExport's goal is to produce an "all in one tree" of every person in a family tree and their relationships. You can view the tree in webtrees and click on individuals of families to go to their page in webtrees, and if the GraphViz software is installed on the server it can produce output in multiple file formats such as JPG, SVG, PDF, and others.

One of the display options renders output like this:

Webtrees

Webtrees is an online collaborative genealogy application. This can be hosted on your own server by following the Install instructions. If you are familiar with Docker, you might like to install Webtrees using this unofficial docker image, or this one.

Installation of GVExport

To install GVExport, copy files to modules_v4 directory in webtrees and rename the folder to GVExport. For more detail, see the install instructions.

GraphViz

By default GVExport can display the output in the browser. To generate files such as PNG, JPG, SVG, and PDF, the GraphViz software is needed on the server. See Installation of GraphViz.

GVExport Module

Once installed (and enabled), go to Charts -> GVExport to see the options.

Some further but non-exhaustive instructions can be found in this forum post from the previous version.

Help and support

If you need help with GVExport, please create an issue on GitHub.

If you find a bug or something isn't working, please create an issue.

If you want to request a new feature, please create an issue.

Older Versions

We attempt to keep up with the latest stable (non-prerelease) version of webtrees. You can see the latest release of webtrees here. Older versions are not supported. However, as we progress through webtrees versions, we are releasing GVExport versions. These are listed on the Releases page. If you are not using the latest version of webtrees, and the latest release of GVExport isn't working for you, you may want to try an older release.

For versions earlier than 2.0.21 you can try the source repository, but note this DOES NOT work with PHP 8 and it is missing many enhancements from this repository.

Contributing

If you'd like to contribute to GVExport, great! You can contribute by:

  • Creating issues for any new ideas you have
  • Creating issues if you find bugs
  • Contributing code - check out the Issues for things that need attention. If you have changes you want to make not listed in an issue, please create one, then you can link your pull request.
  • Testing - it's all manual currently, please create an issue for any bugs you find.
  • Documentation - anyone can update our Wiki
  • Translating - you can translate into a language you are fluent in by joining the PO Editor project. Discussion on translating can be done by creating an issue.

For more information on contributing, please see CONTRIBUTING.md.

This repository

This repository was forked from tillsc/GVExport after community pull requests had not been merged for some time. A post had been made on the webtrees forum stating that GVExport had been brought up to date to work with webtrees 2.0, but that the developer could not provide ongoing support. After a webtrees update broke the module, this fork was created to maintain compatibility and continue refining the tool with new features and other enhancements.

Current maintainer:

Past Authors: