4,191
edits
Changes
→Configuration before the report generation
{{Third-party plugin}}
{{man warn|Warning:|The current version might DynamicWeb may have performance issues for databases over Family tree's with more than 5000 people.<br/>* See '''[[#Optimizations_for_big_databases|Optimizations for big databases]]''' section below.}}
[[File:DynamicWeb-tree1.png|thumb|right|400px|DynamicWeb report, tree view]]
[[File:DynamicWeb-tree-2.png|thumb|right|400px|DynamicWeb report, tree view]]
The {{man label|Dynamic Web Report}} Addon for Gramps creates interactive web pages of the family tree database, and provides the user with options that allow a wide range of customization.<br>This addon is based on the [[Gramps_4.2_Wiki_Manual_Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_7#Narrated_Web_Site|Narrative Web Report]] native Gramps report.
== Usage ==
The report is available from the menu {{man menu|Reports > Web Pages > DynamicWeb}}
== Features ==
* Browsable and zoomable bi-directional family tree view.<br />**This graphical family tree is can be printed using the SVG format.<br />**It could can be zoomed (like google map) in order to print 20 generations or more.<br />**It can show descendants or ancestry (or both), as a tree or as concentric circles.<br />**Possibility to use the mouse or a context menu for navigation in the tree.
* A search form allows to perform a textual search into many data (individual, place, source, media)
* Indexes could can be sorted and filtered.* Clickable pictures:<br />**The clickable regions correspond to the Gramps database media references regions [. See: [http://belissent.github.io/GrampsDynamicWebReport/reports/report_001/media.html?mgid=O0010 [demo]]]* Based on client-side Javascript:<br />**No impact on server resources.<br />**The web pages could can be browsed in on a regular web site or on the from your local machinecomputer.<br />**The generated site is smaller, and contains much less files (compared to static HTML pages).
== Demos ==
* [http://belissent.github.io/GrampsDynamicWebReport/reports/report_004/person.html?igid=I0044 Example with minimal features] (without private data, notes, sources, addresses, gallery, places, families, events)
{{-}}
== Help for the report generation ==
[[File:DynamicWeb-conf-0.png|centerthumb|400pxright|450px]]
=== Configuration before the report generation ===
The "Dynamic" aspect of this report is very handy when coming to the report configuration. Many configuration parameters could be modified ''after'' the report generation, directly on the Web site. These parameters, accessible to any user of the Web site, are detailed in the section [[#Configuration_for_the_Web_report_usersConfiguration_by_the_Web_site_users|Configuration for by the Web report site users]].
The Dynamic Web Report dialog window {{man label|Dynamic Web Report}} dialog window has nine tabs each are reviewed below.
==== Tab {{man label|Report}} ====
* {{man label|Export addresses}} (Enabled by default):<br/>Whether to include addresses.
* {{man label|Living People}}:<br/>How to handle living people. You can control the display of sensitive information based on whether or not an individual is currently alive. However, since Gramps is a research tool, it is likely that there are individuals with no known date of death in your database. To deduce if an individual is ''possibly still alive'' Gramps employs an algorithm that compares death dates, birth dates, baptism/christening dates, death dates of ancestors and birth dates of ancestors. The algorithm assumes that each individual is ''possibly still alive'' unless the cross-referenced dates make the individual's ''possibility of being alive'' unlikely.
**'''Exclude''' (Default): Excludes all information of all individuals who are ''[[Gramps_4.2_Wiki_Manual_Gramps_{{Version manual}}_Wiki_Manual_-_Probably_Alive|possibly still alive]]''
**'''Include Last Name Only'''
**'''Include Full Name Only'''
There 3 possibilities for using the media files in the report:
# '''''Copy, rename files with an internal Gramps identifier''''':<br/>The media files are copied at every report generation, in the directory "image", and their names and changed into a unique obfuscated name. This behavior is identical to the [[Gramps_4.2_Wiki_Manual_Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_7#Narrated_Web_Site|Narrative Web Site report]].
* '''''Copy, keep file names unchanged''''':<br/>The media files are copied at every report generation, in the directory "image", but their names kept intact. The files that are in the same directory are copied into the same directory. The directory names are replaced by unique obfuscated names.
* '''''Do not copy, reference existing files''''':<br/>The media files are not copied.<br/>The relative path from the generated report to the media files is used.<br/>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.<br/>'''On Windows''': The report shall be generated on the same disk drive where the media files are located.
=== Optimizations for big databases ===
The report was tested with a [[Gramps_Performance#Genealogical_datasets|database with over 120,000 people]] without blocking issue.<br/>Nevertheless, some users could have performance issues.
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 following tunings could be used:
* The optional index columns should be discarded
* The indexes should be displayed as lists and not as tables
Another possility possibility is to use only a portion of the Family Tree database. Generating the report with a smaller filter enhances the performances and provides a smoother experience for the Web site users.
{{man warn|Do you really want to use the entire Family Tree database ?|Be aware that if you select the '''Entire Database''' filter option for your Family Tree database that very big files will be generated (depending on the size of your Family Tree database). It is recommended to start with a smaller filter (for example: ancestors of a certain person) to simplify the output while you learn about the Dynamic Web report.}}
Moreover, when rendering large datasets, the report disables some fancy features for better performances.
== <span id="Help">Help for the Web site users</span> ==
{{-}}
=== <span id="HelpConf">Configuration by the Web site users</span> ===
[[File:DynamicWeb-conf-1.png|right|thumb|450px]]
Some configuration parameters are accessible after the report generation, using the cogwheel button at the top-right of the pages.
This cogwheel button is enabled in the {{man label|Advanced}} tab, described [[#Tab_Advanced|above]]'''.
* {{man label|Use a table format for the index}}, for the {{man label|surnamesRestore default settings}}, {{man label|persons}}, {{man label|families}}, {{man label|sources}} or {{man label|places}} indexes:<br/>When enabled, the indexes are shown as tables. These tables could be sortered by any column, and filtered.<br/>When disabled, the indexes are shown as lists. When possible, these lists are indexed alphabetically. The lists could also be sorted by name, date, etc. depending on the type of data shown.* {{man label|Include columns on the index pages}} for {{man label|dates}}, {{man label|partners}}, {{man label|parents}}, {{man label|media path}}:<br/>Includes the corresponding columns in the indexes, '''when the indexes are shown as lists'''.* {{man label|Include references in indexes}}:<br/>When enabled, Restores the references between objects are shown in the indexes, '''settings used when they are shown as lists'''..<br/>For example, objects citing a source are shown in the sources index.* {{man label|Include Place map on Place Pages}}:<br/>Whether to include a place map on the Place Pages, where Latitude/ Longitude are available.* {{man label|Include a map in the individuals and family pages}}:<br/>Whether to include a place map on the pages, where Latitude/ Longitude are availablereport was generated.* {{man label|Include half and/ or step-siblings on the individual pages}}* {{man label|Insert sources author in the sources title}}:<br/>The source author is always shown with the source title. This covers button also resets the case when source titles are too genericuser preferences, like ''"baptize registry"'' for example.* {{man label|Use tabbed panels instead of sections}}:<br/>Changes the layout number of the pages. With tabbed panels, the items per pages are more compact. With sections, all the data is visible at the same time (no need to switch between tabs).<br/>Note: the sections are collapsible.* {{man label|Show last modification time}}: <br/>Adds a modification date/time in the page footer.* {{man label|Suppress Gramps ID}}:<br/>Allows to hide the Gramps ID. The Gramps ID is an identifier for each object stored in the Family Tree database. It could be used to precisely identify an element (person, family, source, etc.)index tables.
=== <span id="HelpTreeConf">Graphical tree options</span> ===
[[File:DynamicWeb-conf-2.png|right|thumb|450px]]
The Graphical aspect of the tree could be modified, depending on users preferences.
* {{man label|SVG tree graph type}}
** {{man label|Ascending tree}}: Only ancestors of the chosen person are shown
* {{man label|Show duplicates}}: Outlines the people appearing several times in the tree (for example, when both parents share a common ancestor).
* {{man label|Restore default settings}}:Restores the settings used when the report was generated.
{{-}}
=== <span id="HelpTreeNav">Graphical tree navigation</span> ===
[[File:DynamicWeb-tree-3.png|thumb|centerright|600px450px|Tree view example]]
* Use the <code>mousewheel</code> to zoom in and out.
** The persons related to this person (parents, children, siblings, souses).
* Use <code>Shift + left-click</code> to go to the person page (same as using the context menu from the <code>right-click</code>).
{{-}}
=== <span id="HelpMapNav">Map navigation</span> ===
[[File:DynamicWeb-map-2.png|thumb|centerright|600px450px|Map example]]
* The mouse <code>left-click</code> expands the map full-screen (or restores it back).
== Issues ==
