Difference between revisions of "Addon:Consanguinity Gramplet"

From Gramps
Jump to: navigation, search
m
m (Adding the Consanguinity Gramplet)
(21 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Languages|Addon:Consanguinity_Gramplet}}
 
{{Languages|Addon:Consanguinity_Gramplet}}
 
{{Third-party plugin}}
 
{{Third-party plugin}}
{{man warn|1=&#x1F6A7; Work In Progress|2=This wikipage is an outline from a template being roughed in. Please don't edit '''''just yet'''''. Instead, contribute suggestions on the Discussion page. <br /><br />This page is not planned be linked to a public page until about 2 weeks after 30 September 2021. <br /><br />If this notice remains after that date, please feel welcome to remove this notice and consider the content 'fair game' for unlimited editing.}}
+
[[Gramps_Glossary#gramplet|Gramplet]] to show [https://wikipedia.org/wiki/Pedigree_collapse pedigree collapse] and spousal [[Genealogy_Glossary#consanguinity|consanguinity]] for the [[Gramps_Glossary#active_person|Active Person]].
[[Gramps_Glossary#gramplet|Gramplet]] to show pedigree collapse and spousal consanguinity for active person.
 
  
 +
== Usage ==
 +
[[File:ConsanguinityNotebook.png|thumb|right|267px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Detached Consanguinity Gramps - Notebook mode]]
 +
The Consanguinity gramplet displays information about the [[Gramps_Glossary#active_person|Active Person]] and any spouses.
  
<pre>
+
The Gramplet is updated whenever the Active Person focus shifts.
Garner, Barry Joseph (*14 Dec 1948)
 
 
 
Pedigree collapse for active person
 
  
Pedigree collapse at parents:
+
However, any open Pedigree and pedigree collapse diagram windows remain unchanged. This allows them to be used for navigating the Active Person focus and for direct comparison to windows opened on other persons.
Garner, Howard Lane (*9 Jul 1928)
+
=== Adding the Consanguinity Gramplet ===
Marín, Mary Anne (*13 Jan 1927)
+
The '''Consanguinity gramplet''' is designed to be added to the sidebar {{icon|rela}}[[Gramps_{{Version manual}}_Wiki_Manual_-_Categories#Relationships_Category|Relationships Category]] (''Grouped'' or ''List'') view modes of Gramps. (After [[{{man version}}_Addons#Manually_installed_Addons|manually installing]]<!--[[Third-party_Addons#Installing_Addons_in_Gramps|installation]]-->, this gramplet will be available for addition in all these locations: the [[Gramps_{{man version}}_Wiki_Manual_-_Gramplets#The_split-screen_Sidebar_.26_Bottombar|sidebar/bottombar option]] for the following views: {{icon|peop}}People, {{icon|rela}}Relationships, {{icon|ance}}Charts, and {{icon|geog}}Geography.) 
Relationship: third cousins once removed (down)
 
Common ancestors:
 
Howell, John
 
Yates, Sarah
 
  
Relationships between active person and partners
+
Select the {{man label|Consanguinity}} menu option from the {{man label|Add a gramplet}} submenu of the [[Gramps_{{man version}}_Wiki_Manual_-_Main_Window#Gramplet_Bar_Menu|Gramplet selection menus]]. Accessible by pressing the {{man button|&or;}} (''Down Arrowhead'' button) in the view's sidebar or bottombar.
 
 
Partner: Vázquez, April Lynn (*17 Sep 1963)
 
No common ancestors found.</pre>
 
== See also ==
 
* [https://github.com/hgboldt/consanguinuity Consanguinity source code] in Hans Boldt's GitHub repository
 
* [[Addon:RelatedRelativesGramplet|Related Relatives Gramplet]] - Display all persons in the database with a relation to a relative. A Gramplet by Heinz Brinker
 
*[[Screenshots|Screenshots]]
 
*[[Gramps_Glossary#gramplet|Gramplet]] Gramps Glossary definition
 
 
 
{{DEFAULTSORT:How do I...new category location|noreplace}}
 
[[Category:Plugins]]
 
[[Category:Gramplets]]
 
  
 +
=== Controls ===
 
<!--
 
<!--
<div style="background:lightcyan">
+
◉ selected &#128280; deselected
 +
-->
 +
*[[File:RadioButton_Selected.png|21px]] Single pane ''(default)''; a combined line of Active Person with spouse(s).
 +
*[[File:RadioButton_Deselected.png|21px]] Notebook; a tabbed view with each person separated. ''Shown in Figure 1.''
 +
*{{man button|Copy}} - copies the text of the window to the OS clipboard. 
 +
*{{man button|Display pedigrees}} - opens a tabbed window with ahnenlist numbered Ancestors. There will be a tab for each spouse 
  
 +
When detached (undocked), the floating dialog also has:
 +
*{{man button|Help}} - which links to this webpage 
 +
*{{man button|Close}} - which closes the floating dialog by returning it to its dock
  
Paste the raw '''[[:Category:Tutorials|Tutorials]]''' outline for the '''[[:Category:How_do_I...|How Do I...]]''' article above the '''See also''' section. This might start with pasting in a copy of a useful thread from one of the Gramps maillists.
+
== Example ==
 +
The sample tree included with Gramps includes a few instances of Pedigree Collapse.
  
 +
So to reproduce this diagram, import the [[Example.gramps|example.gramps]] file to a new tree.
  
Saving this file as a 'work in progress' will insert the code behind this reference template. (Preview only show the results, not the markup formatting control.) You can use the appended special formatting example template to pre-populate a virtual Copy&amp;Paste clipboard.  Snip pieces to paste special formatting to enhance the outline.
+
{{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.}}
  
----
+
Switch to the {{icon|peop}}People View via the navigator bar. Find ''Piatt D. Warner'' and make him the Active Person. (By selecting that row.)
  
Adding a ''feature documentation'' link pointing to the introduction of the interface element in the wiki will relieve you of the burden explaining how to find the feature.
+
Switch to the {{icon|rela}}Relationships View via the navigator bar. Add the Consanguinity gramplet to the view's sidebar as described in the [[#Usage|Usage]] section above. Resize the width the sidebar so that the contents fit comfortably.
 +
<!--Detach (undock) the gramplet by dragging its titlebar off the sidebar to the main window of Gramps.  Then arrange the undocked gramplet dialog where it won't interfere with seeing the view's data.-->
 +
{{-}}
 +
[[File:ConsanguinityDiagram.png|thumb|right|270px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Consanguinity diagram window (click a Relationship hotlink)]]
  
Finding a ''[[Gramps_Glossary|Gramps Glossary]] term'' to link may be easier than choosing the best introductory section in the wiki.  
+
[[File:ConsanguinityPedigree.png|thumb|right|258px|Fig. {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Consanguinity pedigree window (click the {{man button|Display pedigrees}} button)]]
  <small>&#91;&#91;Gramps_Glossary#active_person|Active Person]]
+
=== Explore the common ancestry ===
  &#91;&#91;Gramps_Glossary#P|Primary Object]]</small>
 
Glossary terms (like [[Gramps_Glossary#active_person|Active Person]] above) are normally lowercase and use an underscore between words. They have a brief description and may already have the introductory text and practical tutorial linked. You can fall back to the Letter index (like using '[[Gramps_Glossary#P|P]]' with [[Gramps_Glossary#P|Primary Object]] above) if you don't know the exact entry.
 
  
Since most of these ''How do I...'' tutorials are likely to have been prompted by a MailList discussion, a set of example 'See also' link are included for reference.  
+
Since ''Piatt D. Warner'' is the Active Person, the contents of the Consanguinity gramplet will be in the '''Single Pane''' mode (Figure 1 shows the '''Notebook''' mode where spouses are on separate pages) and look something like the following section. (Although the gramplet will have hotlinked People and Relationship.) The text below was created by clicking the {{man button|Copy}} button and pasting it into this article.
 +
<pre>
 +
Warner, Piatt D. (*9 Apr 1821, +11 Oct 1889)
  
Pointing the ''maillist archived thread'' link to the original message that inspired the tutorial give proper credit for the idea &amp; reveals the background discussion.
+
Pedigree collapse for active person
  
Pointing another link to a good search phrase for the archive allows similar discussions to be explored.
+
Pedigree collapse at great grandparents:
 +
Warner, Edward (*6 Jan 1713, +27 Sep 1776)
 +
Anderson, Mary Molly (*1719, +20 Apr 1795)
 +
Relationship: second cousins once removed (down)
 +
Common ancestors:
 +
Christiansen, Edward (*1607, +1684)
 +
Thomas, Elizabeth (*1620, +1713)
  
----
+
Relationships between active person and partners
  
Once the tutorial Preview is satisfactory, save a revision of the document. Then clean out the virtual Copy&amp;Paste clipboard cluttering up your tutorial and save a final revision.
+
Partner: Fox, Julia Colville (*25 Dec 1823, +12 Feb 1904)
 
+
Relationship: fifth cousins once removed (down)
 
+
Common ancestors:
To remove the virtual Copy&amp;Paste clipboard, simply delete everything from the beginning of this section to the bottom of the document. It is all disposable.
+
Christiansen, Edward (*1607, +1684)
 
+
Thomas, Elizabeth (*1620, +1713)
If the Copy&amp;Paste clipboard is needed again, simply paste the following line at the end of the Edit box, Save a revision, &amp; edit again.(Previewing isn't enough... a revision must be saved.)
+
Relationship: fifth cousins
<pre>  {{subst:Template:How_do_I}}</pre>
+
Common ancestors:
Other wiki [[:Category:Templates|Templates]] can be used as virtual Copy&amp;Paste clipboards in the same way.
+
Christiansen, Nathaniel (*15 May 1642, +21 Nov 1713)
 
+
Grenier, Mary (*about 1638, +12 Jul 1703)
 
 
</div>
 
[[Write_a_%22How_Do_I...%22_Article|Writing a 'How do I...' article.]]
 
<pre>
 
{{subst:Gramps_{{man version}}_Wiki_Manual_-_Preface}}
 
{{subst:WikiContributorRecruiting}
 
 
</pre>
 
</pre>
----
 
  
== (Section) ==
+
The hotlinks on the names of People will navigate the focus of Active Person selection to that person.
Stub, english (''default'')
 
{{Stub}}
 
  
{{Stub|fr}}
+
=== The Relationship diagram ===
Stub, french
+
Clicking the described {{man label|Relationship}} will open a block diagram of that instance of pedigree collapse and how it relates to the Active Person.
  
=== Embeddable Snippets (Subsection) ===
+
In the example ''shown in Figure 1'', Piatt Warner's great grandparents (Edward Warner and Mary Molly Anderson have the {{man label|Relationship:}} '''''second cousins once removed (down)''''' who are descended from the common ancestors, Edward Christiansen and Elizabeth Thomas. Clicking that relationship description opens a basic chart ''(shown in Figure 2)'' of their common ancestors and Piatt's relationship through them.
Icons
 
: {{icon|gram}} Dashboard
 
: {{icon|peop}} People
 
: {{icon|rela}} Relationships
 
: {{icon|fami}} Family Families
 
: {{icon|ance}} Charts
 
: {{icon|even}} Events
 
: {{icon|plac}} Places
 
: {{icon|geog}} Geography
 
: {{icon|sour34}} Sources
 
: {{icon|cite}} Citations
 
: {{icon|repo}} Repositories
 
: {{icon|medi}} Media
 
: {{icon|note}} Notes
 
:[[Template:Icon/doc|more of the standard icons]]
 
  
<small>
+
=== The Pedigree list ===
{|
+
Clicking the {{man button|Display pedigrees}} button opens a tabbed window with list format of an ahnentafel numbering system pedigree. The other tab contains the similarly numbered pedigree of the Active Person's spouse(s) but starting with the spouse in the #1 spot for their list. These numbers  Each list will only show a person '''''once''''', regardless of how much pedigree collapse exists for the Person in the #1 spot on that pedigree.
|+ List object tools
 
|-
 
! style="width: 70px"|
 
! style="width: 70px"|
 
! style="width: 70px"|
 
! style="width: 70px"|
 
! style="width: 70px"|
 
! style="width: 70px"|
 
|-
 
!{{icon|stock_add}}
 
!{{icon|share}}
 
!{{icon|stock_edit}}
 
!{{icon|stock_remove}}
 
!{{icon|up}}
 
!{{icon|down}}
 
|-
 
! Add
 
! Share
 
! Edit
 
! Remove
 
! <small>Move<br /></small>Upwards
 
! Move<br />Downwards
 
|}
 
</small>
 
  
==== [[Help:Formatting|Text formatting]] (Level 2 Subsection) ====
+
Clicking the {{man button|Copy}} button copies the text to the OS clipboard.  
''italic'', '''bold''', '''''bold & italic'''''
 
===== [[Help:Images#Uploaded_files|How to Add Images to a Gramps WikiMedia Article]] (Level 3 Subsection) =====
 
[[File:ChartsCategory-desendantfan-fullcircle-9gen-default-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} A screenshot caption]]
 
[[Image:Gramps-logo.png|Logo]]
 
  
====== Annotations of User Activities  (Level 4 Subsection) ======
+
A text list is more actionable when sharing with family and other genealogists than a diagram. A diagram makes understanding the relationship easier. But a list can be transcribed into a form or another program more easily.
  
*<pre>Commands you type at the command line</pre>
+
An example of Piatt's pedigree is shown in Figure 3. You will notice that the the lines for ancestors 152 and 153 are marked as being the same as ancestors 68 and 69 (Edward Christiansen and Elizabeth Thomas). This is where there is pedigree collapse for Piatt.  The rest of the list will crop out the ancestors of 152 and 153 because they too are duplicated. 
  
*''Filenames'' or <code>Filenames</code>
+
But which children were the siblings?  Just divide the ancestor number by 2 to get the number of their child. Half of 152 is 76 (Nathanial Christiansen) and half of 68 is 34 (off-screen in Figure 3 but this is Joseph Christiansen).  You can use this method in any Ahnentafel Numbering System. You can also use [https://wikipedia.org/wiki/Ahnentafel#Deductive_reckoning "deductive reckoning"] determine their exact relationship to the #1 person by their number. 
 +
{{-}}
  
*<tt>''Replaceable text''</tt>
+
== See also ==
 +
* [https://github.com/hgboldt/consanguinity Consanguinity source code] in Hans Boldt's GitHub repository
 +
* [[Addon:RelatedRelativesGramplet|Related Relatives Gramplet]] - Display all persons in the database with a relation to a relative. A Gramplet by Heinz Brinker
 +
*[[Screenshots|Screenshots]]
 +
*[[Gramps_Glossary#gramplet|Gramplet]] Gramps Glossary definition
  
*{{man label|Labels}} for buttons and other portions of the graphical interface
+
{{DEFAULTSORT:How do I...new category location|noreplace}}
 
+
[[Category:Plugins]]
*{{man tooltip|hint text}} for roll-over tooltip hints that identify elements of the graphical interface
+
[[Category:Gramplets]]
 
 
*Menu selections look like this: {{Man menu|Menu &#x27a1; Submenu &#x25B6; Menu Item}} (always pad unicode symbols like these arrows with spaces so that robot translators see recognizable words) Gramplet selection menus {{man button|&or;}} (''Down Arrowhead'' button)
 
* Pop-up menu down {{man button|&#x25BC;}} arrowhead, (triangle) button
 
 
 
*{{man button|Buttons}} you can click
 
 
 
*{{Man key press|CTRL|D}} see [[Gramps_{{man version}}_Wiki_Manual_-_Keybindings|Keybindings]] for a list of keyboard combinations used in Gramps.
 
 
 
*<tt>Anything you type in</tt>
 
 
 
*{{checkbox|1|Checked}} - [[Template:Checkbox|Selected Checkbox]] &#x2611; template
 
*{{checkbox|0|Unchecked}} - Checkbox that is &#x274f; unselected
 
 
 
== Boxed annotations ==
 
{{man tip| 1=Title of Tip |2=Tips text.}}
 
{{man note|Example Note |Notes text.}}
 
{{man warn|1=WarningTitle/Heading |2=warning text }}</onlyinclude>
 
-->
 

Revision as of 19:46, 2 October 2021

Gramps-notes.png

Please use carefully on data that is backed up, and help make it better by reporting any comments or problems to the author, or issues to the bug tracker
Unless otherwise stated on this page, you can download this addon by following these instructions.
Please note that some Addons have prerequisites that need to be installed before they can be used.
This Addon/Plugin system is controlled by the Plugin Manager.

Gramplet to show pedigree collapse and spousal consanguinity for the Active Person.

Usage

Fig. 1 Detached Consanguinity Gramps - Notebook mode

The Consanguinity gramplet displays information about the Active Person and any spouses.

The Gramplet is updated whenever the Active Person focus shifts.

However, any open Pedigree and pedigree collapse diagram windows remain unchanged. This allows them to be used for navigating the Active Person focus and for direct comparison to windows opened on other persons.

Adding the Consanguinity Gramplet

The Consanguinity gramplet is designed to be added to the sidebar RelationshipsRelationships Category (Grouped or List) view modes of Gramps. (After manually installing, this gramplet will be available for addition in all these locations: the sidebar/bottombar option for the following views: PeoplePeople, RelationshipsRelationships, ChartsCharts, and GeographyGeography.)

Select the Consanguinity menu option from the Add a gramplet submenu of the Gramplet selection menus. Accessible by pressing the (Down Arrowhead button) in the view's sidebar or bottombar.

Controls

  • RadioButton Selected.png Single pane (default); a combined line of Active Person with spouse(s).
  • RadioButton Deselected.png Notebook; a tabbed view with each person separated. Shown in Figure 1.
  • Copy - copies the text of the window to the OS clipboard.
  • Display pedigrees - opens a tabbed window with ahnenlist numbered Ancestors. There will be a tab for each spouse

When detached (undocked), the floating dialog also has:

  • Help - which links to this webpage
  • Close - which closes the floating dialog by returning it to its dock

Example

The sample tree included with Gramps includes a few instances of Pedigree Collapse.

So to reproduce this diagram, import the example.gramps file to a new tree.

Gnome-important.png
Importing can create a mess!

Be careful that you do NOT import the 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.

Switch to the PeoplePeople View via the navigator bar. Find Piatt D. Warner and make him the Active Person. (By selecting that row.)

Switch to the RelationshipsRelationships View via the navigator bar. Add the Consanguinity gramplet to the view's sidebar as described in the Usage section above. Resize the width the sidebar so that the contents fit comfortably.

Fig. 2 Consanguinity diagram window (click a Relationship hotlink)
Fig. 3 Consanguinity pedigree window (click the Display pedigrees button)

Explore the common ancestry

Since Piatt D. Warner is the Active Person, the contents of the Consanguinity gramplet will be in the Single Pane mode (Figure 1 shows the Notebook mode where spouses are on separate pages) and look something like the following section. (Although the gramplet will have hotlinked People and Relationship.) The text below was created by clicking the Copy button and pasting it into this article.

Warner, Piatt D. (*9 Apr 1821, +11 Oct 1889)

Pedigree collapse for active person

Pedigree collapse at great grandparents:
	Warner, Edward (*6 Jan 1713, +27 Sep 1776)
	Anderson, Mary Molly (*1719, +20 Apr 1795)
	Relationship: second cousins once removed (down)
	Common ancestors:
		Christiansen, Edward (*1607, +1684)
		Thomas, Elizabeth (*1620, +1713)

Relationships between active person and partners

Partner: Fox, Julia Colville (*25 Dec 1823, +12 Feb 1904)
	Relationship: fifth cousins once removed (down)
	Common ancestors:
		Christiansen, Edward (*1607, +1684)
		Thomas, Elizabeth (*1620, +1713)
	Relationship: fifth cousins
	Common ancestors:
		Christiansen, Nathaniel (*15 May 1642, +21 Nov 1713)
		Grenier, Mary (*about 1638, +12 Jul 1703)

The hotlinks on the names of People will navigate the focus of Active Person selection to that person.

The Relationship diagram

Clicking the described Relationship will open a block diagram of that instance of pedigree collapse and how it relates to the Active Person.

In the example shown in Figure 1, Piatt Warner's great grandparents (Edward Warner and Mary Molly Anderson have the Relationship: second cousins once removed (down) who are descended from the common ancestors, Edward Christiansen and Elizabeth Thomas. Clicking that relationship description opens a basic chart (shown in Figure 2) of their common ancestors and Piatt's relationship through them.

The Pedigree list

Clicking the Display pedigrees button opens a tabbed window with list format of an ahnentafel numbering system pedigree. The other tab contains the similarly numbered pedigree of the Active Person's spouse(s) but starting with the spouse in the #1 spot for their list. These numbers Each list will only show a person once, regardless of how much pedigree collapse exists for the Person in the #1 spot on that pedigree.

Clicking the Copy button copies the text to the OS clipboard.

A text list is more actionable when sharing with family and other genealogists than a diagram. A diagram makes understanding the relationship easier. But a list can be transcribed into a form or another program more easily.

An example of Piatt's pedigree is shown in Figure 3. You will notice that the the lines for ancestors 152 and 153 are marked as being the same as ancestors 68 and 69 (Edward Christiansen and Elizabeth Thomas). This is where there is pedigree collapse for Piatt. The rest of the list will crop out the ancestors of 152 and 153 because they too are duplicated.

But which children were the siblings? Just divide the ancestor number by 2 to get the number of their child. Half of 152 is 76 (Nathanial Christiansen) and half of 68 is 34 (off-screen in Figure 3 but this is Joseph Christiansen). You can use this method in any Ahnentafel Numbering System. You can also use "deductive reckoning" determine their exact relationship to the #1 person by their number.

See also