Open main menu

Gramps β

Changes

Example.gramps

5,078 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|If Before filing a bug report...|Is your Tree damaged? When you think suspect that you have discovered an issue/(aka 'bug ') in your ''Family Tree''/databaseGramps, first try the same operation with the example family tree.| * If the problem happens there as well, then it is probably not due [[How_to_create_a_good_bug_report|file a bug report]].  * If the problem cannot be recreated using the example family tree, then you may need to a [[Recover corrupted family tree|fix a corruption in your data]].}} * If using an [[File:Importfamilytree-dialogLinux-51.pngPrevious_releases_of_Gramps|thumb|right|400px|Fig. older Gramps version]], please mention that you have also tested with the current Gramps {{#var:chapterversion}}version and that the issue is present.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Family  ==The purpose of an Example Tree - Gnome ==Your installation of Gramps should include some example family tree data. This data is used for working through tutorials and for Ubuntu dialog 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, [[File:Importfamilytree-dialog-51Category:How_do_I...png|thumb|right|400px|Fig"How do I.. {{#var:chapter}}.{{#vardefineecho" tutorials]] and screen-capture [[Special:figureListFiles|{{#exprillustrations (aka figures)]] in this wiki are based on this example data freshly imported into a newly created (empty) tree. So, by using this data when following instructions on a new technique, you should see the same results.  This eliminates the ambiguity and wonder if a different result was because you didn't correctly apply the technique or your data had a critical difference. That lets you focus appropriately:on improving your technique or repairing your data. Such a tree can be considered to be 'expendable.' If you accidentally mangle the tree then simply [[Gramps_{{#var:figureman version}}+1}}}} Import Family _Wiki_Manual_-_Manage_Family_Trees#Deleting_a_Family_Tree|discard the Tree - Windows dialog example]], create a [[File:Importfamilytree-dialogMac-51.png|thumb|right|400px|Fig. Gramps_{{#var:chapterman version}}.{{_Wiki_Manual_-_Manage_Family_Trees#vardefineecho:figureStarting_a_new_Family_Tree|new Tree]] and [[Gramps_{{#expr:{{#var:figure}}+1}man version}}} Import Family Tree _Wiki_Manual_- macOS dialog _Manage_Family_Trees#Importing_data|import]] the examplefamily tree data again. The example is also used to 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 [[How_to_create_a_good_bug_report#Creating_a_test_database|describing how to recreate the data]]before [[How_to_create_a_good_bug_report#Recording_the_steps_that_reproduce_the_bug|describing the issue]].
Your installation of Gramps should include an example family tree database. This is used to provide a known stable environment for testing, for working through tutorials, and for experimenting.
__TOC__
==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 load bring the external file "'''example .gramps'''" into a family treedatabase:# Find <code>example.gramps.gz</code> or <code>example.gramps.gz</code> on your system. <br />For examplein 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-X.X.X{{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 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_{{Version manual}}_Wiki_Manual_-_User_Directory#Mac_OS_X|User Directory:Mac OS X]])#** If installed via [https://wikipedia.org/wiki/Homebrew_(package_manager) Homebrew]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
# To create Create a new family tree [[File:FamilyTrees-ManageDatabases-icon-toolbar-60.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_{{man version}}_Wiki_Manual_-_Keybindings|keybinding]] {{man key press|Ctrl|o}}#* select the {{man button|New}} button. #* Give it some name, such as ''example''# Open * select the {{man button|Load Family Tree}} button to open this highlighted new family tree. It ''With this empty tree, the interface will be emptydistressingly bare.''# [[Gramps_{{man version}}_Wiki_Manual_-_Manage_Family_Trees#Importing_data|Import]] the example.gramps file# In Gramps, use * Use {{man menu|Family Trees > &#x27a1; Import...}} to menu or use the [[Gramps_{{Version manualman version}}_Wiki_Manual_-_Manage_Family_Trees_Keybindings#Importing_data2|keybinding]] {{Man key press|Ctrl|i}} to open the [[File Chooser|importFile 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 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. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Statistics - dialog]]
|}
==Connecting to the example Media Objects==
[[File:BrokenMediaPath-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 imagesfile format) provided but 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 Pathmedia path:}}) hasn't been . The default directory (defined in the Preferences) uses a different starting point.  So these images won't be displayed 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 for relative media paths:}} in the [[Gramps_{{Version manualman version}}_Wiki_Manual_-_Settings#GeneralFamily_Tree|{{man label|GeneralFamily Tree}}]] tabin 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. (eg <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_5.1_Wiki_Manual_-_Settings# General|{{man label|General}}]] tab.* 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/gramps51gramps60/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==
* [https://youtu.be/L5fXrfETAUw Gramps Tutorial #2: Creating Backups & Updating your Software] YouTube video by [https://www.youtube.com/channel/UCVIYPTJ3MGttLICyJDBZeSw TechTutorials].<br />''Importing the [[Example.gramps]] Tree begins at 17 minutes 4 seconds.''
* [[Template:Backup_Omissions|Backup omissions]] - what is not included during a backup* [[How to make a backup]]* [[Recover corrupted family tree]]* [[Data.gramps]] - a smaller (60 person) sample file* sample.ged - a 42 person [[Gramps_Glossary#gedcom|GEDCOM]] tree <br />''(hint: GEDCOM files do not specify a [[Gramps_Glossary#home_person|Home Person]]. Edwin Michael Smith is a reasonable person to [[Gramps_GlossaryGramps_{{man version}}_Wiki_Manual_-_Settings#home_personSetting_Home_person|set as Home Person]].)'': for MS Windows, located in <tt>C:\Program Files\GrampsAIO64-5.1.2{{template:Version windows AIO64}}\share\doc\gramps\example\gedcom\</tt>
* [[PseudonymTree.gramps|PseudonymTree.gramps]] - sample Pseudonym person Gramps tree for exploring filters & charts. (No Events or Media)
* [https://github.com/gramps-project/gramps/tree/maintenance/gramps51gramps52/example/ Gramps-Project example files] (GitHub folder)
* [[Plugins_Command_Line#Generate_Testcases_for_Persons_and_Families|testcase file generator]]
* Backup and data recovery
** [[How to make a backup]]
** [[Template:Backup_Omissions|Backup omissions]] - what is not included during a backup
** [[Recover corrupted family tree]]
* Feature request {{bug|12394}} : '''example.gramps''' tree changes requested for version 5.2 wiki manual illustration purposes
* Data added Jun 2015 to Example.gramps for [[Gramps_4.2_Wiki_Manual_-_What%27s_new%3F#Miscellaneous|Gramps 4.2]] : custom parent relationship, notes.
* [https://github.com/gramps-project/gramps/commits/ebc213f0accf12392925b7197d67e6e42b03bd78/example/gramps/example.gramps History] of Example.gramps changes
 
[[Category:Documentation]]
[[Category:Gramps Examples]]
[[Category:Genealogy]]
[[Category:Developers/General]]