Personal tools
User menu

Plugins documentation

From Ancestris Genealogy Program

Jump to: navigation, search

What is a plugin?

A plugin is an extension, a software component that adds one or more specific features to Ancestris. This way you can customize your genealogy software. You want a tool to create a web site? There is a plugin for that. You want a program to check for the integrity of your genealogy? There is a plugin for that. Etc.


Contents


First, we have to know how to install, how to uninstall, and how to delete a plugin.

Once we know that, here is a list of some plugins which have their own documentation. We have more plugins than this list shows, but we have to find volunteers to write some good articles about them. Help wanted ;-)


How to manage plugins

Ancestris is a flexible software thanks to its plugins.

To manage them, you need to go in Tools > Plugins menu:

Plugin menu (click to enlarge)


Then you will have this window :

Plugins management window (Click to enlarge)

The Global scheme is the same on each tab. On the left side, you'll have the plugins list, and on the right side, you'll see a brief description about the plugin.

As you see, there are 5 tabs in this window:


Updates

Will indicate to you when installed plugins have updates available.

Updates window (Click to enlarge)

If you have selected automatic updates, you should not have any use for this tab. If you choose to not automatically check for updates, you will find all available updates here.

Then, click on the checkbox for each mod you want to update, and click on the "Update" button.


Available plugins

Lists the available plugins that you have not installed yet.

Available plugins window (Click to enlarge)

On the left side of the window, you'll see all the available plugins you have not installed yet. If you click on the plugin's name, you will see a short description of it in the right side of the window.

To install one, just click the checkbox in front of it, and then click on the Install button. Note: you can install as many plugins as you want at the same time - just select all you want, and click the "Install" button.


Downloaded

Allows you to manage external plugins

Downloaded plugins window (click to enlarge)

This tab allows you to install plugins other than the officials (i.e. unofficial plugins, beta plugins not available as stable, plugins you wrote yourself...)

Click on the "Add plugins ..." button, then find and select it on your hard drive. Once this is done, you'll see your plugin in the left side of the window. As with available plugins, click on the checkbox and press "Install" to install it.


Installed

This tab gives you a list of already installed plugins, because you have plugins already installed (yes, really!).

Installed plugins window (click to enlarge)

On the left side of the window, you'll see all the installed plugins, and you can verify if they are activated or not.

  • Active plugins will have a green check mark at the end of the line.
  • Inactive plugins will have blue recycling arrows at the end of the line, and will be displayed in light grey color.

To enable an inactive plugin, click on the checkbox, and press the "Activate" button.

To disable an active plugin, click on the checkbox, and press the "Deactivate" button.

If you want to delete a plugin, click on the checkbox, and press the "Uninstall" button.


Settings

Here, you choose how and when to check for available updates...

Plugins settings window

On the top part of the window, you'll see the place where updates are checked. In most of cases, you will have nothing to change in this part!

On the lower part, you can select the interval to check for updates.

If your computer is behind a proxy, you can set the parameters by pressing the "Proxy..." button. In most of cases, default settings should work correctly.

Once you have made your choice, you will probably be asked to close and re-launch Ancestris to apply the modifications.

Back to the "Documentation Menu"


Plugins list




This web site is under construction. If you don't find what you're looking for, please visit our previous website at ancestris.org.
  • This page was last modified on 19 April 2017, at 17:03.
  • This page has been accessed 30,929 times.