Gramps 3.0 Wiki Manual - Settings

From Gramps
Jump to: navigation, search
Gnome-important.png Special copyright notice: All edits to this page need to be under two different copyright licenses:

These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [http://www.gramps-project.org/...]), not via internal links.<br\> Also, only use the known conventions


Previous Index Next



Preferences

Most of the settings in GRAMPS, are configured in the Preferences dialog. To invoke it, choose Edit ->Preferences... .

Fig. 4.1. Preferences dialog

The tabs on the top display the available option categories.

General

This category contains preferences relevant to the general operation of the program. Options are:

  • Add default source on import: This option affects the importing of data. If this is set, each item that is imported will contain a source reference to the imported file.
Gramps-notes.png
Note

Adding a default source can significantly slow down the importing your data.

  • Enable spelling checker: This option controls the enabling and disabling of the spelling checker for notes. The gtkspell package must be loaded for this to have an effect.
  • Display Tip of the Day: This option controls the enabling and disabling of the Tip of the Day dialog at startup.
  • Use shading in Relationship View: This option controls the enabling and disabling of shading in the Relationship View. If enabled, information will be grouped together in regions with a shaded background.
  • Display edit buttons on Realtionship View: This option controls the enabling and disabling of the edit buttons in the Relationship view. If enabled you will see the edit buttons on the right side of the displayed names.
  • Remember last view displayed: This option controls the enabling and disabling of the the display of the last view. Enabling will bring you to the view where you stopped the program the last time.
  • Number of generations for relationship determination: You can fill in the number of generations used to determine relationships. The default value is 15.
  • Base path for relative media path: Here you can fill in a base path for the media objects. Clicking the Directory button gives you a Select media directory editor where you can fill in the required path.

Database

Fig. 4.2. Preferences dialog

This category contains preferences relevant to the Database path.

  • Database path: The default path where the Databases are stored is home directory/.gramps/grampsdb. Unless you absolutely want to change this, stay with the default path.
  • Automatically backup database on exit: This option controls the enabling and disabling of the backup of the database when you quit the program.
  • Automatically load last database: This option controls the enabling and disabling of the loading on start up of the last used database.

Display

Fig. 4.3. Preferences dialog

This category contains preferences relevant to the display of data and names. Options are:

  • Name format: This option controls the display of names. In GRAMPS there are two type of name display formats: the predefined formats, and the user defined custom formats. Several different predefined name formats are available: Given - Prefix Patronymic, Suffix Given - Prefix Surname, Given Patronymic Suffix etc. Clicking on the righthand side Edit... will bring up a Display Name Editor window where the available list of options is shown. The format is given as well as an example. When predefined formats are not suitable one can define one's own format. You can use the Add button to add a Name format to the list. Clicking once will give you a SURNAME,Given Suffix(call) format and as example : SMITH, Edwin Jose Sr (Ed). If you added new name formats to the list the Remove and Edit buttons become available to change the name format list.
Gramps-notes.png
Note

Besides the system wide setting GRAMPS allows deciding the name display format individually for every single name via the Name Editor dialog (see adv-an ).

Gramps-notes.png
Note

Custom name display formats are stored in the databases, thus before loading any database the Custom format details expander is disabled.

  • Date format: This option controls the display of dates. Several different formats are available, (e.g. YYYY-MM-DD (ISO)) which may be dependent on your locale.
  • Surname Guessing: This option affects the initial family name of a child when he/she is added to the database. If None is selected, no guessing will be attempted. Selecting Father's surname will use the family name of the father. Selecting Combination of mother's and father's surname will use the father's name followed by the mother's name. Finally, Icelandic style will use the father's given name followed by the "sson" suffix (e.g. the son of Edwin will be guessed as Edwinsson).
Gnome-important.png
Tip

This option only affects the initial family name guessed by GRAMPS when the Edit Person dialog is launched. You can modify that name the way you see fit. Set this option to the value that you will most frequently use, as it will save you a lot of typing.

  • Status bar: This option controls the information displayed in the status bar. This can be either the Active person's name and ID or Relationship to home person.
  • Show text in sidebar buttons: This option controls whether or not a text description is displayed next to the icon in the sidebar. This option takes effect after the program has been restarted.

Text

Fig. 4.4. Preferences dialog

This category contains preferences relevant to how missing and private names and records should be shown.

  • Missing surname: in the input field you can determine how a missing surname should be displayed. Default value is [Missing Surname]. You can change this to [--] or whatever is most convenient for you.
  • Missing given name: in the input field you can determine how a missing given name should be displayed. Default value is [Missing given name]. You can change this to whatever you want.
  • Missing record
  • Private surname
  • Private given name
  • Private record

ID Formats

Fig. 4.5. Preferences dialog

This category contains preferences relevant to the automatic generation of GRAMPS IDs.

Gnome-important.png
ID Prefixes

The ID prefixes use formatting conventions common for C, Python, and other programming languages. For example, the %04d expands to an integer, prepended with zeros to have the total width of four digits. If you would like IDs to be 1, 2, 3, etc., simply set the formatting parameter to %d.


  • Person: Provides the template for generating IDs for a Person. Default value: I%04d.
  • Family: Provides the template for generating IDs for a Family. Default value: F%04d.
  • Place: Provides the template for generating IDs for a Place. Default value: P%04d.
  • Source: Provides the template for generating IDs for a Source. Default value: S%04d.
  • Media Object: Provides the template for generating IDs for a Media Object. Default value: O%04d.
  • Event: Provides the template for generating IDs for an Event. Default value: E%04d.
  • Repository: Provides the template for generating IDs for a Repository. Default value: R%04d.
  • Note: Provides the template for generating IDs for a Note. Default value: N%04d.

Warnings

Fig. 4.6. Preferences dialog

This category controls the display of warning dialogs, allowing the re-enabling of dialogs that have been disabled.

  • Suppress warning when adding parents to a child:
  • Suppress warning when cancelling with changed data
  • Suppress warning about missing researcher when exporting to GEDCOM
  • Show plugin status dialog on plugin load error

Researcher Information

Fig. 4.7. Preferences dialog

Enter your personal information in the corresponding text entry fields. Although GRAMPS requests information about you, this information is used only so that GRAMPS can create valid GEDCOM output files. A valid GEDCOM file requires information about the file's creator. If you choose, you may leave the information empty, however none of your exported GEDCOM files will be valid.

The available text entry fields are:

  • Name:
  • Address:
  • City:
  • State/Province:
  • Country:
  • ZIP/Postal Code:
  • Phone:
  • Email:

Marker Colors

Fig. 4.8. Preferences dialog

This category controls the highlight color of items in the Person list when a marker has been set for a person.

You can choose a different color for:

  • Complete: default color Green: #008B00
  • ToDo: default color Red: #F00
  • Custom: default color Purple: 8B008B

Clicking on the colored boxes brings up an Pick a Color editor where you can change the default settings. The color name can be changed by typing in the name of a color: e.g. Beige.

Clicking the Revert button will undo the changes.

Other settings

Besides Preferences dialog, there are other settings available in GRAMPS. For various reasons they have been made more readily accessible, as listed below.

Column Editor

The columns of the list views may be added, removed, or reordered in a Column Editor dialog, see column-editor-fig . Only checked columns will be shown in the view. To change their order, drag any column to its desired place inside the editor. Clicking OK will reflect the changes in the appropriate view. To invoke Column Editor dialog, choose Edit ->Column Editor... .

Gnome-important.png
Column Editor

The Column Editor is available and works in the same way for all list views. Specifically, it is available for People View, Family View (children list). Sources View, Places View, Media View, Repositories View and the Notes View.

Setting Home person

The Home person is the person who becomes active when database opened, when Home button is clicked or the Home menu item is selected from either Go menu or the right-click context menu anywhere. The Home button is available in the Toolbar in the People View, Relationships View, and Pedigree View. To set Home person, make the desired person active and then choose Edit ->Set Home person... .

Adjusting viewing controls

Whether the toolbar, the sidebar, or the filter (not available on Pedigree and Relationships Views) are displayed in the main window is adjusted through the View menu. In the different views clicking the View menu will shows three boxes you can click:

  • Sidebar
  • Toolbar
  • Filter Sidebar

Additionally, depending on the view you are in, other options will be available.

  • Gramplets: Set Columns to
  • Relationships: Show Siblings and Show Details
  • All other Views: no other options

Export the screen

On most Views, displayed data could be exported, choose File ->Export View... . GRAMPS will export data on screen according your choice (filter, columns). This is a powerful function (no limitations), like a report.

Advanced manipulation of settings

Gnome-important.png
Warning

The contents of this section is outside the scope of interest of a general user of GRAMPS. If you proceed with tweaking the options on the low level you may damage your GRAMPS installation. Be careful. YOU HAVE BEEN WARNED!

By default, GRAMPS stores its settings using gconf2 system. All the settings used in this version of GRAMPS are stored in subdirectories under /apps/gramps/ in the gconf2 namespace. Accessing the keys can be done either using
gconftool-2
command line tool, or the
gconf-editor
GUI tool.

All keys are documented, and the notification mechanisms are used as appropriate. Therefore, updating keys from outside of GRAMPS should lead to updating GRAMPS in real time, without necessarily restarting it.

GNOME provides a central system called GConf for storing user preferences on behalf of individual applications. Now, GRAMPS uses INI but previous version (2.x) used the GConf API. The GConf database is structured like a filesystem, containing keys. Those keys are organized into a tree hierarchy. Each key can have a Name and a Value. GConf has several tools. There is a GUI that brings you to the Configuration Editor. This GUI does not appear by default in an Ubuntu Applications Menu. You can edit the Application menu and add it. Got to Applications -> Accessories -> Alacarte Menu Editor -> System Tools and turn on the Configuration Editor.

If you use the GNOME desktop and you run

  sudo gconf-editor

in a terminal and give your root password, you will get a list of all your GNOME settings. If you look in apps you will find gramps.

When you open Configuration Editor, you'll notice that there is no Save button. All changes are immediate and take care with your changes! The list has following sub-items:

  • behavior: typical Key names are: betawarn, enable-autobackup, use-tips...
  • interface: a lot of keys regarding height and width of the different Views: e.g. event-height: 450, event-ref-height: 585, event-ref-width: 728, event-width: 712...
  • paths: keys realted to recent imported files and dirs
  • preferences: keys related to preferences: all the common prefixes , todo -colors..
  • researcher: all information regarding the researcher

For easy reference you can bookmark the gramps position so you do not need to scroll down the complete list.

The Key Documentation provides a short and long description of the available keys.

Name Format Editor

New formats are created, and existing formats are modified using this editor.

  • Format name: The name of the custom format. The format name can be any string, it is used only to recognize the format later on the Display format list.
  • Format definition: The actual format is defined here using special formatting characters. Before and after these special characters any other character or string is allowed. For example: "(%t) %L, %f" will give "(Dr.) SMITH, Edwin". The formatting characters are:
Character Name CHARACTER NAME
%f Given Name %F GIVEN NAME
%l Surname %L SURNAME
%t Title %T TITLE
%p Prefix %P- PREFIX
%s- Suffix %S SUFFIX
%c Call name %C CALL NAME
%y Patronymic %Y PATRONYMIC
  • Example: Shows a dynamic example how the name will be displayed with the current Format definition string.
  • Format definition details: Shows a quick reminder of the special formatting characters.
Previous Index Next