Difference between revisions of "Addon:Interactive Family Tree"

From Gramps
Jump to: navigation, search
(Added info page for Interactive Family Tree addon)
 
m
 
(23 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 +
{{languages|Addon:Interactive Family Tree}}
 
{{Third-party plugin}}
 
{{Third-party plugin}}
[[File:Topola.png|thumb|right|450px|Interactive Family Tree addon screenshot]]
+
{{man note|The Interactive Family Tree addon does not send any data out of your computer.|It is processed locally on your computer. Only the Topola JavaScript  Genealogy viewer application is downloaded so that it can run locally.}}
 +
[[File:Addon-Interactive-Family-Tree-Topola-example-51.png|thumb|right|450px|Interactive Family Tree addon screenshot.]]
 +
The '''Interactive Family Tree''' addon allows you to browse the family tree using the [https://pewu.github.io/topola-viewer/ Topola Genealogy Viewer].
 +
__TOC__
 +
==Usage==
 +
Select Menu {{man menu|Tools > Analysis and Exploration -> Interactive Family Tree...}} and then a web page will open with your family tree.
 +
 
 +
If the person you want to view is not shown you can search for them.
 +
 
 +
You can click on people to change the focus of the tree.
 +
 
 +
You can choose between three different views; Hourglass chart, All relatives and Fancy tree(experimental).
 +
 
 +
You can print or download the chart in various formats.
 +
 
 +
You can {{man button|+}} zoom in or {{man button|-}} zoom out on the chart.
 +
 
 +
==Features==
 +
 
 +
One of the features of this addon is that {{man label|the Interactive Family Tree addon does not send any data out of your computer.}}
 +
 
 +
This is something that is not obvious because what you see in the browser is a web application.
  
The '''Interactive Family Tree''' addon allows you to browse the family tree using the [https://pewu.github.io/topola-viewer/ Topola Genealogy Viewer].
+
===Technical details===
 +
 
 +
Here is a technical description of how the addon works.
 +
 
 +
On the Gramps side, the addon saves a temporary file in GEDCOM format and sets up a temporary local HTTP server inside Gramps that reads the GEDCOM file.
  
==Usage==
+
Then, the addon opens your browser pointing to a web application hosted on GitHub pages. That web application contains a GEDCOM parser and viewer that is loaded into your browser. The web application is a “single page application.” Once it is loaded from the GitHub server, it does not require further Internet connections to work. This is why you can open it from the browser’s cache even with no internet connection. (i.e., WiFi turned off) After the web application is loaded from cache, it reads the GEDCOM file from simple local HTTP server temporarily set up by Gramps. If the cached file expires and is purged, a fresh copy will need to be downloaded again.
Once this plugin has been installed, select Menu {{man menu|Tools > Analysis and Exploration -> Interactive Family Tree...}}.
+
{{man tip|Genealogy Data is not uploaded.|The data is only loaded locally into the browser’s memory and does not leave your computer. It is processed by JavaScript code to produce a visualization of the data.}}
  
A web page will open with your family tree. You can click on people to change the focus of the tree.
+
==See also==
 +
* [https://github.com/PeWu/topola-viewer/issues topola-viewer issues] on Github
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Tools]]
 
[[Category:Tools]]

Latest revision as of 03:13, 19 September 2022

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

Gramps-notes.png
The Interactive Family Tree addon does not send any data out of your computer.

It is processed locally on your computer. Only the Topola JavaScript Genealogy viewer application is downloaded so that it can run locally.

Interactive Family Tree addon screenshot.

The Interactive Family Tree addon allows you to browse the family tree using the Topola Genealogy Viewer.

Usage

Select Menu Tools > Analysis and Exploration -> Interactive Family Tree... and then a web page will open with your family tree.

If the person you want to view is not shown you can search for them.

You can click on people to change the focus of the tree.

You can choose between three different views; Hourglass chart, All relatives and Fancy tree(experimental).

You can print or download the chart in various formats.

You can + zoom in or - zoom out on the chart.

Features

One of the features of this addon is that the Interactive Family Tree addon does not send any data out of your computer.

This is something that is not obvious because what you see in the browser is a web application.

Technical details

Here is a technical description of how the addon works.

On the Gramps side, the addon saves a temporary file in GEDCOM format and sets up a temporary local HTTP server inside Gramps that reads the GEDCOM file.

Then, the addon opens your browser pointing to a web application hosted on GitHub pages. That web application contains a GEDCOM parser and viewer that is loaded into your browser. The web application is a “single page application.” Once it is loaded from the GitHub server, it does not require further Internet connections to work. This is why you can open it from the browser’s cache even with no internet connection. (i.e., WiFi turned off) After the web application is loaded from cache, it reads the GEDCOM file from simple local HTTP server temporarily set up by Gramps. If the cached file expires and is purged, a fresh copy will need to be downloaded again.

Tango-Dialog-information.png
Genealogy Data is not uploaded.

The data is only loaded locally into the browser’s memory and does not leave your computer. It is processed by JavaScript code to produce a visualization of the data.


See also