Difference between revisions of "Gramps 4.0 Wiki Manual - Main Window"

From Gramps
Jump to: navigation, search
m (Gramplets Category: GrampletsView-40.png)
m (Window Title Bar added)
 
(83 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{grampsmanualcopyright}}
 
{{grampsmanualcopyright}}
  
{{man index|Gramps 4.0 Wiki Manual - Getting Started|Gramps 4.0 Wiki Manual - Manage Family Trees|4.0}}
+
{{man index|Gramps 4.0 Wiki Manual - Getting Started|Gramps 4.0 Wiki Manual - Categories|4.0}}
  
 
{{languages|Gramps 4.0 Wiki Manual - Main Window}}
 
{{languages|Gramps 4.0 Wiki Manual - Main Window}}
Line 8: Line 8:
 
{{#vardefine:figure|0}}
 
{{#vardefine:figure|0}}
  
== Introduction ==
+
Elements of Gramps main window.
 +
 
 +
== Main Window ==
  
 
When you open a Family Tree database (either existing or new), the main Gramps window is displayed (Fig. {{#var:chapter}}.{{#expr:{{#var:figure}}+1}}):
 
When you open a Family Tree database (either existing or new), the main Gramps window is displayed (Fig. {{#var:chapter}}.{{#expr:{{#var:figure}}+1}}):
  
[[Image:Mainwinannotated.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window]]
+
[[Image:Mainwinannotated-40.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window]]
  
 
{{-}}
 
{{-}}
Line 18: Line 20:
 
The main Gramps window contains the following elements:
 
The main Gramps window contains the following elements:
  
*Menubar: The menubar is located at the very top of the window (right below the window title) and provides access to all the features of Gramps.
+
===Window Title Bar===
 +
*Window Title Bar shows the name of selected Family Tree, Gramps application name and buttons to minimize, maximize and close Gramps. The window can also be dragged from the Title Bar.
 +
 
 +
=== Menubar ===
 +
*Menubar: The menubar (Main Menu) is located at the very top of the window (right below the window title) and provides access to all the features of Gramps.
 +
 
 +
=== Toolbar ===
 +
*Toolbar: The toolbar is located right below the menubar. It gives you access to the most frequently used functions of Gramps. You can set options that control how it appears by going to the menu {{man menu|Edit ->Preferences}}.
 +
The Toolbar can be hidden or revealed by the option in menu {{man menu|View ->Toolbar}}.
  
*Toolbar: The toolbar is located right below the menubar. It gives you access to the most frequently used functions of Gramps. You can set options that control how it appears by going to the menu {{man menu|Edit ->Preferences}} . You can also hide the  toolbar entirely by going to the menu {{man menu|View ->Toolbar}}.
+
=== Navigator ===
 +
*Navigator: The navigator is located at the left of the window and allows selection of the different categories. See [[Gramps_4.0_Wiki_Manual_-_Categories#Categories_of_the_Navigator|Categories of the Navigator]]
 +
The Navigator can be hidden or revealed by the options in menu {{man menu|View ->Navigator}}.
  
*Navigator: The navigator is located at the left of the window and allows selection of the different categories.
+
=== Display area ===
 +
*Display area: The area in the center of the Gramps window is the display area. What it displays depends on the currently selected View. We will discuss Views in detail below.
  
*Progress Bar and Status Bar: These are located at the very bottom of the Gramps window.
+
=== Status Bar and Progress Bar ===
 +
*Status Bar and Progress Bar: These are located at the very bottom of the Gramps window.
 
** The Progress Bar is located in the lower left corner of the Gramps window. It displays the progress of time consuming operations, such as opening and saving large Family Tree databases, importing and exporting to other formats, generating web sites, etc. When you are not doing these types of operations, the Progress Bar is not shown.  
 
** The Progress Bar is located in the lower left corner of the Gramps window. It displays the progress of time consuming operations, such as opening and saving large Family Tree databases, importing and exporting to other formats, generating web sites, etc. When you are not doing these types of operations, the Progress Bar is not shown.  
 
** The Status Bar is located to the right of the Progress Bar. It displays information about current Gramps activity and contextual information about the selected items.
 
** The Status Bar is located to the right of the Progress Bar. It displays information about current Gramps activity and contextual information about the selected items.
  
*Display area: The area in the center of the Gramps window is the display area. What it displays depends on the currently selected View. We will discuss Views in detail below.
+
=== Bottombar and Sidebar ===
 
 
 
*Bottombar: The bottombar is located below the display area.
 
*Bottombar: The bottombar is located below the display area.
  
 
*Sidebar: The sidebar is located to the right of the display area.
 
*Sidebar: The sidebar is located to the right of the display area.
  
{{Out of date}}
+
The Bottombar and the Sidebar allow [[Gramps_4.0_Wiki_Manual_-_Gramplets|gramplets]] and [[Gramps_4.0_Wiki_Manual_-_Main_Window#Filters|filters]] to be displayed alongside a view.
{{man warn| TODO |Need to update this content. eg fig 3.1 again?}}
 
  
The Bottombar and the Sidebar allow gramplets to be displayed alongside a view. (''Details to be provided, based e.g. on [[GEPS_019:_Improved_Sidebar_and_Split_Views|GEPS 019]] and [[Gramps 4.0 Wiki Manual - What's new?#GrampsBar|Gramps bar]], with references to [[#Filters|Filters]], [[Gramps 4.0 Wiki Manual - Filters|Filters]] and [[Gramps_4.0_Wiki_Manual_-_Gramplets#Sidebar_and_bottombar|Sidebar and bottombar]]'')
+
The Sidebar and Bottombar can be individually hidden or revealed by options in menu {{man menu|View}}. If the Sidebar is not displayed, then the {{man label|Search bar}} is displayed instead.
  
The Navigator, Toolbar, Sidebar and Bottombar can be individually turned on or off by options in menu {{man menu|View}}. If the Sidebar is not displayed, then the {{man label|Search bar}} is displayed instead.
+
[[Image:MainwinSearchbarannotated-40.png|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Search Bar]]
  
[[Image:Searchbarannotated.png|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Search Bar]]
 
 
{{-}}
 
{{-}}
If Gramps detects a minor error, or wishes to notify you about an occurrence within the program, then Gramps may display a warning button, as shown below. This button is only displayed for 180 seconds, so if you see it you should immediately click on it if you want to see the messages.
+
 
[[Image:Warning_button.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning button]]
+
== Switching Navigator modes ==
 +
 
 +
[[Image:Viewing_mode_selection.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Navigator mode selection]]
 +
If there is more than one navigator mode installed, you can choose the navigator mode with the drop down.
 
{{-}}
 
{{-}}
 
+
The navigator modes are "Category", "Drop-Down" and "Expander"
If you click the warning button, then a dialogue box appears showing the last 20 messages received. [[Logging_system|More details]]
 
[[Image:Warning_messages.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning messages]]
 
 
{{-}}
 
{{-}}
 +
[[Image:Mainwin-40.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Category navigator mode]]
  
More serious problems cause an error dialogue to appear which will describe the actions you should take.
+
[[Image:Drop-Down.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Drop-Down navigator mode]]
  
== The different Categories ==
+
[[Image:Expander.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Expander navigator mode]]
 +
{{-}}
 +
Note that in the Plugin Manager, Navigator modes are called Sidebar plugins, but this is inconsistent,because the {{man menu|View->Sidebar}} menu item removes the ''right-hand'' filter/gramplet sidebar, not the ''left-hand'' category sidebar.
 +
{{-}}
  
Genealogical information is very broad and can be extremely detailed. Displaying it poses a challenge that Gramps takes on by dividing and organizing the information into a series of Categories, each with their own Views. Each View displays a portion of the total information, selected according to a particular category. This will become clearer as we explore the different Categories.
+
== Switching Categories ==
  
The different Categories of the Navigator: The navigator is located at the left of the window and allows selection of the different categories (See: Fig. 3.1)
+
Gramps comes with number of different categories as standard. The built-in categories are described in [[Gramps_4.0_Wiki_Manual_-_Categories#Categories_of_the_Navigator|categories]]. You can [[4.0_Addons|download addon]] 'Gramps View's via the Preferences menu. If the view is a new or updated view for an existing category, then the view is added to that category. However, if the view is a view for a ''new'' category, then the new category is added to the navigator.  
  
*{{icon|gram}} '''Gramplets''': Displays different Gramplets, small widgets that can help in your genealogical research.
+
The way you change the currently displayed category depends on the navigator mode. Normally (for most navigator modes) you can select the category you want by clicking one of the navigator icons.
  
*{{icon|peop}} '''People''': Displays the people in the family tree without their connections. This Category contains the PeopleListView and the PeopleTreeView.
+
Alternatively you can use the keyboard shortcuts {{man key press|CTRL|P}} and {{man key press|CTRL|N}} go to the previous or next category respectively. If you have turned off the [[Gramps_4.0_Wiki_Manual_-_Main_Window#Navigator|navigator]] this will be the only way to change categories (unless you turn the navigator on again).
  
*{{icon|rela}} '''Relationships''': Shows the relationships between the Active Person and other people in a textual way. This includes parents, spouses, and children.
+
{{-}}
 
 
*{{icon|fami}} '''Families''': Shows the families in the family tree.
 
 
 
*{{icon|ance}} '''Charts''': Displays graphical trees for the selected person.
 
 
 
*{{icon|even}} '''Events''': Displays the events in the family tree.
 
 
 
*{{icon|plac}} '''Places''': Displays the places in the family tree.
 
 
 
*{{icon|geog}} '''Geography''': Displays data of your family tree on a map.
 
 
 
*{{icon|sour34}} '''Sources''': Displays the sources in the family tree.
 
 
 
*{{icon|cite}} '''Citations''': Displays the citations in the family tree.
 
 
 
*{{icon|repo}} '''Repositories''': Displays the repositories in the family tree.
 
 
 
*{{icon|medi}} '''Media''': Displays the media objects in the family tree.
 
 
 
*{{icon|note}} '''Notes''': Displays the notes in the family tree.
 
 
 
The categories can contain several ways of presenting the data. Each specific way is called a View. Before we launch into a description of each View, let's first explain how to switch between Views.
 
 
 
== Switching Views and Viewing Modes ==
 
 
 
[[Image:Mainwin-40.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sidebar view mode]]
 
 
 
Gramps comes with number of different Categories as standard. New Categories may be made with plugins you download. There are two different Viewing Modes. You can tell at a glance which Viewing Mode you are in: If you see icons listed vertically in a sidebar at the left of the window, you are in the Sidebar Viewing Mode (see Fig {{#var:chapter}}.{{#var:figure}}).
 
 
 
When you are in the Sidebar Viewing Mode, you can select the Category you want by clicking one of the sidebar icons.
 
  
Or you can also use the keyboard shorts {{man key press|CTRL|P}} and {{man key press|CTRL|N}} go to previous or next category.
+
== Switching Views ==
  
As mentioned, a category can contain different ways of presenting the data, called a View. If there are several views, you can switch between the views on the toolbar as each view will have an icon button. You can also switch via the menu {{man menu|View}}, or by pressing {{man key press|CTRL|<number>}}, where <number> is the view you want in this category.
+
A category can contain different ways of presenting the data, called a View. If there are several views, you can switch between the views. The way you change between the views depends on the viewing mode. In some viewing modes, there is an icon button on the toolbar to switch to a different view. You can also switch via the menu {{man menu|View}}, or by pressing {{man key press|CTRL|<number>}}, where <number> is the view you want in this category.
  
 
{{-}}
 
{{-}}
  
== Gramplets Category ==
+
== Column Editor ==
  
[[Image:GrampletsView-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramplets view]]
+
{{man note| Column Editor |The Column Editor is available in all Views and works the same way in each.}}
 
 
This contains the Gramplet View, which shows a number of widgets, called Gramplets, that can help you in your research. Two Gramplets are shown on start-up (the Welcome and Top Surname Gramplets). By right-clicking on the Gramplet View, a popup comes up with the possibility of adding other Gramplets.
 
 
 
*Age on Date Gramplet - see the people alive and their ages on a particular date
 
*Age Stats Gramplet - see age span graphs
 
*Attributes Gramplets - see active person's attributes
 
*Calendar Gramplet - see people's events on a particular date, or in a month in the past
 
*Descendants Gramplet - see the active person's descendants
 
*Fan Chart Gramplet - see the active person's pedigree, in a circular fan chart
 
*Given Name Cloud Gramplet - most popular given names
 
*Pedigree Gramplet - see a complete pedigree in compressed text
 
*Quick View - run a Quick View on the current person
 
*Records Gramplet - see world's records of your data
 
*Relatives Gramplet - see the relatives of the active person
 
*Session Log Gramplet - keep track of what you have done, and what records you have visited
 
*Statistics Gramplet  - see stats on the database
 
*Surname Cloud Gramplet - most popular surnames as a "text cloud"
 
*TODO Gramplet - a notepad to keep tabs on your research
 
*Top Surnames Gramplet - top 10 most popular surnames
 
*Welcome Gramplet - a GRAMPS welcome message
 
*What's Next Gramplet - what needs to be done next
 
 
 
In addition, there are a number of additional Gramplets that you can easily install and use. These include:
 
 
 
*Headline News Gramplet - current, breaking news from GRAMPS
 
*Data Entry Gramplet - edit active person's name, birth date and place, death date and place, and add people
 
*Python Gramplet - a Python shell
 
*FAQ Gramplet - frequently asked questions
 
*Note Gramplet - see and edit active person's primary Person Note
 
 
 
and many others. See [[Third-party Plugins]] for more details.
 
 
 
For more detailed information on using the installed Gramplets, see [[Gramps 4.0 Wiki Manual - Gramplets|Gramplets]].
 
 
 
== People Category ==
 
 
 
=== TreeView and ListView ===
 
 
 
[[Image:People_TreeView.png|left|thumb|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} People TreeView (default)]]
 
[[Image:People_ListView.png|right|thumb|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} People ListView]]
 
{{-}}
 
 
 
=== Configuration ===
 
  
 
[[Image:Column-editor-40.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Column Editor Dialog]]
 
[[Image:Column-editor-40.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Column Editor Dialog]]
  
The People View lists the people stored in the database(See Fig. People ListView). People are grouped according to their family names. To the left of each family name is typically either an arrow or some other type of indicator (eg: ''+''). Clicking it once will reveal the entire list of people sharing that name. Clicking the indicator again will "roll up" the list and show only the family name.
+
By default, the View List, displays several columns of information about the repective category. You can add or remove columns to and from the display by calling up the {{man label|Column Editor}} dialog from the menu {{man menu|View -> Configure View...}} or click on toolbar {{man button|Configure View...}} button and then checking or unchecking the boxes listed. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor ([http://en.wikipedia.org/wiki/Drag-and-drop ''drag and drop'']). Once you have made the changes you want, click {{man button|OK}} to exit the Editor and see your changes in the View.
 
 
By default, the People View List, displays several columns of information about each person. You can add or remove columns to and from the display by calling up the {{man label|Column Editor}} dialog from the menu {{man menu|View -> Configure View...}} or click on toolbar {{man button|Configure View...}} button and then checking or unchecking the boxes listed. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor ([http://en.wikipedia.org/wiki/Drag-and-drop ''drag and drop'']). Once you have made the changes you want, click {{man button|OK}} to exit the Editor and see your changes in the People View.
 
  
 
{{-}}
 
{{-}}
  
{{man note| Column Editor |The Column Editor is available in all Views and works the same way in each.}}
+
== Filters ==
 
 
=== Filters ===
 
  
[[Image:Side-filt.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Filter Controls Displayed]]
+
[[Image:SidebarFilter-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Filter Controls Displayed]]
  
 
Genealogical databases can contain information on many people, families, places, and objects. It is therefore possible for a View to contain a long list of data that is difficult to work with. Gramps gives you two different means for controlling this condition by allowing you to filter a list to a more manageable size.  
 
Genealogical databases can contain information on many people, families, places, and objects. It is therefore possible for a View to contain a long list of data that is difficult to work with. Gramps gives you two different means for controlling this condition by allowing you to filter a list to a more manageable size.  
Line 167: Line 106:
  
 
A search will search the text displayed in list, whereas filters display people whose data match the criteria of the filter.
 
A search will search the text displayed in list, whereas filters display people whose data match the criteria of the filter.
Search is a simple but fast method of searching the columns displayed on the screen. Typing the characters into the Search box and clicking the {{man button|Find}} button will display only lines that match the text.
 
  
Alternatively, you can enable the {{man label|Filter sidebar}}, which will be displayed on the right hand side of the display. When the filter sidebar is displayed, the {{man label|Search bar}} is not displayed. The Filter side bar allows you to interactively build a set of filter rules that can be applied to the display. The filter is applied based on the rules and the data, not on the screen display.
+
Search is a simple but fast method of searching the columns displayed on the screen. When the [[Gramps_4.0_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|sidebar]] is '''not''' displayed, the {{man label|Search bar}} is displayed. Typing the characters into the {{man label|Search bar}} and clicking the {{man button|Find}} button will display only lines that match the text.
 +
 
 +
Alternatively, you can enable a filter in either the [[Gramps_4.0_Wiki_Manual_-_Main_Window#Bottombar_and_Sidebar|bottombar or the sidebar]]. When the filter sidebar is displayed, the {{man label|Search bar}} is not displayed. The Filter allows you to interactively build a set of filter rules that can be applied to the display. The filter is applied based on the rules and the data, not on the screen display. Filters of the displayed category can also be constructed by clicking on the corresponding 'editor' button in the {{man menu|Edit}} menu.
 +
 
 +
Further details of how filters work is given [[Gramps_4.0_Wiki_Manual_-_Filters|here]]
  
 
{{-}}
 
{{-}}
Line 177: Line 119:
 
When Gramps opens a database, no filtering is in effect. In People View, for example, all people in the database are listed by default.
 
When Gramps opens a database, no filtering is in effect. In People View, for example, all people in the database are listed by default.
  
=== Sorting columns ===
+
== Sorting columns ==
  
[[Image:Sort_people_column.png|right|400px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sort Column]]
+
[[Image:Sortpeoplecolumn-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sort Column]]
  
 
Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns.
 
Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns.
Line 185: Line 127:
 
{{-}}
 
{{-}}
  
== Relationships Category ==
+
== When something goes wrong ==
  
[[Image:Family.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Relationships View]]
+
Sometimes something goes wrong, either because you have asked to do something that Gramps doesn't know how to do, or because something has happened that the developers of Gramps did not anticipate, or because there is a mistake in the coding of Gramps.
  
The Relationships View displays all the relationships of the Active Person (the selected person). Specifically, it shows his or her parents, siblings, spouses, and children.
+
This section explains what to do when something unexpected happens.
  
The Relationships View is designed to allow for quick navigation. You can quickly change the Active Person simply by clicking the name of any person listed on the page. Each name is actually a [http://en.wikipedia.org/wiki/Hyperlink hypertext link], similar to a web page.
+
{{man warn| Warning |Sometimes all the errors do not appear on the screen. If something unexpected happens, you may need to [[Gramps_4.0_Wiki_Manual_-_Main_Window#Seeing_all_the_error_messages|see all the error messages]]}}
  
The name of the Active Person is in '''bold''' style. Other names are shown either with or without '''''bold and italic''''' emphasis depending on whether certain relationships exist for the named person. For a person listed as a parent or spouse of the Active Person, the name is emphasized if that person has a parent family. For a person listed as a sibling or child of the Active Person, the name is emphasized if that person has children.
+
=== Alerts ===
  
Dates are normally in regular style, and in ''italic'' style if the displayed event is a fallback event, i.e., a substitute event for another missing event. That may be christening event for birth event, burial event for death event, etc.
+
An alert is a dialog that appears when Gramps needs to give you an important message about an error condition or warn you about potentially hazardous situations or consequences.
  
The Relationships View displays the following sections:
+
Most alerts are self explanatory, and the same type of alerts that you might get with any application. These are not discussed further here.
  
*Active Person: At the top of the screen, name, ID, birth, and death information, calculated age of the Active Person is displayed. If a photo of the person is available, it is shown on the right hand side. Next to the person's name is a symbol indicating gender, and an {{man button|[[Image:Gramps-notes.png|13px]]Edit}} button. Clicking the {{man button|[[Image:Gramps-notes.png|13px]]Edit}} button will allow you to edit all of the person's individual information in an {{man label|Edit Person}} dialog.
+
However, some alerts require more complicated actions, so they are described below.
 +
----
 +
[[Image:Need_to_upgrade_alert.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Upgrade Required Error]]
  
*Parents: The next section, the Parents section, displays the families in which the person is a child. Since it is possible for a person to have multiple sets of parents, it is possible to have several Parents sections.
+
This dialogue appears if you try to open a Family Tree created with a previous version of Gramps with a newer version of Gramps. If you still have the older version of Gramps available, then you should:
 
+
* cancel this dialogue,
You can control how much information is displayed by using the {{man menu|View}} menu. The view menu allows you to show or hide details (the birth and death information) and to show or hide siblings. Next to each person listed is an {{man button|[[Image:Gramps-notes.png|13px]]Edit}} button, which will allow you to edit all the details of that particular person.
+
* open the Family Tree with the previous version of Gramps,
 
+
* export your family tree in Gramps XML database export format or Gramps package export format (see [[Gramps_4.0_Wiki_Manual_-_Manage_Family_Trees#Export_into_Gramps_formats|Export into Gramps formats]]),
You may add a set of parents by either selecting the {{man button|Add Parents}} or the {{man button|Share Parents}} buttons. The {{man button|Add Parents}} button will create a new family with the Active Person listed as a child. The {{man button|Share Parents}} button will allow you to choose from a list of existing families, and then add the person as a child to that family.
+
* open the Family Tree in the new version of Gramps and click {{man button|Upgrade now}} in this dialogue
 
+
{{-}}
You may edit an existing parents by selecting the {{man button|[[Image:Gramps-notes.png|13px]]Edit}} button next to the parents. If you select the {{man button|-}} button next to a set of parents, then the Active Person will be removed as a child from the parents. This button does not delete the parents' relationship.
+
----
 
+
[[Image:Cannot_open_database.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Environment Error]]
{{man warn| Warning |If you are not careful, it is possible to create multiple families with the same parents. This is rarely what the user wants to do. If you attempt to add a new family that has the same parents as an existing family, Gramps will issue a warning dialog. If you get this dialog, you should probably Cancel the edit, and then use the {{man button|Select}} button to select the existing family.}}
 
 
 
*Family: Similar to the Parents section is the Family section, which displays families where the Active Person is a parent. Because it is possible to have multiple families, it is possible to have multiple Family sections. Each family section displays the spouse and any children.
 
  
{{man note | Spouse |We use the term spouse for sake of simplicity. However, please note that spouse may in fact be a domestic partner, a partner in a civil union, or various other similar relationships between two people. Spouse relationships are not required to be only between a male and female.}}
+
As explained in the dialogue, the Family Tree was probably created with an old version of the Berkeley database program. This is not quite the same thing as an old version of the Gramps program, because the version of the Gramps program and the version of the Berkeley database are independent. However, the effect is somewhat the same. As suggested in the dialogue, if you have the old version of Gramps and its support software, then you should:
 
+
* cancel this dialogue,
[[Image:Reorder.png|right|thumb|250px| Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Relation reordering]]
+
* open the Family Tree with the previous version of Gramps,
 
+
* export your family tree in Gramps XML database export format or Gramps package export format (see [[Gramps_4.0_Wiki_Manual_-_Manage_Family_Trees#Export_into_Gramps_formats|Export into Gramps formats]]),
You may add a family by selecting the {{man button|Add Spouse}} button in the toolbar. This will create a new family with the Active Person listed as a father or mother.
+
* start the new version of Gramps,
 
+
* open the 'Manage Family Tree' dialogue,
Selecting the {{man button|[[Image:Gramps-notes.png|13px]]Edit}} button next to the spouse will allow you to edit the displayed family. Clicking the {{man button|-}} button will remove the person from the displayed family.
+
* click on {{man button|new}} and create a new Family Tree,
 +
* load the new Family Tree
 +
* Import the Gramps XML or Gramps package.
  
 +
Alternatively, it may be possible to use the recovery tools. See 'obtain the bsddb recovery tools' under [[Recover corrupted family tree]]
 
{{-}}
 
{{-}}
 +
----
 +
[[Image:Low_level_database_corruption.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Error Dialogue]]
  
{{man warn| Removing a person from a family |Removing a person from a family does not delete the family. The person is removed as the father or mother, and any other relationships in the family continue to exist.}}
+
This dialogue appears when a problem is detected with the underlying database that supports Family Trees.
 
+
* close the dialogue,
{{man note | Note |We use the terms father and mother for the sake of simplicity. Even if there are no children in a family, the father and mother terminology is still used. In the case of male/male or female/female relationships, the father and mother labels should be considered to be convenience labels.}}
+
* click on the Family Tree Manager,
 
+
* select the Family Tree you were trying to open,
You can reorder the parents and spouses by selecting the {{man button|Reorder}} button. This option will only be enabled if more than one set of parents or more than one set of spouses exists for the Active Person. Selecting this button will display a dialog that will allow you to reorder the families.
+
* the {{man button|Repair}} button should be available; click on it,
 
+
* once the Family Tree has been repaired it should be possible to open it in the normal way.
=== Configuration ===
 
 
 
[[Image:Configure_RelView.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Configure Relationships View]]
 
 
 
You can configure the view from the display by calling up the {{man label|Configure}} dialog from the menu {{man menu|View -> Configure...}} or click on the toolbar {{man button|Configure View...}} button.
 
  
 +
If this does not work, try 'obtain the bsddb recovery tools' under [[Recover corrupted family tree]]
 
{{-}}
 
{{-}}
 +
----
 +
[[Image:DbDowngradeError.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Downgrade Error]]
  
== Families Category ==
+
Carry out suggested action.
 
 
[[Image:Family_List.png|right|500px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Family List View]]
 
 
 
The Family List View displays a list of all families in the database(see Fig. {{#var:chapter}}.{{#var:figure}}). From this view, you may add, edit, or delete families. The default display lists the ID, Father, Mother, Relationship and Marriage Date. Children cannot be displayed on the screen in this view.
 
 
 
 
{{-}}
 
{{-}}
 +
----
 +
[[Image:DbVersionError.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing DB Version Error]]
  
{{man warn| Remove button |Unlike the Relationships View, clicking the Remove button in this view will remove the family from the database. All people will remain, but all relationships between the people in the family will be removed.}}
+
Carry out suggested action.
 
 
== Charts Category ==
 
 
 
The Charts Category shows several graphical representations of the ancestry or descendants of the active person. By default Gramps shows the Pedigree View; With the Fan Chart View and Descendant Fan View being selectable from the toolbar. Installation of additional downloadable addons contain extra views.
 
 
 
=== Pedigree View===
 
 
 
[[Image:Pedigree.png|left|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Pedigree view 1]]
 
[[Image:Pedigree_layout.png|left|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Pedigree view layout]]
 
[[Image:Pedigree_2.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Pedigree view 2]]
 
[[Image:Pedigree_3.png|left|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Pedigree view 3]]
 
[[Image:Pedigree_4.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Pedigree view 4]]
 
[[Image:Pedigree-child-cut.png|left|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Children menu]]
 
 
 
The Pedigree View shows up to five generations, depending on the size of the window. Each person is indicated by a box labeled with his or her name, birth information (indicated by an asterisk * sign), death information (indicated by a plus + sign), a black stripe across the top left corner of the box if the person is deceased (or determined by Gramps to be no longer alive) and optionally an image if available. Two lines branch from each box. The top one shows the person's father and the bottom one the mother. Solid lines represent birth relations, while dashed lines represent non-birth relations such as adoption, step-parenthood, guardianship, etc.
 
 
 
To the left of the Active Person is a left arrow button. If the Active Person has children, clicking this button expands a list of the Active Person's children. Selecting one of the children makes that child the Active Person.
 
 
 
The appearance of the children's names in the menu differentiates the dead ends of the tree from the continuing branches.
 
 
 
Children who have children themselves appear in the menu in the boldface and italic type, while children without children (dead ends) appear in a regular font. If the Active Person has only one child, no menu will be displayed (since there is only one choice) and the child will become the Active Person when the arrow button is clicked.
 
 
 
The right-hand side of the window shows two right arrow buttons. When the top button is clicked, the Father of the Active Person becomes the Active Person. When the bottom button is clicked, the Mother of the Active Person becomes the Active Person.
 
 
 
[[Image:Pedigree-siblings-cut.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Personal context]]
 
 
 
Right-clicking on any person's box in the Pedigree View will bring up the "context menu".
 
 
 
Among other useful items, the context menu has sub-menus listing {{man label|Spouses}} , {{man label|Siblings}} , {{man label|Children}} , and {{man label|Parents}} of that person.
 
 
 
"Greyed-out" sub-menus indicate the absence of the data in the appropriate category. Similar to the children menu above, Childrens' and Parents' menus distinguish continuing lines from dead ends.
 
 
 
{{man tip|Screencasts|You can see videos for [[Media:Add_family_from_pedigree_view.ogg|adding]] or [[Media:Edit_family_from_pedigree_view.ogg|editing]] a family (parents, children, siblings) from Pedigree View.}}
 
 
 
 
{{-}}
 
{{-}}
 +
----
 +
[[Image:RunDatabaseRepair.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing Run Database Repair]]
  
=== Fan Chart View ===
+
Carry out suggested action.
 
 
[[Image:FanChartView-3.2.1.png|right|thumb|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Fan Chart View]]
 
 
 
This view shows the ancestry but as a pie chart. Clicking on a name in the chart will double the section of the pie allocated to that person. A second click brings the chart back to the original form. Right click brings up a context menu like in the pedigree view, allowing to navigate to other people.
 
 
 
This view enables to see large ancestries in a more compact manner, and to see very quickly which parts of an ancestry need further research.
 
 
 
You can rotate the view by click and drag outside the fan chart. You can move the view by click and drag inside the inner (white) region.
 
 
 
'''Coming in version 4.0:'''
 
 
 
#The view can be a circle, a halfcircle or a quadrant of a circle. The last are always attached to the bottom or side of the view
 
#Children of the center person are shown with a nice children ring at the center
 
#Drag and drop people to the center to change the active person
 
#Color options
 
:# Colors of the boxes based on the age of the people
 
:# Colors of the boxes depending on the time period the person lived in
 
:# White, classic, gender based, and user defined colors
 
# Filtering: use the person filter in the sidebar to quickly obtain insight in the people shown. For example: which people have birth events, who has the attribute ''blue eyes'', ... . Filtered results have bold font, the ones that don’t satisfy the filter are shown transparent
 
#Show up to 11 generations in the view.
 
#Print the view from the toolbar. The view as you see it (after rotating, expanding, changing color) can via the print button be printed or saved as svg (to edit further in Inkscape and view in eg Firefox), pdf or ps.
 
#The font used can be selected and becomes automatically smaller to fit the boxes. On a dark color, the font is white, otherwise black
 
 
 
To understand all, [https://plus.google.com/u/0/115195430424417504730/posts/QrXM4z9JxrG watch the screencast]
 
 
 
 
{{-}}
 
{{-}}
  
=== Descendant Fan View ===
+
=== Warnings ===
  
== Events Category ==
+
If Gramps detects a minor error, or wishes to notify you about an occurrence within the program, then Gramps may display a warning button, as shown below. This button is only displayed for 180 seconds, so if you see it you should immediately click on it if you want to see the messages.
  
[[Image:Events.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Events view]]
+
[[Image:Warning_button.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning button]]
 
 
Events can be shared between multiple people and multiple families. The Events View lists the all the events recorded in the database.
 
 
 
The columns available for display are:  {{man label|Description}} , {{man label|ID}} , {{man label|Type}} , {{man label|Main Participants}} , {{man label|Date}} , {{man label|Place}} and {{man label|Last Changed}}.
 
 
 
The default view displays the {{man label|Description}} , {{man label|ID}} , {{man label|Type}} , {{man label|Date}} and {{man label|Place}} of the event.  The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns.  This can be accessed from the {{man button|Configure View...}} button on the toolbar.
 
  
 
{{-}}
 
{{-}}
  
{{man warn| Meaningful event description |Because events can be shared, you should take the extra time to give each event a unique and meaningful description. This will help you find the correct event if you decide to share events.}}
+
If you click the warning button, then a dialogue box appears showing the last 20 messages received. [[Logging_system|More details]]
 
+
[[Image:Warning_messages.jpg|750px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramps Main Window showing Warning messages]]
The list of Events can be sorted in the usual manner, by clicking on the column heading. Clicking once sorts in ascending order, clicking again sorts in descending order.
 
 
 
== Places Category ==
 
 
 
[[Image:Places.png|thumb|250px|Fig. 3.25 Places view]]
 
 
 
The Places Views lists the geographical places in which the events of the database took place. These could be places of birth, death, and marriages of people, as well as their home, employment, education addresses, or any other conceivable reference to the geographical location. The Places View lists the places' {{man label|Name}} , {{man label|ID}} , {{man label|Church Parish}} , {{man label|City}} , {{man label|County}} , {{man label|State}} , and {{man label|Country}} . All of these columns can be used for sorting by clicking on a column heading.
 
 
 
Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog may be used to add, remove and rearrange the displayed columns.
 
 
 
If a place has been highlighted, you may select the {{man button|Google Maps, loading...}}  button to attempt to display the place in a web browser.
 
The map service can be chosen from the drop down list under the black triangle to the right of the map button.
 
 
 
Your default web browser should open, attempting to use either the longitude and latitude coordinates or the place name to display the location using the Google Maps web site. Different map services might have different requirements for the location description.
 
 
 
This feature is limited, and may not always produce the results you desire.
 
 
 
 
{{-}}
 
{{-}}
  
=== PlaceTreeView and PlaceListView ===
+
Some of the warnings that may appear are described below:
 
 
[[Image:Place_TreeView.png|left|thumb|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Places TreeView]]
 
[[Image:Place_ListView.png|right|thumb|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Places ListView]]
 
 
 
The two views in this category show the places grouped or ungrouped. The PlaceTreeView tries to group the places in logical groups: country, county, ... .
 
  
This view is new in Gramps version 4.0.0. (In future versions the aim is to make the grouping more intelligent. {{bug|???}})
+
==== Locale warnings ====
  
The PlaceListView on the other hand just shows all the places in one long list.
+
Sometimes there is a problem with the language you have chosen.  
  
{{-}}
+
If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) and are using your platform's built-in mechanism (System Setting/Control Panel/System Preferences) to choose the language/sort order/formats you are running in, then these errors should not occur, and may mean there is a problem in Gramps.
  
== Geography Category ==
+
However, if you have set the language/sort order/formats manually by setting the 'environment' see [[Gramps_4.0_Wiki_Manual_-_Getting_started#Languages| languages]], particularly if you are running Gramps from the command line, then there may be a problem with what you have typed in. The message (only part of which is shown below) should help you to understand where the error is.
  
{{man tip|Note|The Geography category is only present if OsmGpsMap is present that Gramps can use.}}
+
* "Date parser for '%s' not available, using default"
 +
* "Date displayer for '%s' not available, using default"
 +
* "Family relationship translator not available for language '%s'. Using 'english' instead."
 +
* 'Unable to determine your Locale, using English'
 +
* "Localization library libintl not on %PATH%, localization will be incomplete"
 +
* "No translations for %s were found, setting localization to U.S. English"
 +
* "Unable to create collator: %s"
 +
* "No language provided, using US English"
 +
* "No usable languages found in list, using US English"
 +
* "None of the requested languages (%s) were available, using %s instead"
  
[[Image:GeoView-3.2.0.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Geographic View]]
+
==== Module not loaded warnings ====
  
This category is for showing data on a map. It contains the Geographic View, which allows you to see the people and their events placed on a map via an internet map provider (OpenStreetMap or Google maps).
+
The Gramps application contains many different 'modules'. Some of these modules are required for Gramps to run at all; some are 'strongly recommend', and some are optional.
  
The Geographic View can:
+
If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) then the builder of that package will have decided which modules are present. He must include all the required modules, because otherwise Gramps will not run, but he can choose which of the recommended and optional packages he includes. Consult the documentation for your package (‘Ha Ha Only Kidding’) to determine which modules are included.
* show all places in your family tree
 
* show a filtered selection of places
 
* show all places connected to the active person
 
* show all places connected to the active family
 
* show all places connected to all events
 
* show all places connected to a filtered selection of events
 
  
These options are accessible via the buttons on the toolbar. To filter on places or events, activate the filter sidebar via the menu {{man menu|View->Filter Sidebar}}
+
If you try to do something that needs a module that is not included, then you will get a warning like the ones below (only the first part of the message is included). What you can do about it depends on your platform:
  
Furthermore, the Geographic view can help you add new places to your family tree, or add latitude-longitude coordinates to existing places. To activate this, use the {{man button|add location}} button, or the {{man button|link location}} button in the toolbar.  
+
'''Linux'''
 +
You should be able to install the package using your distribution's standard Package Manager or the GUI interface to the Package Manager. However, in some cases you will need to build the module from source.
  
The top of the Geographic View shows two lines with information, allowing you to change the information shown. The second line always shows in bold what is shown on the map.
+
'''MS Windows and Mac OS X'''
 +
The MS Windows AIO installer and the Max OS X Application bundle come with certain modules built in. It is not possible for the normal user to add further modules. Therefore, if you find a module that you particularly feel should be included you should post on the Gramps [[Contact#Mailing_lists|mailing list]] (probably the devel list) explaining why you feel its omission is a mistake.
  
The first line has:
+
* "WARNING: PIL module not loaded. "
* {{man button|Place list}} button and selection field.
+
* "ICU not loaded because %s. Localization will be impaired. "
: The button shows how many places are present in the map. The selection fields allows you to jump to one of these places. You can clear the selection field by clicking the places list button.  
+
* "OsmGpsMap module not loaded. "
* {{man button|Place page}} buttons
+
* "GExiv2 module not loaded. "
: If there are many places, the map is no longer useful because too much information is shown. Therefore, the places will be divided in pages. You can navigate the pages and see the map change via the Place page buttons: {{man button|<<}} goes back a page,  {{man button|>>}} goes forward a page, and the middle button shows how many pages there are and what is shown at the moment.
+
* "Webkit module not loaded. "
* Places with no latitude-longitude
+
* "PIL (Python Imaging Library) not loaded. "
:The Geographic View can only show places with a valid latitude-longitude. A list of all places that satisfy the selection, but cannot be put on the map, is available via the button with a number and the {{man button|?}} sign. You can add latitude-longitude to these places in one of the following ways:
+
* "GtkSpell not loaded. "
:* Use the place link button on the Geographic View
 
:* Go to the Place View, and use the {{man button|Go}} button to search the place and it's location
 
:* Download the [[Place completion tool]] via the menu {{man menu|Help->Plugin Manager}}. If you download the data of your country, this tool can add latitude-longitude to all your places.
 
*lock zoom level.
 
:If you zoom the map to a resolution you want to keep, then you can press the lock zoom level button, and every time the Geographic View redraws the map, this zoomlevel will be used.
 
*provider selection change
 
:Gramps uses OpenStreetMap or Google Maps to provide the map that is displayed. With this button you can quickly change from one to the other. The advantage of [http://www.openstreetmap.org/ OpenStreetMap] is that it is a free project, so you can update the maps yourself with missing information via their website.
 
  
Via the toolbar {{man button|Configure View...}} button (or via the menu {{man menu|View}}, the following functionality is available:
+
==== Configuration warnings ====
  
* Map options
+
Sometimes it is worth just deleting the old configuration files. TBD instructions on how to do this.
:* add crosshair in center of map, usefull to add or link places to the correct latitude-longitude coordinates
 
:* show coordinates in the statusbar
 
* Time period: this changes how the view divides events in groups
 
* Network: This view needs an internet connection. If your connection drops away from time to time, or is not always on, you can set here to have the Geographic view retry the internet connection. Like this, the Geographic view will become active the moment your internet connection returns, without you needing to take manual action.
 
  
== Sources Category ==
+
* "Importing old key file 'keys.ini'..."
 +
* "Done importing old key file 'keys.ini'"
 +
* "Can't find filter %s in the defined custom filters"
 +
* "Number of arguments does not match number of " +
 +
* "Value '%(val)s' not found for option '%(opt)s'"
 +
* "Unable to open recent file %s because %s",
 +
* "WARNING: ignoring old key '%s'"
 +
* "WARNING: ignoring key with wrong type "
 +
* "Failed to parse doc options"
 +
* "Skipped a line in the addon listing: "
 +
* "Failed to load gramplets from %s because %s"
  
[[Image:Sources-citationtreeview.png|left|300px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sources (Citation Tree) view]]
 
[[Image:Sources-sourceview.png|right|300px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sources view]]
 
  
Sources View lists the sources of certain information stored in the database.
+
====Other warnings ====
  
There are two views in this category. The default (Citation Tree View) shows all the sources, and for each it allows the user to see the Citations associated with that source by clicking on the disclosure triangle. The alternative view only shows the Sources.
+
TBD
  
Sources can include various documents (birth, death, and marriage certificates, etc.), books, films, journals, private diaries, - nearly anything that can provide genealogical evidence. Gramps gives you the option to provide a citation to a source for each event you record (births, deaths, marriages, etc.). The Sources View lists the {{man label|Title}} , {{man label|ID}} , and {{man label|Author}} of the source, as well as any {{man label|Publication}} information that may be associated with it.
+
=== Errors ===
  
The list of Sources can be sorted by clicking on a column heading.
+
More serious problems cause an error dialogue to appear which will describe the actions you should take. tbd. give example of the program error dialogue. Also explain what to do if Gramps suddenly quits, or if Gramps just won't start.
  
Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns.
+
[[Image:Unexpected_error.png|300px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing Unexpected error]]
  
{{-}}
+
This dialogue appears whenever something has happened in the Gramps application that the programmers did not expect.
  
== Citations Category ==
+
Have a look at [[How to create a good bug report]]. If you think you know how the Gramps developers might reproduce the bug, then by all means click on the 'Report' button. This will take you to the 'Report a bug' dialogue, and you can then follow the instructions.
  
[[Image:Citations-citationlistview.png|left|300px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Citation view]]
+
[[Image:Report_a_bug.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing reporting wizard]]
  
Citation View lists the citations for certain information stored in the database.
 
 
Citations specify which parts of a source are relevant to the information in the database. For example, a Source may be a book, and the citation may be a particular page in the book. Gramps gives you the option to provide a citation for each event you record (births, deaths, marriages, etc.). The Citations View lists the {{man label|Volume/Page}} , {{man label|ID}} , and {{man label|Date}} of the citation, as well as any {{man label|Confidence}} in the evidence.
 
 
The list of Citations can be sorted by clicking on a column heading.
 
 
Clicking once sorts in ascending order, clicking again sorts in descending order. The {{man label|Column Editor}} dialog can be used to add, remove and rearrange the displayed columns.
 
  
 
{{-}}
 
{{-}}
 +
==== Seeing all the error messages ====
 +
Sometimes, not all the information needed to understand what has gone wrong will appear on the screen. For example, if you start Gramps with an invalid language setting (and some missing components) then the message that appears in the Warning dialogue is:
  
== Repositories Category ==
+
[[Image:Warning_message_GExiv2.png|800px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dialogue showing limited warnings]]
 
 
[[Image:Repository.png|450px|right|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Repositories view]]
 
 
 
A repository can be thought of as a collection of sources.
 
 
 
Each source in the database can reference a repository (such as a library) in which it belongs. The functionality of the Repositories View is similar to the other views.
 
 
 
 
{{-}}
 
{{-}}
 +
However, the full set of warning messages is:
 +
(process:10929): Gtk-WARNING **: Locale not supported by C library.
 +
Using the fallback 'C' locale.
 +
2013-03-13 18:49:04.376: WARNING: __init__.py: line 69: Date parser for 'xx_XX.UTF-8' not available, using default
 +
2013-03-13 18:49:04.547: WARNING: __init__.py: line 85: Date displayer for 'xx_XX.UTF-8' not available, using default
 +
2013-03-13 18:49:05.949: WARNING: spell.py: line 74: Spelling checker is not installed
 +
2013-03-13 18:49:14.023: WARNING: gramplet.gpr.py: line 400: WARNING: GExiv2 module not loaded.  Image metadata functionality will not be available.
  
== Media Category ==
+
Sometimes Gramps just doesn't start and nothing appears on the screen, or Gramps suddenly quits so you don't see anything on the screen. In all these cases you may need to do something special to see all the errors.
  
[[Image:Media.png|right|400px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Media view]]
+
Linux
  
The Media View is a list of Media Objects used in the database.
+
You can start Gramps from the Command Line, as described in the note [[Gramps_4.0_Wiki_Manual_-_Getting_started#Linux| here]]. You will then see all the diagnostic information on the terminal.
  
Media Objects are any files that relate somehow to the stored genealogical data.
+
MS Windows
  
Technically, any file can be stored as a Media Object.
+
tbd
  
Most frequently, these are images, audio files, animation files, etc. The list box on the bottom lists the {{man label|Name}} , {{man label|ID}} , {{man label|Type}} , and {{man label|Path}} of the Media Object.
+
Mac OS X
  
The {{man label|Column Editor}} dialog may be used to rearrange the displayed columns, which obey usual sorting rules. The top part of the Gramps window shows a preview (if available) and information about the Media Object.
+
You can look at the messages shown by the Console application, and select Gramps.
  
 +
For example, one of the early alpha releases of Gramps 4.0.0 just would not start and displayed nothing on the screen. However by opening the Console application, and typing Gramps in the filter at the top right hand corner some diagnostic information appeared. (Actually we typed "gramps[" because there were some other messages that were not relevant, but it wouldn't matter if they were included as well).
 +
[[Image:Console_output.png|1000px|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Console output]]
 
{{-}}
 
{{-}}
 +
By shift clicking to select all the relevant messages and copying them we get:
 +
01/03/2013 00:08:02 [0x0-0x88088].org.gramps-project.gramps[1867] 2939: ERROR: importer.py: line 51: Could not find any typelib for Gtk
 +
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gtk typelib not installed. Install Gnome  Introspection, and pygobject version 3.3.2 or later.
 +
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gramps will terminate now.
  
== Notes Category ==
+
In this particular case, this was enough to help the developer discover the problem.
 
 
[[Image:Notesview.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Notes view]]
 
 
 
A Note is pure text, as stored in the other objects.
 
 
 
The functionality of the notes View is similar to the other views. The view lists all {{man label|Notes}} stored in the {{man label|Family Tree}}. Using the menu {{man menu|View ->Configure View...}} you open the {{man label|Column Editor}} and you can change the displayed columns. The possibilities are {{man label|Preview}}, {{man label|ID}}, {{man label| Type}} and {{man label|Marker}}.
 
 
 
The {{man label|Type}} can be (amongst others): ''Event Note'', ''Address Note'',''Source text'', ''Place Note''
 
 
 
Double-clicking on a Note in the list will bring up a window where you can edit the Note. You can change fonts, font color and background color. A spellchecker is available for ''English'' and your local language.
 
 
 
 
{{-}}
 
{{-}}
  
 
+
{{man index|Gramps 4.0 Wiki Manual - Getting Started|Gramps 4.0 Wiki Manual - Categories|4.0}}
{{man index|Gramps 4.0 Wiki Manual - Getting Started|Gramps 4.0 Wiki Manual - Manage Family Trees|4.0}}
 
  
 
{{languages|Gramps 4.0 Wiki Manual - Main Window}}
 
{{languages|Gramps 4.0 Wiki Manual - Main Window}}
  
 
[[Category:Documentation]]
 
[[Category:Documentation]]

Latest revision as of 08:24, 26 January 2014

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: [https://www.gramps-project.org/...]), not via internal links.
Also, only use the known Typographical conventions


Previous Index Next




Elements of Gramps main window.

Main Window

When you open a Family Tree database (either existing or new), the main Gramps window is displayed (Fig. 3.1):

Fig. 3.1 Gramps Main Window


The main Gramps window contains the following elements:

Window Title Bar

  • Window Title Bar shows the name of selected Family Tree, Gramps application name and buttons to minimize, maximize and close Gramps. The window can also be dragged from the Title Bar.

Menubar

  • Menubar: The menubar (Main Menu) is located at the very top of the window (right below the window title) and provides access to all the features of Gramps.

Toolbar

  • Toolbar: The toolbar is located right below the menubar. It gives you access to the most frequently used functions of Gramps. You can set options that control how it appears by going to the menu Edit ->Preferences.

The Toolbar can be hidden or revealed by the option in menu View ->Toolbar.

Navigator

  • Navigator: The navigator is located at the left of the window and allows selection of the different categories. See Categories of the Navigator

The Navigator can be hidden or revealed by the options in menu View ->Navigator.

Display area

  • Display area: The area in the center of the Gramps window is the display area. What it displays depends on the currently selected View. We will discuss Views in detail below.

Status Bar and Progress Bar

  • Status Bar and Progress Bar: These are located at the very bottom of the Gramps window.
    • The Progress Bar is located in the lower left corner of the Gramps window. It displays the progress of time consuming operations, such as opening and saving large Family Tree databases, importing and exporting to other formats, generating web sites, etc. When you are not doing these types of operations, the Progress Bar is not shown.
    • The Status Bar is located to the right of the Progress Bar. It displays information about current Gramps activity and contextual information about the selected items.

Bottombar and Sidebar

  • Bottombar: The bottombar is located below the display area.
  • Sidebar: The sidebar is located to the right of the display area.

The Bottombar and the Sidebar allow gramplets and filters to be displayed alongside a view.

The Sidebar and Bottombar can be individually hidden or revealed by options in menu View. If the Sidebar is not displayed, then the Search bar is displayed instead.

Fig. 3.2 Gramps Main Window showing Search Bar


Switching Navigator modes

Fig. 3.3 Navigator mode selection

If there is more than one navigator mode installed, you can choose the navigator mode with the drop down.
The navigator modes are "Category", "Drop-Down" and "Expander"

Fig. 3.4 Category navigator mode
Fig. 3.5 Drop-Down navigator mode
Fig. 3.6 Expander navigator mode


Note that in the Plugin Manager, Navigator modes are called Sidebar plugins, but this is inconsistent,because the View->Sidebar menu item removes the right-hand filter/gramplet sidebar, not the left-hand category sidebar.

Switching Categories

Gramps comes with number of different categories as standard. The built-in categories are described in categories. You can download addon 'Gramps View's via the Preferences menu. If the view is a new or updated view for an existing category, then the view is added to that category. However, if the view is a view for a new category, then the new category is added to the navigator.

The way you change the currently displayed category depends on the navigator mode. Normally (for most navigator modes) you can select the category you want by clicking one of the navigator icons.

Alternatively you can use the keyboard shortcuts CTRL+P and CTRL+N go to the previous or next category respectively. If you have turned off the navigator this will be the only way to change categories (unless you turn the navigator on again).


Switching Views

A category can contain different ways of presenting the data, called a View. If there are several views, you can switch between the views. The way you change between the views depends on the viewing mode. In some viewing modes, there is an icon button on the toolbar to switch to a different view. You can also switch via the menu View, or by pressing CTRL+<number>, where <number> is the view you want in this category.


Column Editor

Gramps-notes.png
Column Editor

The Column Editor is available in all Views and works the same way in each.

Fig. 3.7 Column Editor Dialog

By default, the View List, displays several columns of information about the repective category. You can add or remove columns to and from the display by calling up the Column Editor dialog from the menu View -> Configure View... or click on toolbar Configure View... button and then checking or unchecking the boxes listed. You can also change the position of a column in People View by clicking and dragging it to a new position in the Editor (drag and drop). Once you have made the changes you want, click OK to exit the Editor and see your changes in the View.


Filters

Fig. 3.8 Filter Controls Displayed

Genealogical databases can contain information on many people, families, places, and objects. It is therefore possible for a View to contain a long list of data that is difficult to work with. Gramps gives you two different means for controlling this condition by allowing you to filter a list to a more manageable size.

These methods are Search and Filtering.

A search will search the text displayed in list, whereas filters display people whose data match the criteria of the filter.

Search is a simple but fast method of searching the columns displayed on the screen. When the sidebar is not displayed, the Search bar is displayed. Typing the characters into the Search bar and clicking the Find button will display only lines that match the text.

Alternatively, you can enable a filter in either the bottombar or the sidebar. When the filter sidebar is displayed, the Search bar is not displayed. The Filter allows you to interactively build a set of filter rules that can be applied to the display. The filter is applied based on the rules and the data, not on the screen display. Filters of the displayed category can also be constructed by clicking on the corresponding 'editor' button in the Edit menu.

Further details of how filters work is given here


Tango-Dialog-information.png
Searching vs. Filtering

Searching only searches for exact text matches. If the date displayed is "Jan 1, 2000", a search of "1/1/2000" will fail, but a filter of "1/1/2000" will match.


When Gramps opens a database, no filtering is in effect. In People View, for example, all people in the database are listed by default.

Sorting columns

Fig. 3.9 Sort Column

Clicking once sorts in ascending order, clicking again sorts in descending order. The Column Editor dialog can be used to add, remove and rearrange the displayed columns.


When something goes wrong

Sometimes something goes wrong, either because you have asked to do something that Gramps doesn't know how to do, or because something has happened that the developers of Gramps did not anticipate, or because there is a mistake in the coding of Gramps.

This section explains what to do when something unexpected happens.

Gnome-important.png
Warning

Sometimes all the errors do not appear on the screen. If something unexpected happens, you may need to see all the error messages

Alerts

An alert is a dialog that appears when Gramps needs to give you an important message about an error condition or warn you about potentially hazardous situations or consequences.

Most alerts are self explanatory, and the same type of alerts that you might get with any application. These are not discussed further here.

However, some alerts require more complicated actions, so they are described below.


Fig. 3.10 Dialogue showing DB Upgrade Required Error

This dialogue appears if you try to open a Family Tree created with a previous version of Gramps with a newer version of Gramps. If you still have the older version of Gramps available, then you should:

  • cancel this dialogue,
  • open the Family Tree with the previous version of Gramps,
  • export your family tree in Gramps XML database export format or Gramps package export format (see Export into Gramps formats),
  • open the Family Tree in the new version of Gramps and click Upgrade now in this dialogue



Fig. 3.11 Dialogue showing DB Environment Error

As explained in the dialogue, the Family Tree was probably created with an old version of the Berkeley database program. This is not quite the same thing as an old version of the Gramps program, because the version of the Gramps program and the version of the Berkeley database are independent. However, the effect is somewhat the same. As suggested in the dialogue, if you have the old version of Gramps and its support software, then you should:

  • cancel this dialogue,
  • open the Family Tree with the previous version of Gramps,
  • export your family tree in Gramps XML database export format or Gramps package export format (see Export into Gramps formats),
  • start the new version of Gramps,
  • open the 'Manage Family Tree' dialogue,
  • click on new and create a new Family Tree,
  • load the new Family Tree
  • Import the Gramps XML or Gramps package.

Alternatively, it may be possible to use the recovery tools. See 'obtain the bsddb recovery tools' under Recover corrupted family tree


Fig. 3.12 Dialogue showing DB Error Dialogue

This dialogue appears when a problem is detected with the underlying database that supports Family Trees.

  • close the dialogue,
  • click on the Family Tree Manager,
  • select the Family Tree you were trying to open,
  • the Repair button should be available; click on it,
  • once the Family Tree has been repaired it should be possible to open it in the normal way.

If this does not work, try 'obtain the bsddb recovery tools' under Recover corrupted family tree


Fig. 3.13 Dialogue showing DB Downgrade Error

Carry out suggested action.


Fig. 3.14 Dialogue showing DB Version Error

Carry out suggested action.


Fig. 3.15 Dialogue showing Run Database Repair

Carry out suggested action.

Warnings

If Gramps detects a minor error, or wishes to notify you about an occurrence within the program, then Gramps may display a warning button, as shown below. This button is only displayed for 180 seconds, so if you see it you should immediately click on it if you want to see the messages.

Fig. 3.16 Gramps Main Window showing Warning button


If you click the warning button, then a dialogue box appears showing the last 20 messages received. More details

Fig. 3.17 Gramps Main Window showing Warning messages


Some of the warnings that may appear are described below:

Locale warnings

Sometimes there is a problem with the language you have chosen.

If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) and are using your platform's built-in mechanism (System Setting/Control Panel/System Preferences) to choose the language/sort order/formats you are running in, then these errors should not occur, and may mean there is a problem in Gramps.

However, if you have set the language/sort order/formats manually by setting the 'environment' see languages, particularly if you are running Gramps from the command line, then there may be a problem with what you have typed in. The message (only part of which is shown below) should help you to understand where the error is.

  • "Date parser for '%s' not available, using default"
  • "Date displayer for '%s' not available, using default"
  • "Family relationship translator not available for language '%s'. Using 'english' instead."
  • 'Unable to determine your Locale, using English'
  • "Localization library libintl not on %PATH%, localization will be incomplete"
  • "No translations for %s were found, setting localization to U.S. English"
  • "Unable to create collator: %s"
  • "No language provided, using US English"
  • "No usable languages found in list, using US English"
  • "None of the requested languages (%s) were available, using %s instead"

Module not loaded warnings

The Gramps application contains many different 'modules'. Some of these modules are required for Gramps to run at all; some are 'strongly recommend', and some are optional.

If you have installed Gramps using your platform's standard installation method (Package manager/AIO installer/Application package) then the builder of that package will have decided which modules are present. He must include all the required modules, because otherwise Gramps will not run, but he can choose which of the recommended and optional packages he includes. Consult the documentation for your package (‘Ha Ha Only Kidding’) to determine which modules are included.

If you try to do something that needs a module that is not included, then you will get a warning like the ones below (only the first part of the message is included). What you can do about it depends on your platform:

Linux You should be able to install the package using your distribution's standard Package Manager or the GUI interface to the Package Manager. However, in some cases you will need to build the module from source.

MS Windows and Mac OS X The MS Windows AIO installer and the Max OS X Application bundle come with certain modules built in. It is not possible for the normal user to add further modules. Therefore, if you find a module that you particularly feel should be included you should post on the Gramps mailing list (probably the devel list) explaining why you feel its omission is a mistake.

  • "WARNING: PIL module not loaded. "
  • "ICU not loaded because %s. Localization will be impaired. "
  • "OsmGpsMap module not loaded. "
  • "GExiv2 module not loaded. "
  • "Webkit module not loaded. "
  • "PIL (Python Imaging Library) not loaded. "
  • "GtkSpell not loaded. "

Configuration warnings

Sometimes it is worth just deleting the old configuration files. TBD instructions on how to do this.

  • "Importing old key file 'keys.ini'..."
  • "Done importing old key file 'keys.ini'"
  • "Can't find filter %s in the defined custom filters"
  • "Number of arguments does not match number of " +
  • "Value '%(val)s' not found for option '%(opt)s'"
  • "Unable to open recent file %s because %s",
  • "WARNING: ignoring old key '%s'"
  • "WARNING: ignoring key with wrong type "
  • "Failed to parse doc options"
  • "Skipped a line in the addon listing: "
  • "Failed to load gramplets from %s because %s"


Other warnings

TBD

Errors

More serious problems cause an error dialogue to appear which will describe the actions you should take. tbd. give example of the program error dialogue. Also explain what to do if Gramps suddenly quits, or if Gramps just won't start.

Fig. 3.18 Dialogue showing Unexpected error

This dialogue appears whenever something has happened in the Gramps application that the programmers did not expect.

Have a look at How to create a good bug report. If you think you know how the Gramps developers might reproduce the bug, then by all means click on the 'Report' button. This will take you to the 'Report a bug' dialogue, and you can then follow the instructions.

Fig. 3.19 Dialogue showing reporting wizard



Seeing all the error messages

Sometimes, not all the information needed to understand what has gone wrong will appear on the screen. For example, if you start Gramps with an invalid language setting (and some missing components) then the message that appears in the Warning dialogue is:

Fig. 3.20 Dialogue showing limited warnings


However, the full set of warning messages is:

(process:10929): Gtk-WARNING **: Locale not supported by C library.
	Using the fallback 'C' locale.
2013-03-13 18:49:04.376: WARNING: __init__.py: line 69: Date parser for 'xx_XX.UTF-8' not available, using default
2013-03-13 18:49:04.547: WARNING: __init__.py: line 85: Date displayer for 'xx_XX.UTF-8' not available, using default
2013-03-13 18:49:05.949: WARNING: spell.py: line 74: Spelling checker is not installed
2013-03-13 18:49:14.023: WARNING: gramplet.gpr.py: line 400: WARNING: GExiv2 module not loaded.  Image metadata functionality will not be available.

Sometimes Gramps just doesn't start and nothing appears on the screen, or Gramps suddenly quits so you don't see anything on the screen. In all these cases you may need to do something special to see all the errors.

Linux

You can start Gramps from the Command Line, as described in the note here. You will then see all the diagnostic information on the terminal.

MS Windows

tbd

Mac OS X

You can look at the messages shown by the Console application, and select Gramps.

For example, one of the early alpha releases of Gramps 4.0.0 just would not start and displayed nothing on the screen. However by opening the Console application, and typing Gramps in the filter at the top right hand corner some diagnostic information appeared. (Actually we typed "gramps[" because there were some other messages that were not relevant, but it wouldn't matter if they were included as well).

Fig. 3.21 Console output


By shift clicking to select all the relevant messages and copying them we get:

01/03/2013 00:08:02 [0x0-0x88088].org.gramps-project.gramps[1867] 2939: ERROR: importer.py: line 51: Could not find any typelib for Gtk 
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gtk typelib not installed. Install Gnome  Introspection, and pygobject version 3.3.2 or later. 
01/03/2013 00:08:05 [0x0-0x88088].org.gramps-project.gramps[1867] Gramps will terminate now. 

In this particular case, this was enough to help the developer discover the problem.

Previous Index Next