Difference between revisions of "Consanguinity Report"

From TNG_Wiki
Jump to: navigation, search
(change File to Media to launch Save As dialog, removed restricted template, added missing TNGmod fields)
 
Line 1: Line 1:
{{restricted}}
 
 
{{TNGmod
 
{{TNGmod
 
| mod_name        = Consanguinity Report
 
| mod_name        = Consanguinity Report
 
| mod_summary    = Creates a Consanguinity report, i.e. a list of full blood related family (ancestors and their descendants)  
 
| mod_summary    = Creates a Consanguinity report, i.e. a list of full blood related family (ancestors and their descendants)  
 +
| mod_validation =
 
| mod_last_update = 1 May 2020
 
| mod_last_update = 1 May 2020
| download_link = [[File:konsang_report_v12.0.0.10.zip]]
+
| download_link = for{{Tv120}}[[Media:konsang_report_v12.0.0.10.zip|konsang_report_v12.0.0.10.zip]]
 +
| download_stats =
 
| mod_author      = [[User:Poulsteen|Poul Steen]]
 
| mod_author      = [[User:Poulsteen|Poul Steen]]
 
| mod_url        = [[Consanguinity Report]] (this page)
 
| mod_url        = [[Consanguinity Report]] (this page)
 +
| mod_support =
 +
| mod_contact =
 
| mod_version    = 12.0.0.10
 
| mod_version    = 12.0.0.10
 
| min_TNG_ver    = 12.0.0
 
| min_TNG_ver    = 12.0.0
 
| max_TNG_ver    = 12.3.0
 
| max_TNG_ver    = 12.3.0
 +
| TNG_file_list =
 +
| related_mods =
 +
| notes =
 
}}
 
}}
 
