Changes

Jump to: navigation, search

Gramps 5.0 Wiki Manual - Reports - part 7

3,474 bytes added, 23:39, 27 October 2022
m
Clear stub template from locked old user manual page in support of https://gramps.discourse.group/t/gramps-5-1-wiki-manual-stub-eradication/2938
== Web Pages ==
===<u>Narrated Web Site</u>===
{{stub}}
{{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 a large number of 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 Narrated Web Site Report.}}
{{man warn|{{man menu|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 a large number of 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 Narrated Web Site Report.}} [[File:NwsrNarratedWebSite-individuals.tab-mainzWebPages-styleIndividuals-samplepage-outputexample-4150.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site report - sample Web Pages - Individuals page - default HTML output - Individual List Page using the Mainz StyleSheetexample]]
The Narrated Web Site report generates a web site (that is, a set of linked web pages), for a set of selected individuals and provides the user with options that allow a wide range of customization. You can run this report via the menu {{man menu|Reports-->Web Pages-->Narrated Web Site...}}.
{{man warn|1=Generating Pages...|2=When you select the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the each of the dialog tabs}}
 
 
{{-}}
====Dialog tabs====
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} report dialog has six the following tabs each are reviewed below. :
{{-}}
=====Report Options=====
[[File:Narrated-web-siteNarratedWebSite-webWebPages-pages-reports-report-optionsReportOptions-tab-4250.png|right|400px450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site - Web Pages - Report Options- tab default options]]
[[Image:NWeb-Man-BasicSet.jpg|right|250px|thumb|Fig. {{#var:chapter}}.* {{#vardefineecho:figurecheckbox|{{#expr:{{#var:figure0}}+1}}}} Basic Style - 5 Color Choices]] * Checkbox: {{man label|Store web pages in .tar.gz archive}} (Checkbox unchecked by default) If you have trouble transferring the files to an external web host, you can create a single gzip'd tar file to more easily upload the data. The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. Gramps has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server and uncompressed on the website host. '''{{man menu|Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.}}'''
* {{man label|Destination:}} (<code>~/yourhomedirectory/<Family Tree Name>+NAVWEB</code> default) The destination directory for the web files.
* {{man label|Web site title:}} (<code>My Family Tree</code> default) The title of the web site. You can enter a custom site title in this option. {{man menu|Strongly suggested you change this from the default}}
** People with common ancestor with active person
* {{man label|Filter Person:}} The center person for the report. (defaults to Active person)
 {{man warn|Please note that compliance with privacy laws and individuals' privacy concerns is as a researcher your responsibility.|The Gramps project cannot be held responsible for privacy law compliance or other privacy issues. Privacy of personal information is an important issue. Gramps provides tools and settings that give you control over the privacy of your data. }} * {{man label|Living People}} 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&#8217;s ''possibility of being alive'' unlikely.**'''Exclude''' &#8211; (Default) Excludes all information of all individuals who are ''[[Gramps_5.0_Wiki_Manual_-_Probably_Alive|possibly still alive]]''**'''Include Last Name Only'''**'''Include Full Name FormatOnly'''**'''Include''' &#8211; Include all information of all individuals even if they are ''possibly still alive''* {{man menu|Years from death to consider living:}} Select (<code>30</code> default) This option is inactive if the format "Living People" option is set to display '''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 namesnumber of years after death needed to comply with such laws.}}* {{checkbox|0}} {{man label|Include data marked private}}: Whether to include private objects. Choose from If your intention is to provide a complete record of your research, checking this box will include all entries marked '''Surname, Given Suffixprivate''' / Given Surname Suffix / Given / Main Surnames, Given Patronymic Suffix / SURNAME, Given along with the rest of your database. (Commoncheckbox unchecked by default{{-}} =====Html options===== [[File:NarratedWebSite-WebPages-HtmlOptions-tab-50.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site - Web Pages - Html options - tab default options]] 
* {{man label|File extension:}} The file extension to be used for the web files. Choose between '''.html'''(default)/.htm/.shtml/.php/.php3/.cgi
* {{man label|Copyright:}} ('''Standard copyright''' default) 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/
** Fade -- [https://en.wikipedia.org/wiki/WebKit Webkit] Browsers Only
** Drop-Down -- Webkit Browsers Only
* {{man label|Citation Referent Referents Layout:}} Determine the default layout for the Source Page's Citation Referents section
** '''Normal Outline Style''' (Default)
** Drop-Down -- Webkit Browsers Only
* {{checkbox|1}} {{man label|Include ancestor's tree}}: Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database. (checkbox checked by default)
* {{man label|Graph generations}} :This option is inactive if the "Include ancestor graph" option is not checked. The default number of generations shown in the ancestor graphs is <code>4</code> with options of 2, 3, 4 or 5. The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.
* {{checkbox|0}} This is a secure site (https) (checkbox unchecked by default)
{{-}}
=====Html optionsDisplay===== [[File:NarratedWebSite-WebPages-Display-tab-50.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site - Web Pages - Display - tab default options]] * {{man label|Name Format:}} Select the format to display the names. Choose from '''Surname, Given Suffix''' / Given Surname Suffix / Given / Main Surnames, Given Patronymic Suffix / SURNAME, Given (Common)
[[File:xxx.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} xxx]]
{{stub}}
{{-}}
=====Display=====
[[File:xxx.png|right|450px|thumb|Fig. * {{#var:chaptercheckbox|0}}.{{#vardefineecho:figureman label|{{#exprSuppress Gramps ID}}:This option determines whether to include the Gramps ID of objects in your web page output. (checkbox unchecked by default)* {{#var:figure}}+1}}checkbox|0}} xxx]]{{stubman label|Sort all children in birth order}}(checkbox unchecked by default)
{{-}}
=====Page Generation=====
[[File:Narrated-web-site-webNarratedWebSite-pagesWebPages-reports-page-generationPageGeneration-tab-4250.png|right|400px450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site - Web Pages - Page Generation]] [[Image:Image region 1.png|thumb|Narrative Web gallery example showing [[How_to_create_image_reference_regions|image reference regions]]- tab default options]]
The following options can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Contact'''(Publisher Contact). From this tab you can also assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items that you have previously created. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects.
* {{man label|HTML user header:}} Display an individual Note of your choice. This text will appear directly below the site title on every web page.
* {{man label|HTML user footer:}} Display an individual Note of your choice. This text will appear within the footer, above the copyright statement on every web page.
{{-}}
 
=====Image Generation=====
 
[[File:NarratedWebSite-WebPages-ImageGeneration-tab-50.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site - Web Pages - Image Generation - tab default options]]
 
* {{checkbox|1}} {{man label|Include images and media objects}} This option determines whether to include/exclude a gallery of media objects on your website. (checkbox checked by default)
* {{checkbox|1}} {{man label|Include unused images and media objects}} This option determines whether to include/exclude a gallery of unused media objects on your website. (checkbox checked by default)
* {{checkbox|0}} {{man label|Create and only use thumbnail- sized images}} : This option allows you to create only thumbnail images instead of full-sized images on the Media Page. This will allow you to have a much smaller total upload size to your web hosting site. (checkbox unchecked by default)
* {{man label|Max width of initial image:}} (<code>800</code> default) This allows you to set the maximum width of the image (in pixels) shown on the media page. Set to 0 for no limit.
* {{man label|Max height of initial image:}} (<code>600</code> default) This allows you to set the maximum height of the image (in pixels) shown on the media page. Set to 0 for no limit.
* {{checkbox|0}} {{man label|Suppress Gramps ID}}: This option determines whether to include the Gramps ID of objects in your web page output. (checkbox unchecked by default)
{{-}}
=====Image Generation=====[[File:NarrativeWeb-Media-tab-ImageReferenceRegions-example-50.png|right|thumb|Example of [[How_to_create_image_reference_regions|image reference regions]] - Media tab of HTML output for "Narrative Web" Report]]
Note that [[File:xxxHow_to_create_image_reference_regions|image reference regions]] are also displayed in the Narrative Web HTML pages created with Gramps.png|right|450px|thumb|FigThere are no special options necessary for this feature, other than the existence of reference regions for 1 or more images. {{#var:chapter}}Narrative Web displays reference regions for people and place objects only.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} xxx]]{{stub}}
{{-}}
=====PrivacyDownload===== {{man warn|Please note that compliance with privacy laws and individuals' privacy concerns is as a researcher your responsibility.|The Gramps project cannot be held responsible for privacy law compliance or other privacy issues.}}
[[File:Narrated-web-site-web-pagesNarratedWebSite-reportsWebPages-privacyDownload-tab-4250.png|right|400px450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} PrivacyNarrated Web Site - Web Pages - Download - tab default options]]
Privacy of personal information is an important issue. Gramps provides tools and settings that give you control over the privacy of your data.* {{checkbox|0}} {{man label|Include data marked privatedownload page}}: Whether to include private objects. If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your databasedownload option. (checkbox unchecked by default)* {{man label|Living PeopleDownload Filename:}} How Select the file 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 be used for downloading 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&#8217;s ''possibility of being alive'' unlikely.**'''Exclude''' &#8211; {{man label|Description for download:}} (Default<code>Smith Family Tree</code> default) Excludes all information of all individuals who are ''[[Gramps_5Give a description for this file.0_Wiki_Manual_-_Probably_Alive|possibly still alive]]''**'''Include Last Name Only'''**'''Include Full Name Only'''**'''Include''' &#8211; Include all information {{man label|Download Filename:}} Select the file to be used for downloading of all individuals even if they are ''possibly still alive''database.* {{man menulabel|Years from death to consider livingDescription for download:}} (<code>30Johnson Family Tree</code> default) This option is inactive if the "Living People" option is set to '''Include'''. {{man warn|Some countries have laws that specify Give 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 lawsdescription for this file.}}
{{-}}
=====Advanced Options=====
[[File:Narrated-web-siteNarratedWebSite-webWebPages-pages-reports-advanced-optionsAdvancedOptions-tab-4250.png|right|400px450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site - Web Pages - Advanced Options- tab default options]]
These settings address the amount of information displayed on the Surname detail and Individual index web pages.
* {{checkbox|0}} {{man label|Include a column for parents on the index pages}}(checkbox unchecked by default)
* {{checkbox|0}} {{man label|Include half and/ or step-siblings on the individual pages}}(checkbox unchecked by default)
* {{checkbox-}} =====Include===== [[File:NarratedWebSite-WebPages-Include-tab-50.png|right|450px|thumb|0Fig. {{#var:chapter}} .{{man label#vardefineecho:figure|Sort all children in birth order{{#expr:{{#var:figure}}+1}}}}(checkbox unchecked by Narrated Web Site - Web Pages - Include - tab default)options]] 
* {{checkbox|0}} {{man label|Include family pages}}(checkbox unchecked by default)
* {{checkbox|0}} {{man label|Include event pages}}(checkbox unchecked by default)
* {{checkbox|0}} {{man label|Include GENDEX file (/gendex.txt)}}. 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)
* {{checkbox|0}} {{man label|Include address book pages}}(checkbox unchecked by default)
* {{checkbox|0}} {{man label|Include the statistics page}}(checkbox unchecked by default)
{{-}}
=====Place Map Options=====
[[File:Narrated-web-site-web-pages-reports-placeNarratedWebSite-mapWebPages-optionsPlaceMapOptions-tab-4250.png|right|400px450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site - Web Pages - Place Map Options- tab default options]]
* {{man label|Map Service:}}: Choose your choice of map service for creating the Place Map Pages** '''GoogleOpenStreetMap''' (default)** OpenStreetMapGoogle : For this option to work requires a {{man label|Google maps API key}} to be entered. To apply for one goto the Google maps platform ( https://cloud.google.com/maps-platform/ ) and select "Get Started" (top right corner) and follow the instructions (may involve a credit card) and then select the "Credentials" option on the "API Manager" menu . Then click on the "Create Credentials" button on the "Credentials" window. Click on "API Key "on the next pop-up window. Copy the generated API key to your clipboard and paste in to Gramps "Google maps API key:" field. I strongly suggest that after generating and placing your report online that you go back to the google maps platform and Click the "Restrict key" button on the API key created window and add your domain (this will stop other website hijacking your api key and making you pay! These new Google Maps API changes came into affect from the 11th of June 2018. see the pricing table https://cloud.google.com/maps-platform/pricing/sheet/ "You also get a recurring $200 credit on your billing account each month to offset your usage costs, and you can set usage limits to protect against unexpected cost increases"
* {{checkbox|0}} {{man label|Include Place map on Place Pages}}: Whether to include a place map on the Place Pages, where Latitude/ Longitude are available. (checkbox unchecked by default)
* {{checkbox|0}} {{man label|Include Family Map Pages with all places shown on the map}}: Whether or not to add an individual page map showing all the places on this page. This will allow you to see how your family traveled around the country. (checkbox unchecked by default)
** Drop
** Markers
* {{man label|Google maps API key:}}
 
{{man warn|To get a "Google maps API key:"|visit https://cloud.google.com/maps-platform/pricing/sheet/ as a cost may be involved as well as the use of a credit card}}
{{-}}
 
=====Other inclusion (CMS, Web Calendar, Php)=====
 
[[File:NarratedWebSite-WebPages-OtherInclusionCMSWebCalendarPhp-tab-50.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site - Web Pages - Other inclusion (CMS, Web Calendar, Php) - tab default options]]
 
 
 
See also:
* [[Howto:_Make_a_genealogy_website_with_Gramps#Integration_of_NarrativeWeb_in_a_CMS_or_MVS]]
* Feature request {{bug|5530}} Integration of the Narrative Web Site into a CMS or MVC
{{-}}
====Example Web Site output====
[[Image:NWeb-Man-Print.jpg|right|250px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} The following sections show the default appearance of web pages printed from a the Narrative Website web page]]report.
{{-}}
=====Home=====
=====Individuals=====
(default page)
[[File:NWeb-Man-Nebr.jpg|right|350px|thumb|Fig. {{#var:chapter-}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Narrated Web Site report - sample output - Individual Detail Page using Nebraska StyleSheet]]
{{-}}
=====Surnames=====
(default page)
If the Web Calendar is to be used without an associated Narrative Web Site, then the text in the 'Home link' under the 'Content Options' should be deleted to ensure that no 'Home' link is generated.
{{stub}}
====Dialog tabs====
* {{man label|Name format:}} Select the format to display the names. Choose from '''Surname, Given Suffix'''(default) / Given Surname Suffix / Given / Main Surnames, Given Patronymic Suffix / SURNAME, Given (Common)
{{stub}}
{{-}}
====Example Web Site output====
{{stub}}
{{-}}

Navigation menu