Example.gramps

What is in an Example Tree?

The example family tree database (example.gramps file) ideally will have an example of everything, at least one, of everything Gramps does, or which it is possible to do in Gramps, even if obscure etc.

Before filing a bug report... Is your Tree damaged? When you suspect that you have discovered an issue (aka 'bug') in Gramps, first try the same operation with the example family tree. • If the problem happens there as well, then file a bug report. • If the problem cannot be recreated using the example family tree, then you may need to fix a corruption in your data.

The purpose of an Example Tree

Fig. .1 Import Family Tree - Gnome for Ubuntu dialog example

Fig. .2 Import Family Tree - Windows dialog example

Fig. .3 Import Family Tree - macOS dialog example

Your installation of Gramps should include some example family tree data. This data is used for working through tutorials and for safely exploring tools or features.

And, because many of the features of Gramps cannot be explored until the Tree is populated with People, Families, Events, Places, Sources, Media and other types of data; importing the example data creates a playground for exploring Gramps.

Further, most of the examples, "How do I..." tutorials and screen-capture illustrations (aka figures) in this wiki are based on this example data freshly imported into a newly created (empty) tree. Such a tree can be considered to be 'expendable.' If you accidentally mangle the tree then simply discard the Tree, create a new Tree and import the example family tree data again.

The example is also used provide a known, stable and predictable environment for testing. Many conditions cannot be recreated without tree data. Using this tree (as a common frame of reference) eliminates the extra complexity of describing how to recreate the data before describing the issue.

Load example.gramps

Follow these steps to load the example family tree:

1. Find example.gramps.gz or example.gramps on your system. For example:
   • on Linux /usr/share/doc/gramps/example/gramps/. If the file is named example.gramps.gz, rename it to example.gramps and gramps will recognize it. You can copy this file to a temporary location or import it directly from this directory.
   • on MS-Windows AIO C:\Program Files\GrampsAIO64-X.X.X\share\doc\gramps\example\gramps (On MS-Windows ensure you can see hidden files; see [[Gramps_Template:Version manual_Wiki_Manual_-_User_Directory#MS_Windows|User Directory:MS Windows]])
   • on Apple MacOS
     • The example database is not included in the MacOS AIO(All in one package) and you may download the files from https://github.com/gramps-project/gramps/tree/maintenance/gramps51/example/gramps and import the Family Tree. (On MacOS ensure you can see hidden files; see: [[Gramps_Template:Version manual_Wiki_Manual_-_User_Directory#Mac_OS_X|User Directory:Mac OS X]])
     • If installed via Homebrew, the example database is located inside the application bundle at /Applications/Gramps.app/Contents/Resources/share/doc/gramps/example/gramps/
2. Start Gramps
3. To create a new family tree Family Trees > Manage Family Trees... select the New button. Give it some name, such as example
4. Open this new family tree. It will be empty.
5. In Gramps, use Family Trees > Import... to [[Gramps_Template:Version manual_Wiki_Manual_-_Manage_Family_Trees#Importing_data|import]] example.gramps.

   Import Statistics of the example.gramps family tree

Number of new objects imported: People: 2157 Families: 762 Sources: 4 Events: 3432 Media Objects: 7 Places: 1294 Repositories: 3 Notes: 19 Tags: 2 Citations: 2854 Media objects with relative paths have been imported. These paths are considered relative to the media directory you can set in the preferences, or, if not set, relative to the user's directory.

Fig. .4 Import Statistics - dialog

Connecting to the example Media Objects

Fig. .5 Media object with a broken filepath

There are seven example Media Objects (JPEG and PNG images) provided but the relative media path starting point (the Base Path) hasn't been defined in the Preferences. So these images won't be displayed until the media path has been re-defined. The media path can be reset now or if starting to experiment with images.

1. In Edit > Preferences, change the Base path for relative media paths: in the [[Gramps_Template:Version manual_Wiki_Manual_-_Settings#General|General]] tab. This could be in a new directory, to keep it separate to your own family tree media. (eg On Linux ~/gramps/example/)
2. Copy the media files from the example directory (that you found in step 1, above) to this media path directory.

The example.gramps family tree data file Alternately, a replacement Gramps example.gramps XML family tree database file (without the Media Objects) can be downloaded from the GitHub file store.

See also

• Gramps Tutorial #2: Creating Backups & Updating your Software YouTube video by TechTutorials.
  Importing the Example.gramps Tree begins at 17 minutes 4 seconds.
• Data.gramps - a smaller (60 person) sample file
• sample.ged - a 42 person GEDCOM tree
  (hint: GEDCOM files do not specify a Home Person. Edwin Michael Smith is a reasonable person to set as Home Person.)

for MS Windows, located in C:\Program Files\GrampsAIO64-6.0.8\share\doc\gramps\example\gedcom\

• PseudonymTree.gramps - sample Pseudonym person Gramps tree for exploring filters & charts. (No Events or Media)
• Gramps-Project example files (GitHub folder)
• testcase file generator
• Backup and data recovery
  • How to make a backup
  • Backup omissions - what is not included during a backup
  • Recover corrupted family tree