Open main menu

Gramps β

Changes

Example.gramps

629 bytes added, 06:43, 1 November 2025
m
no edit summary
{{languages|Example.gramps}}
==What is in an Example Tree?==
The example family tree database ('''<code>example.gramps</code>''' 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.
{{man tip|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.<br />&bull;  * If the problem happens there as well, then [[How_to_create_a_good_bug_report|file a bug report]]. <br />&bull;  * If the problem cannot be recreated using the example family tree, then you may need to [[Recover corrupted family tree|fix a corruption in your data]]. * If using an [[Previous_releases_of_Gramps|older Gramps version]], please mention that you have also tested with the current Gramps {{version}} version and that the issue is present.}} 
==The purpose of an Example Tree==
[[File:Importfamilytree-dialogLinux-51.png|thumb|right|400px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - Gnome for Ubuntu dialog example]]
[[File:Importfamilytree-dialog-51.png|thumb|right|400px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - Windows dialog example]]
[[File:Importfamilytree-dialogMac-51.png|thumb|right|400px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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.
==Load <code>example.gramps</code>==
 
{{man warn|1=Importing can create a mess!|2=Be careful that you do NOT import the [[Example.gramps|example.gramps]] data into your own Family tree. Cleaning out the contamination of records related to thousands of fictitious people would be troublesome. Always double-check which tree is already loaded before importing a file.}}
[[File:Importfamilytree-dialogLinux-51.png|thumb|right|400px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - Gnome for Ubuntu dialog example]]
[[File:Importfamilytree-dialog-51.png|thumb|right|400px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - Windows dialog example]]
[[File:Importfamilytree-dialogMac-51.png|thumb|right|400px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family Tree - macOS dialog example]]
 
Follow these steps to bring the external file "'''example.gramps'''" into a family tree database:
# Find <code>example.gramps</code> or <code>example.gramps.gz</code> on your system.<br />For example in each Operating System:
#* on Linux, <code>/usr/share/doc/gramps/example/gramps/</code>. If the file is named <code>example.gramps.gz</code>, rename it to <code>example.gramps</code> and gramps will recognize it. You can copy this file to a temporary location or import it directly from this directory.
#* on MS-Windows v{{template:Version windows AIO64}} AIO, <code>C:\Program&nbsp;Files\GrampsAIO64-{{template:Version windows AIO64}}\share\doc\gramps\example\gramps</code> (On MS-Windows, ensure you can see hidden files; see [[Gramps_{{Version manualman version}}_Wiki_Manual_-_User_Directory#MS_Windows|User Directory:MS Windows]])
#* on Apple macOS, the example database is located inside the application bundle at <code>/Applications/Gramps.app/Contents/Resources/share/doc/gramps/example/gramps/</code>
# Start Gramps
# Create a new family tree [[File:FamilyTrees-ManageDatabases-icon-toolbar-5160.png|right|thumb|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Manage databases - icon on toolbar (Same as using menu {{man menu|Family Trees &#x27a1; Manage Family Trees...}})]]#* If the "Family Tree - Gramps" dialog did not appear automatically when starting Gramps, select the {{man menu|Family Tree &#x27a1; Manage Family Trees...}} menu option or use the [[Gramps_5.1_Wiki_Manual_Gramps_{{man version}}_Wiki_Manual_-_Keybindings|keybinding]] {{man key press|Ctrl|o}}
#* select the {{man button|New}} button.
#* Give it some name, such as ''example''
#* select the {{man button|Load Family Tree}} button to open this highlighted new family tree. ''With this empty tree, the interface will be distressingly bare.''
# [[Gramps_{{Version manualman version}}_Wiki_Manual_-_Manage_Family_Trees#Importing_data|importImport]] the example.gramps file#* Use {{man menu|Family Trees &#x27a1; Import...}} menu or use the [[Gramps_5.1_Wiki_Manual_Gramps_{{man version}}_Wiki_Manual_-_Keybindings#2|keybinding]] {{Man key press|Ctrl|i}} to open the [[File Chooser|File Chooser]]#* browse to the folder found in step 1<br />''The default file chooser navigation option for filepaths is to displaying each hierarchical level using clickable [https://wikipedia.org/wiki/Breadcrumb_navigation breadcrumb navigation]. If you would rather type (or paste) in the path found above, press the {{man key press|Ctrl|L}} keybinding to swtch switch from breadcrumbs to an editable text box.''
#* click the <code>example.gramps</code> item to highlight (aka "select") the file
#* click the highlighted file again to begin the import
 
====Import Statistics of the example.gramps family tree====
{| class="wikitable"
the media directory you can set in the preferences,
or, if not set, relative to the user's directory.
|[[File:GEDCOM-ImportStatistics-dialog-50example-GrampXML-52.png|right|200px|thumb|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Statistics - dialog]]
|}
==Connecting to the example Media Objects==
[[File:Broken Media PathBrokenMediaPath-example-60.png|right|350px|thumb|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Media object with a broken filepath]]There are seven example Media Objects (images in JPEG and PNG file format) distributed with the '''example.gramps''' tree. The filepaths specified in the tree use a relative media path as the starting point (the {{man label|Base media path for relative media paths:}}). The default directory (defined in the Preferences) uses a different starting point.
So these images won't be locatable until the media path has been re-defined. And the Preview thumbnails will display 'broken link' icon of a box with a red 'x'.( See: User manual section [[Gramps_5.2_Wiki_Manual_-_Settings#Missing_Media_Objects_.27broken_link.27_icon_of_a_box_with_a_red_.27x.27|Missing Media Objects 'broken link' icon of a box with a red 'x']] )
The media path can be reset now or if starting to experiment with images.
* (1) In {{man menu|Edit > Preferences}}, change the {{man label|Base media path:}} in the [[Gramps_{{Version manualman version}}_Wiki_Manual_-_Settings#Family_Tree|{{man label|Family Tree}}]] tab in the {{man label|[[Gramps_{{man version}}_Wiki_Manual_-_Settings#Family_Tree.27s_Media_path|Family Tree's Media path]]}} section. This could be in a new directory, to keep it separate to your own family tree media. (<abbr title="exempli gratia - Latin phrase meaning 'for example'">e.g.</abbr> On Linux <code>~/gramps/example/</code>)** For Gramps 5.1.x and earlier the setting is found in {{man menu|Edit > Preferences}}, change the {{man label|Base path for relative media paths:}} in the [[Gramps_{{Version manual}}_Wiki_Manual_Gramps_5.1_Wiki_Manual_-_Settings#General|{{man label|General}}]] tab. This could be in a new directory, to keep it separate to your own family tree media. (<abbr title="exempli gratia - Latin phrase meaning 'for example'">e.g.</abbr> On Linux <code>~/gramps/example/</code>)
* Copy the media files from the example directory (that you found in step 1, above) to this media path directory.
{{man note|The '''example.gramps''' family tree data file| Alternately, a replacement Gramps ''[https://raw.githubusercontent.com/gramps-project/gramps/maintenance/gramps52gramps60/example/gramps/example.gramps example.gramps]'' [[XML|{{man label|XML}}]] family tree database file (without the Media Objects) can be downloaded from the GitHub file store.}}{{-}}
==See also==