Difference between revisions of "Addon:DenominoViso"

From Gramps
(→‎How do I use it)
m (→‎See also)
 
(87 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
{{Third-party plugin}}
+
{{Third-party addon}}
 +
[[File:DenominoViso-WebPage-Addon-ancestor-example-60.png|thumb|right|450px|DenominoViso Web Page example output - Ancestor (default)]]
  
−
[[File:DenominoVisoWebReport.png|thumb|right|400px|DenominoViso Web Report]]
+
The {{man label|DenominoViso}} addon creates an interactive graphical representation of an Ancestor or Descendant family tree on a web page in various format like Regular, Fan, Growth Spiral, Mandelbrot Tree and Pythagoras Tree.
  
−
The DenominoViso Addon for Gramps creates an interactive graphical representation of a family tree on a webpage.
+
;Features:
 +
* Flat access to the data. The DenominoViso web page shows all information about a person with a single click and some scrolling.
 +
* Easy searching. The web page contains a text entry and a selection field which make it easy to search on names or other properties.
 +
* A single page website. DenominoViso typically puts all textual information in one big file.
 +
* Mixing family and person events. DenominoViso can mix family events with personal events and represents them in chronological order.
 +
* Fine grained control over what gets included. DenominoViso has many options that control what gets included in the webpage. Some options are very advanced for example the confidence level of the source of an event can be indicated by a color; to the best of my knowledge their is no other report that can display this information.
  
 
== Usage ==
 
== Usage ==
  
−
The report is available from the menu {{man menu|Reports > Web Pages > DenominoViso}}
+
The {{man label|DenominoViso}} report is available from the menu {{man menu|Reports > Web Pages > DenominoViso...}}
 +
{{-}}
 +
=== Options ===
  
−
== How the developer uses it ==
+
You can change how the report is created by changing options in the following five tabs.
 +
* {{man label|[[Addon:DenominoViso#DenominoViso_Options_tab|DenominoViso Options]]}}
 +
* {{man label|[[Addon:DenominoViso#Include_Options_tab|Include Options]]}}
 +
* {{man label|[[Addon:DenominoViso#Image_Options_tab|Image Options]]}}
 +
* {{man label|[[Addon:DenominoViso#Style_Options_tab|Style Options]]}}
 +
* {{man label|[[Addon:DenominoViso#Advanced_Options_tab|Advanced Options]]}}
 +
{{-}}
 +
==== DenominoViso Options tab ====
 +
[[File:DenominoViso-WebPages-Addon-DenominoVisoOptions-tab-defaults-60.png|thumb|right|450px|DenominoViso - Web Pages - Addon - "DenominoViso Options" tab defaults]]
  
−
Some examples of how I use a page created by DenominoViso.
+
* {{man label|Destination:}} <code>~\user\document\outputlocation\DenominoViso.html</code>  The destination file for the html-content.
−
# I am primarily looking for information on ancestors. The large overview shown by a page created by DenominoViso, helps me to easily find which ancestors are lagging behind: the branch is tiny compared with neighboring branches.
+
** {{man button|Folder}} - Select output folder location.
−
# Finding death records is harder then birth/baptism and marriage records in Dutch archives. So temporarily I typically set death to something like "after xxxx". I can now enter "after" in the search box and search for "death events", all people that still miss their real death event show up.
+
* {{man label|Central Person:}} defaults to the active person
−
# Some sources are expected to contain a considerable (geographic) group of my ancestors, for example tax records. Because in Gramps I have entered the details of that tax record in the description field of the event, I can search on this in the page created by DenominoViso. Those persons not showing up while it is expected, can easily be identified for further research.
+
** {{man button|Select Central Person}} button - to select a different person.
 +
* {{man label|Title of the webpage}} empty by default - Any string you wish
 +
* {{man label|Display mode:}} - Either plot ancestors or descendants graph
 +
** '''Ancestor'''(default)
 +
** Descendant
 +
* {{man label|Display type:}} - The type of graph to create.
 +
** '''Regular''' (default)
 +
** Fan
 +
** Growth Spiral
 +
** Mandelbrot Tree
 +
** Pythagoras Tree
 +
* {{man label|Direction of time:}} - Direction in which times increases.
 +
** '''right to left''' (default)
 +
** left to right
 +
** top to bottom
 +
** bottom to top
 +
* {{man label|Generations}} <code>10</code> (default) - The number of generations to include in the tree
 +
* {{man label|Max chart width (%):}} <code>50</code> (default) - Width of tree as fraction of the browser window
 +
* {{man label|Max chart height (px):}} <code>1000</code> (default) - Height of the tree in pixels.
 +
* {{man label|Closing remarks:}} <code>Copyright...</code> (default) - List of strings, free text added at the bottom, for example for a copyright notice.
 +
{{-}}
  
−
== Why ==
+
==== Include Options tab ====
 +
[[File:DenominoViso-WebPages-Addon-IncludeOptions-tab-defaults-60.png|thumb|right|450px|DenominoViso - Web Pages - Addon - "Include Options" tab defaults]]
  
−
If your tree of ancestors/descendents grows a bit bigger, traditional graphical representations run out of space and you are left with viewing only part of your tree. The DenominoViso plugin mitigates this by dropping names and other textual details from the boxes that make up a tree so that many more boxes, thus a larger section of the tree, can be put in view.
+
* {{man label|[x] Include private records}}
 +
* {{man label|Include Events: [x]}} - Whether to include a person's events
 +
** {{man label|[x] Include birth children}}
 +
** {{man label|[ ] Include death relatives}}
 +
** {{man label|[ ] Include witness note}}
 +
*{{man label|Include Attributes: [x]}} {{man label|restricted to:}} <code>.........</code> (text box empty) - Whether to include a person's attributes
 +
** {{man label|[ ] Include Addresses}}
 +
** {{man label|[ ] Include Note}}
 +
** {{man label|[ ] Include URL}}
 +
** {{man label|[ ] Include URL description}}
 +
** {{man label|[ ] Include Sources}}
 +
{{-}}
  
−
== How ==
+
==== Image Options tab ====
 +
[[File:DenominoViso-WebPages-Addon-ImageOptions-tab-defaults-60.png|thumb|right|450px|DenominoViso - Web Pages - Addon - "Image Options" tab defaults]]
  
−
The consequence of this is that the document needs to be interactive to determine which box belongs to which person, thus DenominoViso creates a graphical webpage in SVG/XHTML/javascript. Such a document can be displayed with standard compliant browsers such as Firefox or Opera (Internet Explorer will '''not''' do).
+
* [ ] {{man label|Include Photos/Images from Gallery}}
 +
** {{man label|Copy Image:}} [ ] * {{man label|to directory:}} <code>file/path/to/media</code>
 +
*** {{man button|Copy the images to the designated image directory}} button
 +
* {{man label|Images with Attribute:}} <code>____</code> equal to <code>___</code> should be '''Included''' (default) or ''Excluded''
 +
** [ ] Include Image source references
 +
* {{man label|Source reference attribute:}}
  
−
What is seen on the webpage is typically a tree structure consisting of many boxes. Hovering the mouse over a box shows the name of that person on the statusbar (browser settings must allow javascript to set text on the statusline, something which is at present typically switched off by browsers in their standard configuration). Clicking on a box displays the known details about that person.
 
  
−
== Features ==
+
{{-}}
−
# Flat access to the data. Gramps is very hierarchical opening window after window. This is good for data entry, but not so for data display. A page created by DenominoViso shows all information about a person with a single click and some scrolling.
 
−
# Easy searching. The webpage contains a text entry and a selection field which make it easy to search on names or other properties.
 
−
# A single page website. Gramps can create a website, but it is too bulky for my taste. DenominoViso typically puts all textual information in one big file.
 
−
# Mixing family and person events. Gramps displays family events in another window then personal event. Birth of a child though, would be considered by most people as a major event during their live. DenominoViso can mix family events with personal events and represents them in chronological order.
 
−
# Fine grained control over what gets included. DenominoViso has many options that control what gets included in the webpage. Some can be included by setting a simple checkbox, others however are very advanced and should only be used by people with some experience. For example the confidence level of the source of an event can be indicated by a color; to the best of my knowledge their is no other report that can display this information.
 
  
−
== What's in a name ==
+
==== Style Options tab ====
−
The name DenominoViso is derived from a use-case I had not realized before I wrote this plugin. It means something like "let's have a look at namegiving". It turns out that in my family not only family names can be traced back over centuries, but also firstnames where children are typically named after their grandparents or great grandparents if there are many of them. Pages created with the DenominoViso plugin are ideal for this, just enter the specific part of the name in the search field and search for "Name".
+
[[File:DenominoViso-WebPages-Addon-StyleOptions-tab-defaults-60.png|thumb|right|450px|DenominoViso - Web Pages - Addon - "Style Options" tab defaults]]
  
−
==Version History==
+
* {{man label|Color of active person::}} Yellow
−
* Gramps 4 - Update of Gramps 3 version, to support GTK+3 and python 3. No new functionality was added.
+
* {{man label|Color of found persons::}} Red
−
* Gramps 3 - An update of the Gramps 2.x version, to work with the new plugin-architecture. No new functionality was added.
+
* {{man label|Color of male persons::}} Blue
 +
* {{man label|Color of female persons::}} Black
 +
* {{man label|Width of rectangle (hrd)::}} 0.66
 +
* {{man label|Height of rectangle (hrd)::}} 0.16
 +
* {{man label|Vertical distance of rectangles (hrd)::}} 0.19
 +
* {{man label|Extra style settings::}} <code>span.witnesses {font-size: smaller;}<br>span-bron {font-size: smaller;}</code>
 +
{{-}}
 +
 
 +
==== Advanced Options tab ====
 +
[[File:DenominoViso-WebPages-Addon-AdvancedOptions-tab-defaults-60.png|thumb|right|450px|DenominoViso - Web Pages - Addon - "Advanced Options" tab defaults]]
 +
 
 +
* {{man label|Mouse event handler:}} [x] onclick [ ] onmouseover
 +
* {{man label|Birth relationship linestyle:}}
 +
* {{man label|Source confidence color:}}
 +
** Very Low - #0000 (Black)
 +
** Low - #0000 (Black)
 +
** Normal - #0000 (Black)
 +
** High - #0000 (Black)
 +
** Very High - #0000 (Black)
 +
** No Source - #0000 (Black)
 +
* {{man label|Event format:}} <code><date><br><role> at<br><type>:<br><description><br>in <place></code>
 +
* {{man label|Source format:}} <code><title></code>
 +
{{-}}
 +
 
 +
== Why DenominoViso was developed ==
 +
 
 +
As your tree of ancestors/descendants grows a bit bigger, traditional graphical representations run out of space and you are left with viewing only part of your tree. The DenominoViso addon mitigates this by dropping names and other textual details from the boxes that make up a tree so that many more boxes, thus a larger section of the tree, can be put in view.
 +
 
 +
=== How ===
 +
 
 +
The consequence of this is that the document needs to be interactive to determine which box belongs to which person, thus DenominoViso creates a graphical webpage in SVG/HTML/javascript. Such a document can be displayed with standard compliant browsers such as Microsoft Edge, Firefox or Opera (Old version of Internet Explorer will '''not''' work.).
 +
 
 +
What is seen on the web page is typically a tree structure consisting of many boxes. Hovering the mouse over a box shows the name of that person on the statusbar (browser settings must allow javascript to set text on the statusline, something which is at present typically switched off by browsers in their standard configuration). Clicking on a box displays the known details about that person.
 +
 
 +
=== What's in a name ===
 +
The name DenominoViso is derived from a use-case I had not realized before I wrote this addon. It means something like '''let's have a look at namegiving'''. It turns out that in my family not only family names can be traced back over centuries, but also firstnames where children are typically named after their grandparents or great grandparents if there are many of them. Pages created with the DenominoViso addon are ideal for this, just enter the specific part of the name in the search field and search for "Name".
 +
 
 +
=== How the developer uses it ===
 +
 
 +
Some examples of how I (Michiel D. Nauta) use web a page created by DenominoViso.
 +
* I am primarily looking for information on ancestors. The large overview shown by a page created by DenominoViso, helps me to easily find which ancestors are lagging behind: the branch is tiny compared with neighboring branches.
 +
* Finding death records is harder then birth/baptism and marriage records in Dutch archives. So temporarily I typically set death to something like "after xxxx". I can now enter "after" in the search box and search for "death events", all people that still miss their real death event show up.
 +
* Some sources are expected to contain a considerable (geographic) group of my ancestors, for example tax records. Because in Gramps I have entered the details of that tax record in the description field of the event, I can search on this in the page created by DenominoViso. Those persons not showing up while it is expected, can easily be identified for further research.
  
 
==Issues==
 
==Issues==
−
* Help URL does not lead here.
+
* Help URL does not lead here. Goes to https://gramps-project.org/wiki/index.php?title=Gramps_6.0_Wiki_Manual_-_Reports#DenominoViso
−
* {{bug|9603}}: Make DenominoViso respect privacy lock
 
 
* {{bug|6486}}: Duplication in graphical reports when first cousins marry
 
* {{bug|6486}}: Duplication in graphical reports when first cousins marry
−
=== What is missing ===
+
* Some of the '''Display type:''' graph options do not work correctly
−
# Most notable missing feature is the ability to limit data on living persons. You have to make the right privacy setting in Gramps to exclude them from a page created by DenominoViso.
+
* Feature Request: Repository information is at present not included in the page created by DenominoViso.
−
# Repository information is at present not included in the page created by DenominoViso.
+
* [https://github.com/gramps-project/addons-source/pull/245#issuecomment-543425169 Two remaining issues reported on github](By fxtmtrsine / Date: 2019)
 +
** On the "image options" window the "copy image" setting defaults to the program installation folder instead of the media directory in preferences.
 +
** Feature: this one more of a suggestion than issue: in the "style options" can the default colors be something a bit more contrasting or brighter?
  
 +
==See also==
 +
* [[Web Solutions for Gramps]]
 +
* [[Addon:DescendantSpaceTree|Descendant Space Tree]] addon - more modern version of this report.
  
 +
[[Category:Addons]]
 
[[Category:Plugins]]
 
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]
 
[[Category:Reports]]
 
[[Category:Reports]]

Latest revision as of 21:32, 10 June 2025

Gramps-notes.png
This is a Third-party Addon. The Addon/Plugin system is controlled by the Plugin Manager.

Please use carefully on data that is backed up, and help make it better by reporting any 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.

DenominoViso Web Page example output - Ancestor (default)

The DenominoViso addon creates an interactive graphical representation of an Ancestor or Descendant family tree on a web page in various format like Regular, Fan, Growth Spiral, Mandelbrot Tree and Pythagoras Tree.

Features
  • Flat access to the data. The DenominoViso web page shows all information about a person with a single click and some scrolling.
  • Easy searching. The web page contains a text entry and a selection field which make it easy to search on names or other properties.
  • A single page website. DenominoViso typically puts all textual information in one big file.
  • Mixing family and person events. DenominoViso can mix family events with personal events and represents them in chronological order.
  • Fine grained control over what gets included. DenominoViso has many options that control what gets included in the webpage. Some options are very advanced for example the confidence level of the source of an event can be indicated by a color; to the best of my knowledge their is no other report that can display this information.

Usage

The DenominoViso report is available from the menu Reports > Web Pages > DenominoViso...

Options

You can change how the report is created by changing options in the following five tabs.


DenominoViso Options tab

DenominoViso - Web Pages - Addon - "DenominoViso Options" tab defaults
  • Destination: ~\user\document\outputlocation\DenominoViso.html The destination file for the html-content.
    • Folder - Select output folder location.
  • Central Person: defaults to the active person
    • Select Central Person button - to select a different person.
  • Title of the webpage empty by default - Any string you wish
  • Display mode: - Either plot ancestors or descendants graph
    • Ancestor(default)
    • Descendant
  • Display type: - The type of graph to create.
    • Regular (default)
    • Fan
    • Growth Spiral
    • Mandelbrot Tree
    • Pythagoras Tree
  • Direction of time: - Direction in which times increases.
    • right to left (default)
    • left to right
    • top to bottom
    • bottom to top
  • Generations 10 (default) - The number of generations to include in the tree
  • Max chart width (%): 50 (default) - Width of tree as fraction of the browser window
  • Max chart height (px): 1000 (default) - Height of the tree in pixels.
  • Closing remarks: Copyright... (default) - List of strings, free text added at the bottom, for example for a copyright notice.


Include Options tab

DenominoViso - Web Pages - Addon - "Include Options" tab defaults
  • [x] Include private records
  • Include Events: [x] - Whether to include a person's events
    • [x] Include birth children
    • [ ] Include death relatives
    • [ ] Include witness note
  • Include Attributes: [x] restricted to: ......... (text box empty) - Whether to include a person's attributes
    • [ ] Include Addresses
    • [ ] Include Note
    • [ ] Include URL
    • [ ] Include URL description
    • [ ] Include Sources


Image Options tab

DenominoViso - Web Pages - Addon - "Image Options" tab defaults
  • [ ] Include Photos/Images from Gallery
    • Copy Image: [ ] * to directory: file/path/to/media
      • Copy the images to the designated image directory button
  • Images with Attribute: ____ equal to ___ should be Included (default) or Excluded
    • [ ] Include Image source references
  • Source reference attribute:



Style Options tab

DenominoViso - Web Pages - Addon - "Style Options" tab defaults
  • Color of active person:: Yellow
  • Color of found persons:: Red
  • Color of male persons:: Blue
  • Color of female persons:: Black
  • Width of rectangle (hrd):: 0.66
  • Height of rectangle (hrd):: 0.16
  • Vertical distance of rectangles (hrd):: 0.19
  • Extra style settings:: span.witnesses {font-size: smaller;}
    span-bron {font-size: smaller;}


Advanced Options tab

DenominoViso - Web Pages - Addon - "Advanced Options" tab defaults
  • Mouse event handler: [x] onclick [ ] onmouseover
  • Birth relationship linestyle:
  • Source confidence color:
    • Very Low - #0000 (Black)
    • Low - #0000 (Black)
    • Normal - #0000 (Black)
    • High - #0000 (Black)
    • Very High - #0000 (Black)
    • No Source - #0000 (Black)
  • Event format: <date>
    <role> at
    <type>:
    <description>
    in <place>
  • Source format: <title>


Why DenominoViso was developed

As your tree of ancestors/descendants grows a bit bigger, traditional graphical representations run out of space and you are left with viewing only part of your tree. The DenominoViso addon mitigates this by dropping names and other textual details from the boxes that make up a tree so that many more boxes, thus a larger section of the tree, can be put in view.

How

The consequence of this is that the document needs to be interactive to determine which box belongs to which person, thus DenominoViso creates a graphical webpage in SVG/HTML/javascript. Such a document can be displayed with standard compliant browsers such as Microsoft Edge, Firefox or Opera (Old version of Internet Explorer will not work.).

What is seen on the web page is typically a tree structure consisting of many boxes. Hovering the mouse over a box shows the name of that person on the statusbar (browser settings must allow javascript to set text on the statusline, something which is at present typically switched off by browsers in their standard configuration). Clicking on a box displays the known details about that person.

What's in a name

The name DenominoViso is derived from a use-case I had not realized before I wrote this addon. It means something like let's have a look at namegiving. It turns out that in my family not only family names can be traced back over centuries, but also firstnames where children are typically named after their grandparents or great grandparents if there are many of them. Pages created with the DenominoViso addon are ideal for this, just enter the specific part of the name in the search field and search for "Name".

How the developer uses it

Some examples of how I (Michiel D. Nauta) use web a page created by DenominoViso.

  • I am primarily looking for information on ancestors. The large overview shown by a page created by DenominoViso, helps me to easily find which ancestors are lagging behind: the branch is tiny compared with neighboring branches.
  • Finding death records is harder then birth/baptism and marriage records in Dutch archives. So temporarily I typically set death to something like "after xxxx". I can now enter "after" in the search box and search for "death events", all people that still miss their real death event show up.
  • Some sources are expected to contain a considerable (geographic) group of my ancestors, for example tax records. Because in Gramps I have entered the details of that tax record in the description field of the event, I can search on this in the page created by DenominoViso. Those persons not showing up while it is expected, can easily be identified for further research.

Issues

  • Help URL does not lead here. Goes to https://gramps-project.org/wiki/index.php?title=Gramps_6.0_Wiki_Manual_-_Reports#DenominoViso
  • 6486: Duplication in graphical reports when first cousins marry
  • Some of the Display type: graph options do not work correctly
  • Feature Request: Repository information is at present not included in the page created by DenominoViso.
  • Two remaining issues reported on github(By fxtmtrsine / Date: 2019)
    • On the "image options" window the "copy image" setting defaults to the program installation folder instead of the media directory in preferences.
    • Feature: this one more of a suggestion than issue: in the "style options" can the default colors be something a bit more contrasting or brighter?

See also

Retrieved from "https://gramps-project.org/wiki/index.php?title=Addon:DenominoViso&oldid=115965"