2021-12-04 - Sorry the Gramps wiki is currently being upgraded to a newer software version. Please check back after the 2021-12-06.

Difference between revisions of "PseudonymTree.gramps"

From Gramps
Jump to: navigation, search
m
m (See also)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
The '''[[File:GrampsPseudonymTree(02Feb2020).gz|GrampsPseudonymTree(02Feb2020).gz]]''' file ideally will have an example of the various relationships in Gramps.
+
{{stub}}
 +
The '''GrampsPseudonymTree''' example data is used to provide a self-explanatory & predictable Tree structute for testing, for exploring through charting options & filter rules, and for experimenting.
  
This is a standard Gramps backup file using the default gzip compression. Gramps would normally have a ''.gramps'' extension for these files but the wiki doesn't permit that extension for uploads. However, Gramps uses the typical gzip (GNU Zip archive, labeled with the extension ''.gz'') format files as its own archival format. So you can change the extension from ''.gz'' back to ''.gramps'' for full Gramps compatibility.
+
It is offered as an alternative to the [[Example.gramps|example.gramps]] file and supports a different learning modality. The GrampsPseudonymTree is more abstract and tries to avoid becoming obscured by non-essential detail. The idea is to avoid losing clear sight of the Tree's trunk & branches behind the leaves.
  