{| style="margin-right:0.5 em;" align="right"  
 
{| style="margin-right:0.5 em;" align="right"  
Line 68: Line 74:
 
== Requirements ==
 
== Requirements ==
  
{{TNG 12.0.0|and after}}
+
{{TNG 12.0|and after}}
 
* A working TNG installation.
 
* A working TNG installation.
 
* A backup of all affected files (see the list below)
 
* A backup of all affected files (see the list below)

Latest revision as of 17:55, 1 May 2020

Consanguinity Report
Summary Creates a Consanguinity report, i.e. a list of full blood related family (ancestors and their descendants)
Validation
Mod Updated 1 May 2020
Download link for
TNG 12.0
konsang_report_v12.0.0.10.zip
Download stats
Author(s) Poul Steen
Homepage Consanguinity Report (this page)
Mod Support
Contact Developer
Latest Mod 12.0.0.10
Min TNG V 12.0.0
Max TNG V 12.3.0
Files modified
Related Mods
Notes


Purpose of the mod

From a new tab in the getperson screen, this modification creates a Consanguinity report, i.e. a list of full blood related family: Probands ancestors and descendants list, Parents descendants list, Grandparents descendants list, Great grand parents etc.

Technicalities

The mod works only when logged in with editor rights "if( $allow_edit && $rightbranch )". It then includes a "Consanguinity Report" menu item in the "Personal" tab. Selecting this menu item brings you to an RTF generator pop-up dialog with some options.

Default is a Consanguinity Report 4 generations deep in each descendant list and 4 levels of descendant lists, i.e. until the grandchildren of great grandparents. "1 generation" does not include any children, 2 generations include the children and so on. Maximum is 6 levels of ancestors and 12 generations of decendants.

The mod generates a file named after the Proband in the "konreport" folder to be downloaded and opened in a text editor understanding RTF such as MS Word and then potentially converted to PDF.
A button in the dialog should help you semi-automatically to download and open the file. I have tested this with MS Word for Mac version 16.36 (Office 365) and LibreOffice 6.3.5.
First, when the RTF file is opened, don't do anything but saving is as "Word Document (.docx)". If the document is very large and opened in MS-Word, it might not show all pages (yet) - ignore that for now. Close the saved docx-version of the document and open it again. Now, all pages should be visible - even when using MS Word.
From this docx-version of the document you may generate a Table of Content and an Index of Names, if that is selected (see below), and subsequently a PDF file. Beware to generate the PDF-file "Best for electronic distribution", as the one "Best for printing" will omit the built-in hyperlinks - see below. </p>

Report Content

For each person, information is extracted from the TNG data base: Name, birth date and place, death date and place, occupation, parents, and one or more of the "main" personal notes, provided the have an asterix (*) as the first letter in the particular notes. If no birth date is found, the christening date is used, if any. If no death date is found, the burial date is used if any.
The main picture for each person is included alongside with the text. For more pictures to be added, see below.
The names of the persons has been created as a hyperlink to your TNG data base, that is, by clicking on a name in the document, you will go directly to that person in the data base.
The generated ID-numbers of the main persons, such as "A.1", "C.1.2" etc. has a hyperlink to the vertical ancestor chart of that particular person.

  • If you have checked the "Include preface" box, a Table of Content and an Index of Names in addition to a Preface and a list og ancestors, will be included. Before saving as a PDF, remember to update the these two indeces. (e.g. Ctrl+A > Update Fields).
    You might want to edit the file "forord.engelsk.txt" which as "forord.txt" is copied into the languages\English folders and used to form the Preface body text of the document. (Same for the "forord.dansk.txt")
  • If you have checked the "Include Notes" box, all events and notes are added - partly as foot-notes at each page. In addition, thumb-nails of extra pictures and documents will be added.
  • If you have checked the "Include Sources" box, all sources will be added as foot-notes at each page.

Requirements

TNG version: 12.0.0
  • A working TNG installation.
  • A backup of all affected files (see the list below)
  • An installed current version of the Mod Manager (is already included in TNG v10.1.1)


Installation

  1. Click on the download link, shown in the summary in the upper right corner of the page.
  2. Un-zip the file and copy/move/FTP it to the mods folder of your TNG system.
  3. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the mod.


In the event of a problem

  • Try using the Mod Manager Remove capability
  • Replace all affected files with the copies you made before the installation.


Custom Text Additions

Note: The config file includes the English language custom texts.
The mod also includes Danish texts if they are present in your system.
For other languages you can modify the config file to add the custom text or manually add to whatever language you like.

For reference only: First 14 out of currently 62 English custom texts

$text['preface'] = "Preface";
$text['konChild'] = "Child";
$text['seeAbove'] = "please refer above to";
$text['TOC'] = "Table of Contents";
$text['konsang'] = "Consanguinity Report";
$text['konFirst'] = "First";
$text['konSecond'] = "Second";
$text['konThird'] = "Third";
$text['konFourth'] = "Forth";
$text['konFifth'] = "Fifth";
$text['konSixth'] = "Sixth";
$text['konSeventh'] = "Seventh";
$text['konParents'] = "Parents";
$text['konGParents'] = "Grandparents";
etc.


Uninstalling the mod

If you want to completely Remove (uninstall) this mod and all its tables, you should

  1. click the Remove button to uninstall the mod and then
  2. click the Delete button to delete the config file from the mods folder.

Revision History

Version Date Description
V12.0.0.0 01 May 2020 Initial version

Sites using this mod

If you download and install this mod, please add your TNG site to the table below:

URL User Note Mod-Version TNG-Version User-language
Poul Steen - Genealogy Notes Poul Steen My own installation 12.0.0.0 12.3 EN, DA

TNG Modules Impacted

The following TNG Modules are modified, and should be backed up prior to installing this mod:

  • getperson.php
  • languages/English/cust_text.php
  • languages/English-UTF8/cust_text.php
  • languages/Danish/cust_text.php (if present)
  • languages/Danish-UTF8/cust_text.php (if present)

In addition, the following new files are copied into your libraries:

  • rpt_rtfform.php
  • konsang.php
  • PSGenLib.php
  • konsanglib.php
  • konbuildgeneration.php
  • konbuildperson.php
  • konbuildreport.php
  • kongetbloodpers.php
  • kondown.php
  • languages/English-UTF8/forord.txt
  • languages/English/forord.txt
  • languages/Danish/forord.txt
  • languages/Danish-UTF8/forord.txt