Addon:DynamicWeb report

From Gramps
Revision as of 18:27, 3 September 2016 by Belissent (talk | contribs) (Usage)
Jump to: navigation, search
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.


Gnome-important.png
Warning:

The current version might have performance issues for databases over 5000 people (see issue 9647)

DynamicWeb report, tree view
DynamicWeb report, person view
DynamicWeb report, persons index
DynamicWeb report, surnames index
DynamicWeb report, tree view

The DynamicWeb Addon for Gramps creates interactive web pages of a family tree.

Usage

The report is available from the menu Reports > Web Pages > DynamicWeb
The Gramps versions 4.2 (and development branch 5.0 are supported).
The Gramps versions 4.1 and before are not supported anymore.

Features

  • Browsable and zoomable bi-directional family tree view.
    This graphical family tree is printed using the SVG format.
    It could be zoomed (like google map) in order to print 20 generations or more.
    It show descendants or ancestry (or both), as a tree or as concentric circles.
    Possibility to use the mouse or a context menu for navigation in the tree.
  • Searching looks into all data (individual, place, source, media)
  • Indexes could be sorted and filtered.
  • Clickable pictures:
    The clickable regions correspond to the Gramps database media references regions [[demo]]
  • Based on client-side Javascript:
    No impact on server resources.
    The web pages could be browsed in a regular web site or on the local machine.
    The generated site is smaller, and contains much less files (compared to static HTML pages).

Demos

Help for the report generation

Configuration before the report generation

Most configuration parameters are self-explaining, the other are explained below:

Tab Options

  • Copy images and media objects:
    The media links use the relative media path defined in Gramps, instead of an absolue path. With this option enabled, it is possible to organize media in directories with more flexibility.
    See explanation for files organization below.

Tab Advanced

Tab Pages

  • Header / footer:
    The Gramps notes used as header / footer could include special features, described for custom pages.
  • Brand name / icon:
    The gramps note used could embed an image or any other special field described for custom pages.
    When no brand name/icon is used, the Gramps icon is used.
    Specify an empty note for disabling the Gramps icon.

Tab Trees

Most of these configuration parameters could also be tuned after report generation, using the cogwheel button in the top-right inside the graphical tree.

  • Colors:
    The gradient colors are used for all gradients (based on generation, time period, or age).
    The gender colors are set in the Gramps Prefrences (in Edit menu).
    The Color scheme classic view : It is hardcoded in Gramps. The colors are those used in the Chart view, for the "Descendant Fan", when configuring background to Color scheme classic view
    The Color scheme classic report: Same as Color scheme classic view.
  • Duplicates:
    For people appearing several times in the tree (for example, when both parents share a common ancestor).

Tab Custom pages

It is possible to add custom pages, built from a note. This note could include:

  • Text formating
  • Links to other Gramps objects
  • External HTTP links
  • Relative HTTP links: They are given as regular HTTP links, but in the form relative://<relative path>
  • Special fields:
    These fields are given as text in the note and are replaced in the generated report.
    Export date: __EXPORT_DATE__
    GRAMPS homepage: __GRAMPS_HOMEPAGE__
    GRAMPS version: __GRAMPS_VERSION__
    Number of families: __NB_FAMILIES__
    Number of persons: __NB_INDIVIDUALS__
    Number of media objects: __NB_MEDIA__
    Number of sources: __NB_SOURCES__
    Number of repositories: __NB_REPOSITORIES__
    Number of places: __NB_PLACES__
    Search form: __SEARCH_FORM__
    Embedded image: __MEDIA_<Gramps ID>__ (for example: __MEDIA_O0011__)
    Embedded image thumbnail: __THUMB_<Gramps ID>__

Tab Pages selection

Allows to enable, disable and order pages.

Media files organization

  • With Copy images and media objects checked:
    The media files are copied at every report generation, in the directory "image", and their names and changed into a unique obfuscated name.
  • With Copy images and media objects unchecked:
    The media files are not copied.
    The relative path from the generated report to the media files is used.
    Therefore, the relative path from Web report to the media object shall stay the same between local computer and the web server where the web site is uploaded.
    On Windows: The report shall be generated on the same disk drive where the media files are located.
    For example:
    The media files are located in the directory: C:\Users\Mewtwo\genealogy\media\
    The report is generated in the directory: C:\Users\Mewtwo\genealogy\reports\DynamicWeb
    Then the relative path is: ..\..\media
    Therefore, on the web server, the media files and report shall be located in something like: http://my.web.site.com/path/to/report/media and http://my.web.site.com/path/to/report/reports/DynamicWeb

Optimizations for big databases

The technology used for this report (client-side Javascript) is not designed for managing big amounts of data. This could lead to performance issues, for databases over 5000 people, when the configuration is not properly set. The follonwing tunings could be used:

  • The optional index columns should be discarded
  • The indexes should be displayed as lists and not as tables

Moreover, when rendering large datasets, the report disables some fancy features for better performances.

If this is not enough, using the Chrome browser could help.

The report was tested with a database over 130,000 people without major issue.

Help for the Web report users

Configuration for the Web report users

Some configuration parameters are accessible after the report generation, using the cogwheel button at the top-right of the page. This cogwheel button is enabled in the Advanced tab.

Most configuration parameters are self-explaining, the other are explained below:

  • Include references in indexes:
    When enabled, the references between objects are shown in the indexes.
    For example, objects citing a source are shown in the sources index.
  • Use tabbed panels instead of sections:
    Changes the layout of the pages. With tabbed panels, the pages are more compact. With sections, all the data is visible at the same time (no need to switch between tabs).
    Note: the sections are collapsible.
  • Show last modification time:
    Adds a modification date/time in the page footer.
  • Number of entries in the tables:
    In the indexes, this is the default number of records shown per page.

Graphical tree navigation

  • Use the mousewheel to zoom in and out.
  • Use the mouse drag and drop to move the graph.
  • Use the mouse left-click to center the graph on a person.
  • Use the mouse right-click to get access to:
    • The person page,
    • The persons related to this person (parents, children, siblings, souses).

Issues

Issues and features requests are managed in the Gramps bug tracking system