The GrampsPseudonymTree example is used to provide a predictable Tree environment for testing, for working through charting options & filter rules, and for experimenting.
+
The [[Image:Gramps-view.png|link=https://gramps-project.org/wiki/index.php/File:GrampsPseudonymTree(02Feb2020).gz]] '''[[:File:GrampsPseudonymTree(02Feb2020).gz|GrampsPseudonymTree(02Feb2020).gz]]''' file ideally will have an abstraction to represent the various relationships in Gramps.
  
 +
The 'names' are actually generic labels of the relationship. This allows sample reports, charts & filters to be run where the abstracted results automatically self-document & build their own lookup key. It is useful for verifying results when developing an add-on. If designing a '[[Gramps_Glossary#books report|book]]' collation of reports, running the book design on this abstracted Tree of data can produce the foundation for a 'how to interpret this book' section.
 +
 +
This abstracted data helps verify that the database was polled correctly and the data placement is appropriate. Also, when generating indexed output based on a [[Genealogical_Numbering_Systems|Genealogical Numbering System]], the output can be directly compared to the relationship without the need for a lookup or search in the database.
 +
 +
==About the file==
 +
 +
Gramps recognizes 2 variants of files labeled with the ''.gramps'' file format extension. There is a plain text file in a [[Gramps_XML|XML (e'''x'''tensible '''m'''arkup '''l'''anguage)]] structure & a [https://www.gzip.org/ GNU gzip] compressed archive containing that first variant format.
 +
 +
The actual downloadable file is a standard Gramps backup file which uses the compressed variant.  (The original 70K XML text file of the Tree compresses to a 9K archive.) This not only provides a faster download but also has a built-in checksum integrity validation to ensure the file transferred without damage.
 +
 +
Unfortunately, the wiki doesn't permit the Gramps extension for uploads. But since Gramps uses the typical gzip format as its own archival format and merely substitutes the ''.gramps'' extension for ''.gz'' normal extension) files, we'll use the more-standard ''.gz'' extension. After downloading, you can change the extension back to ''.gramps'' for full Gramps compatibility.
  
 
==Load <code>GrampsPseudonymTree(02Feb2020).gz</code>==
 
==Load <code>GrampsPseudonymTree(02Feb2020).gz</code>==
 
Follow these steps to load the example family tree:
 
Follow these steps to load the example family tree:
# Find the <code>GrampsPseudonymTree(02Feb2020).gz</code> or <code>GrampsPseudonymTree(02Feb2020).gramps</code> on your system. If the file is named <code>GrampsPseudonymTree(02Feb2020).gz</code>, you can rename it to <code>GrampsPseudonymTree(02Feb2020).gramps</code> and gramps will recognize it. You can copy this file to a temporary location or import it directly from this directory.
+
# Click the linked file at the top of this page
 +
# Find the <code>GrampsPseudonymTree(02Feb2020).gz</code> downloaded to your system. <br />Since the file is named <code>GrampsPseudonymTree(02Feb2020).gz</code>, you must rename it to <code>GrampsPseudonymTree(02Feb2020).gramps</code> before the Gramps import tool will recognize it. You can copy this renamed file to a temporary location or import it directly from this directory.
 
#* on MS-Windows AIO <code>C:\Program Files\GrampsAIO64-X.X.X\share\doc\gramps\example\gramps</code> (On MS-Windows ensure you can see hidden files; see  [[Gramps_{{Version manual}}_Wiki_Manual_-_User_Directory#MS_Windows|User Directory:MS Windows]])
 
#* on MS-Windows AIO <code>C:\Program Files\GrampsAIO64-X.X.X\share\doc\gramps\example\gramps</code> (On MS-Windows ensure you can see hidden files; see  [[Gramps_{{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 here 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]])
 
#* On Apple MacOS the example database is not included in the MacOS AIO(All in one package) and you may download the files from here 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]])
 
# Start Gramps
 
# Start Gramps
# To create a new family tree {{man menu|Family Trees > Manage Family Trees...}} select the {{man button|New}} button. Give it some name, such as ''psuedo''
+
# To create a new family tree {{man menu|Family Trees > Manage Family Trees...}} select the {{man button|New}} button. Give it some name to indicate that is a disposable tree, such as ''"pseudo"''
 
# Open this new family tree. It will be empty.
 
# Open this new family tree. It will be empty.
# In Gramps, use {{man menu|Family Trees > Import...}} to [[Gramps_{{Version manual}}_Wiki_Manual_-_Manage_Family_Trees#Importing_data|import]] <code>example.gramps</code>.
+
# In Gramps, use {{man menu|Family Trees > Import...}} to [[Gramps_{{Version manual}}_Wiki_Manual_-_Manage_Family_Trees#Importing_data|import]] <code>GrampsPseudonymTree(02Feb2020).gramps</code>.
#;Import Statistics of the example.gramps family tree  
+
 
 +
==Import Statistics of the GrampsPseudonymTree(02Feb2020).gramps family tree==
 
{| class="wikitable"
 
{| class="wikitable"
 
|
 
|
Line 29: Line 43:
 
* [[Tags_in_Gramps|{{man label|Tags}}]]: 1
 
* [[Tags_in_Gramps|{{man label|Tags}}]]: 1
 
* [[Citations#Why_Cite|{{man label|Citations}}]]: 12
 
* [[Citations#Why_Cite|{{man label|Citations}}]]: 12
 
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.
 
 
|[[File:GEDCOM-ImportStatistics-dialog-50.png|right|200px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Statistics - dialog]]
 
|[[File:GEDCOM-ImportStatistics-dialog-50.png|right|200px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Import Statistics - dialog]]
 
|}
 
|}
 
{{-}}
 
{{-}}
[[File:TopolaPsuedo.png|center|650px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Topola - window]]
+
==Sample Graphs==
 +
{| class="wikitable"
 +
|&nbsp; &nbsp; |[[File:2wayFanPseudo.png|left|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 2-Way Fan chart]]
 +
|[[File:TopolaPseudo.png|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Topola - window]]
 +
|}
 +
{{-}}
 +
==Grafting multiple Import branches together into a bigger test Tree==
 +
You can duplicate this branch to make a more varied Tree. Usually, repeated imports of the same data is a '''''very bad idea''''' and make a mess of duplicates.  But since this is a '''pseudo''' Tree, with placeholders instead of real people, duplicates are simply assumed to be non-duplicates.
 +
 
 +
As an example:
 +
# repeat the import
 +
# rename the newer "1 Progenitor" as "4 iii.(spouse) son-in-law"
 +
# copy the "4 iii.(spouse) son-in-law" to the clipboard
 +
# navigate the Relationship view to the remaining Progenitor's 3rd child, a daughter called "4 iii. Daughter"
 +
# drag "4 iii.(spouse) son-in-law" from the clipboard to the empty husband spot.
 +
 
 +
The 2 imported branches are now grafted together.  This also creates a 'blended' step-family example... the renamed "4 iii.(spouse) son-in-law" has another spouse &amp; offspring.
  
 
==Connecting to the example Media Objects==
 
==Connecting to the example Media Objects==
Line 47: Line 75:
 
* [[Data.gramps]]
 
* [[Data.gramps]]
 
* [[Example.gramps]]
 
* [[Example.gramps]]
 
+
* [https://github.com/gramps-project/gramps/tree/maintenance/gramps51/example/ Gramps-Project example files] (GitHub folder)
 +
* [[Plugins_Command_Line#Generate_Testcases_for_Persons_and_Families|testcase file generator]]
 +
* [https://www.tamurajones.net/GedFan.xhtml GedFan] : AhnenNumbered ([[Genealogical_Numbering_Systems#Ahnentafel|anentafel]] numbering system) pseudonym tree generator by Tamura Jones
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Gramps Examples]]
 
[[Category:Gramps Examples]]
 
[[Category:Genealogy]]
 
[[Category:Genealogy]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 06:36, 15 September 2021

Error creating thumbnail: Unable to save thumbnail to destination

Please update or expand this section.


The GrampsPseudonymTree example data is used to provide a self-explanatory & predictable Tree structute for testing, for exploring through charting options & filter rules, and for experimenting.

It is offered as an alternative to the example.gramps file and supports a different learning modality. The GrampsPseudonymTree is more abstract and tries to avoid becoming obscured by non-essential detail. The idea is to avoid losing clear sight of the Tree's trunk & branches behind the leaves.

The

Error creating thumbnail: Unable to save thumbnail to destination

GrampsPseudonymTree(02Feb2020).gz file ideally will have an abstraction to represent the various relationships in Gramps.

The 'names' are actually generic labels of the relationship. This allows sample reports, charts & filters to be run where the abstracted results automatically self-document & build their own lookup key. It is useful for verifying results when developing an add-on. If designing a 'book' collation of reports, running the book design on this abstracted Tree of data can produce the foundation for a 'how to interpret this book' section.

This abstracted data helps verify that the database was polled correctly and the data placement is appropriate. Also, when generating indexed output based on a Genealogical Numbering System, the output can be directly compared to the relationship without the need for a lookup or search in the database.

About the file

Gramps recognizes 2 variants of files labeled with the .gramps file format extension. There is a plain text file in a XML (extensible markup language) structure & a GNU gzip compressed archive containing that first variant format.

The actual downloadable file is a standard Gramps backup file which uses the compressed variant. (The original 70K XML text file of the Tree compresses to a 9K archive.) This not only provides a faster download but also has a built-in checksum integrity validation to ensure the file transferred without damage.

Unfortunately, the wiki doesn't permit the Gramps extension for uploads. But since Gramps uses the typical gzip format as its own archival format and merely substitutes the .gramps extension for .gz normal extension) files, we'll use the more-standard .gz extension. After downloading, you can change the extension back to .gramps for full Gramps compatibility.

Load GrampsPseudonymTree(02Feb2020).gz

Follow these steps to load the example family tree:

  1. Click the linked file at the top of this page
  2. Find the GrampsPseudonymTree(02Feb2020).gz downloaded to your system.
    Since the file is named GrampsPseudonymTree(02Feb2020).gz, you must rename it to GrampsPseudonymTree(02Feb2020).gramps before the Gramps import tool will recognize it. You can copy this renamed 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 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 here and import the Family Tree. (On MacOS ensure you can see hidden files; see: User Directory:Mac OS X)
  3. Start Gramps
  4. To create a new family tree Family Trees > Manage Family Trees... select the New button. Give it some name to indicate that is a disposable tree, such as "pseudo"
  5. Open this new family tree. It will be empty.
  6. In Gramps, use Family Trees > Import... to import GrampsPseudonymTree(02Feb2020).gramps.

Import Statistics of the GrampsPseudonymTree(02Feb2020).gramps family tree

Number of new objects imported:

Error creating thumbnail: Unable to save thumbnail to destination
Fig. .1 Import Statistics - dialog


Sample Graphs

Error creating thumbnail: Unable to save thumbnail to destination
Error creating thumbnail: Unable to save thumbnail to destination


Grafting multiple Import branches together into a bigger test Tree

You can duplicate this branch to make a more varied Tree. Usually, repeated imports of the same data is a very bad idea and make a mess of duplicates. But since this is a pseudo Tree, with placeholders instead of real people, duplicates are simply assumed to be non-duplicates.

As an example:

  1. repeat the import
  2. rename the newer "1 Progenitor" as "4 iii.(spouse) son-in-law"
  3. copy the "4 iii.(spouse) son-in-law" to the clipboard
  4. navigate the Relationship view to the remaining Progenitor's 3rd child, a daughter called "4 iii. Daughter"
  5. drag "4 iii.(spouse) son-in-law" from the clipboard to the empty husband spot.

The 2 imported branches are now grafted together. This also creates a 'blended' step-family example... the renamed "4 iii.(spouse) son-in-law" has another spouse & offspring.

Connecting to the example Media Objects

There are no example Media Objects (JPEG and PNG images) provided.l

See also