5,876
edits
Changes
From Gramps
m
[[File:DynamicWeb-conf-0.png|thumb|right|450px]]
[[File:DynamicWeb-map-1.png|right|400px]]
Some configuration parameters are accessible after the report generation, using the The cogwheel {{man button at |⚙ Preferences}} button is enabled by default in the top-right of report generations {{man label|[[#Tab_Advanced|Advanced]]}} tab (See the pages {{man label|Enable page configuration:}} option.) .
This cogwheel button is enabled in the {{man label|Advanced}} tab, described [[#Tab_Advanced|above]]'''.====Configuration webpage====
no edit summary
{{Third-party addon}}
{{man warn|Warning:|DynamicWeb may have performance issues for Family trees with more than 5000 people.<br/>|* See '''[[#Optimizations_for_big_databases|Optimizations for big databases]]''' section below.}}
[[File:DynamicWeb-tree1.png|thumb|right|400px450px|DynamicWeb report, tree view]][[File:DynamicWeb-person-1.png|thumb|right|400px450px|DynamicWeb report, person view]][[File:DynamicWeb-index-1.png|thumb|right|400px450px|DynamicWeb report, persons index]][[File:DynamicWeb-surnames-1.png|thumb|right|400px450px|DynamicWeb report, surnames index]][[File:DynamicWeb-tree-2.png|thumb|right|400px450px|DynamicWeb report, tree view]][[File:DynamicWeb-map-1.png|right|450px|DynamicWeb report, map view]]
The {{man label|Dynamic Web Report}} Addon for Gramps addon creates interactive web pages of the your family tree database, and provides the user with options that allow a wide range of customization.
This addon is based on the native [[Gramps_{{Version manualman version}}_Wiki_Manual_-_Reports_-_part_7#Narrated_Web_Site|Narrative {{man label|Narrated Web ReportSite}}]] native Gramps report.
== Usage ==
The report is available from the menu {{man menu|Reports > Web Pages > DynamicWebDynamic Web Report...}} Change the [[Addon:DynamicWeb_report#Configuration_before_the_report_generation|configuration as required]] before the report generation and then select {{man button|Ok}} to generate the report. Select <code>index.html</code> to view the report using your web browser and note that you can [[Addon:DynamicWeb_report#Help_for_the_Web_site_users|change settings]] while viewing the report.
== Features ==
**The generated site is smaller, and contains less files (compared to static HTML pages).
=== Demos === Example demonstration output from the report:
* [http://belissent.github.io/GrampsDynamicWebReport/reports/report_000/person.html?igid=I0044 Example using the default style]
{{-}}
== Help for the report generation ==
=== Configuration before the report generation ===
The "Dynamic" aspect of this report is very handy when coming to choosing 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_by_the_Web_site_users|Configuration by the Web site users]].
The {{man label|Dynamic Web Report}} dialog window has nine tabs each are reviewed below.
{{-}}
==== Tab {{man label|Report}} ====
[[File:DynamicWebReport-WebPages-Report-tab-defaults-60.png|thumb|right|450px|Dynamic Web Report - Web Pages - Report tab defaults]]
* {{man label|Destination}} (<code>~/yourhomedirectory/<Family Tree Name>_dynamicweb</code> by default):
*, The destination directory for the web files.{{man warnmenu|'''Files erased and overwritten|''' - The report generation does not erase any file in the destination directory<br/>Only the files that need to be regenerated are overwritten.}}
* {{man label|Store web pages in archive}} (Disabled by default):<br/>This option could be used for 2 purposes:
** Generate an file that could be easily downloaded from the Web site:
* {{man label|Name format}}:<br>Select the format to display the names
* {{man label|Name format (short)}}:<br>Select the format to display the names, in the graphical tree only.
* {{man label|Web site template}}:<br>The report provides two built-in builtin style sheets for you to choose from to determine the appearance or your web pages. Choose between [[http://belissent.github.io/GrampsDynamicWebReport/reports/report_000/index.html '''Default''']], or [[http://belissent.github.io/GrampsDynamicWebReport/reports/report_001/index.html '''Mainz''']].
* {{man label|Copyright:}} ('''Standard copyright''' by default):<br/>When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/
{{-}}
==== Tab {{man label|Privacy}} ====
* {{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_{{Version manualman version}}_Wiki_Manual_-_Probably_Alive|possibly still alive]]''
**'''Include Last Name Only'''
**'''Include Full Name Only'''
**'''Include''': Include all information of all individuals even if they are ''possibly still alive''
* {{man label|Years from death to consider living}} (<code>30</code> by default):<br/>This option is inactive if the "Living People" option is set to '''Include'''. {{man warn|Some countries have laws that specify a certain number of years after death before an individual's information can be published. Here you can specify the number of years after death needed to comply with such laws.}}
{{-}}
==== Tab {{man label|Options}} ====
* {{man label|Images and media}}:<br/>Three possibilities are proposed for integrating media in the Web site.<br/>See '''[[#Media_files_organization|Media files organization]]''' section below.
* {{man label|Print the notes type}} (enabled by default)
* {{man label|Print place pages}} (enabled by default)
* {{man label|Include Place map on Place Pages}} (disabled by default):<br/>Whether to include a place map on the Place Pages, where Latitude/ Longitude are available.
** OpenStreetMap
* {{man label|Google map API key}}:<br/>The access to the Google Maps API requires an application key.<br/>See [[https://developers.google.com/maps/documentation/javascript/get-api-key Google Maps documentation]]
{{-}}
==== Tab {{man label|Advanced}} ====
* {{man label|Include family pages}} (disabled by default)
* {{man label|Include GENDEX file (/gendex.txt)}} (disabled by default):<br>This option creates a GENDEX file placed at the top of the website. You can see sites which support this format and read more about it at the [http://en.wikipedia.org/wiki/GENDEX GENDEX Wikipedia article])(checkbox unchecked by default)
* {{man label|Enable page configuration}} (enabled by default):<br/>This enables the configuration after report generation, see '''[[#Addon:DynamicWeb_report#Configuration_by_the_Web_site_users|configuration by the Web site users]]''' section below. This configuration is accessed with the cogwheel button on the pages top-right. It allows to configure the layout without having to export the report again. It is very helpful to find the convenient layout without re-exporting the report each time.
* {{man label|Include half and/ or step-siblings on the individual pages}}, <br>{{man label|Use tabbed panels instead of sections}}, <br>{{man label|Show last modification time}}, <br>{{man label|Insert sources author in the sources title}}, <br>{{man label|Suppress Gramps ID}}:<br>See the '''[[##Configuration_by_the_Web_site_users|help for the configuration by the Web site users]]''' section below.
{{-}}
==== Tab {{man label|Indexes}} ====
The number of entries per page in the index tables is memorized by the browser for each user and each table.
This value is the initial default value before the users select their own preference.
{{-}}
==== Tab {{man label|Pages}} ====
* '''''Header / footer''''':<br/>The Gramps notes used as header / footer could include special features, described in the '''[[#Tab_Custom_pages|custom pages]]''' section below.
* '''''Brand name / icon''''':<br/>The gramps note used could embed an image or any other special field described in the '''[[#Tab_Custom_pages|custom pages]]''' section below.<br/>When no brand name/icon is used, the Gramps icon is used.<br>Specify an empty note for disabling the Gramps icon.
{{-}}
==== Tab {{man label|Trees}} ====
*: The {{man label|Color scheme classic report}}: Same as ''Color scheme classic view''.
*{{man label|Duplicates}}:<br>For people appearing several times in the tree (for example, when both parents share a common ancestor).
{{-}}
==== Tab {{man label|Custom pages}} ====
**: Embedded image: <code>__MEDIA_<Gramps ID>__</code> (for example: <code>__MEDIA_O0011__</code>)
**: Embedded image thumbnail: <code>__THUMB_<Gramps ID>__</code>
{{-}}
==== Tab {{man label|Pages selection}} ====
Allows to enable, disable and order pages.
{{-}}
=== Media files organization ===
There are three (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_{{Version manualman version}}_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.
*: For example:
*:: The media files are located in the directory: <code>C:\Users\Mewtwo\genealogy\media\</code>
*:: The report is generated in the directory: <code>C:\Users\Mewtwo\genealogy\reports\DynamicWeb</code>
*:: Then the relative path is: <code>..\..\media</code>
*:: Therefore, on the web server, the media files and report shall be located in something like: <codepre>http://my.web.site.com/path/to/report/media</codepre> and <codepre>http://my.web.site.com/path/to/report/reports/DynamicWeb</codepre>
=== Optimizations for big databases ===
=== <span id="HelpConf">Configuration by the Web site users</span> ===
[[File:DynamicWeb-conf-1.png|right|thumb|450px|Available options for Configuration by the Web site users]] Some configuration parameters are accessible after the report generation, using the cogwheel {{man button|⚙ Preferences}} button at the top-right of the pages.
* {{man label|Use a table format for the index}}, for the {{man label|surnames}}, {{man label|persons}}, {{man label|families}}, {{man label|sources}} or {{man label|places}} indexes:
[[File:DynamicWeb-conf-2.png|right|thumb|450px]]
====SVG tree configuration webpage====
The Graphical aspect of the tree could be modified, depending on users preferences.
* {{man label|Descendants}}: Number of descendants generations.
* {{man label|Show duplicates}}: Outlines the people appearing several times in the tree (for example, when both parents share a common ancestor).
* {{man labelbutton|Ok}} -*{{man button|Restore default settings}}:Restores the settings used when the report was generated.
{{-}}
* Use the mouse <code>right-click</code> to open a context menu. This menu gives access to:
** The person page,
** The persons related to this person (parents, children, siblings, sousesspouses).* Use {{man button|Shift}} + <code>Shift + left-click</code> to go to the person page (same as using the context menu from the <code>right-click</code>).
{{-}}
{{-}}
== Developer ==
Created by [[User:Belissent|Pierre Bélissent]]
* Introduction: [https://sourceforge.net/p/gramps/mailman/message/33115916/ (Gramps-devel) Feedback for a new web report] - From: Pierre B. - 2014-12-05 14:34:44 - ''Hi all, I'm new to GRAMPS, and I would like to have your feedback about a Web report prototype I've developed. http://belissent.github.io/GrampsDynamicWebReport/ Do you find it interesting? Is it worth to continue working on it, and package it as an add-on? Regards, Pierre''
* Initial Addon Release: [https://sourceforge.net/p/gramps/mailman/message/34073318/ (Gramps-devel) New addon (DynamicWeb)] - From: Pierre B. - 2015-04-30 18:53:05 -
== Issues ==
