Skip to content

Control Panel settings

Neriderc edited this page Oct 30, 2024 · 4 revisions

The webtrees control panel allows you to set default values for the various GVExport options. In addition, you can set some settings that are not available in the normal user interface, and also have the option to enable debug mode, which helps developers solve issues.

Accessing control panel settings

A webtrees administrator can access the control panel settings by going to the "My Pages" menu at the top of webtrees (depending on theme), and choosing "Control Panel".

From here, scroll down to the "Modules" section and click on the "Charts" under "Genealogy".

Now look for the GVExport module in this list. Next to the name of the module should be a spanner which you can click to view the settings.

Load order

Options are loaded in the following order: config.php -> control panel -> user's saved options in browser

That is to say, the config.php file holds the default values. These can be overwritten by settings in the control panel, such that to a user the control panel settings appear to be the default. When a user makes changes using the UI in GVExport, these changes will be stored locally in the users browser and will always override the control panel and default settings. Updates to the default settings in the config.php or control panel page will not be reflected in the user settings until the user resets their settings, unless those settings are not part of the user settings.

Reset to default

An option is provided to reset the administration settings back to the GVExport defaults (or whatever you have set in config.php).

Note that you need to click "Save" after resetting the defaults, they are not saved automatically (in case it was an accident).

Admin only functions

Most of the settings are directly related to a setting in the user settings, and information on these can be found in the help built into GVEXport. Some of the settings only apply to admins, and these are explained below.

Download file name

This sets the name of the file for when users export the diagram to a file.

Graphviz MCLIMIT setting

This sets the Graphviz MCLIMIT setting. Setting this higher means the diagram will do a better job of laying out the records without too many connections crossing over each other, but this also increases the time and server load needed to generate a diagram. The default is 1, but you may want to increase it to see if it helps the quality of the diagram.

Note that the browser rendering is created on the user's computer. The MCLIMIT should still be applied, but it will not affect server load. This is also true for downloading diagrams where Graphviz is not installed on the server.

Birthdate prefix

This is shown on individual tiles ahead of the date and place of birth.

Death date prefix

This is shown on individual tiles ahead of the date and place of death, if the individual has passed away.

Marriage date prefix

This is shown on the family record ahead of the date of marriage, if the parents are married.

Limit ancestor and descendant levels

These settings allow the administrator to limit the number of ancestor levels or descendant levels that can be set, limiting the size of the diagram and therefore reducing the load on the server.

The settings can be set based on the user roles. So for example, a Visitor who is not logged in can have a lower limit than a Member that is logged in.

The value set applies separately to ancestors and descendants. So for example, if the limit is set to 5, then the users will be able to set the max levels for ancestors to 5, and the max levels for descendants to 5 (a total of 11, 5 ancestor generations, 5 descendant generations, and the initial generation).