Difference between revisions of "Alternate spellings"

From TNG_Wiki
Jump to navigation Jump to search
Line 402: Line 402:
 
| 13.0.3
 
| 13.0.3
 
| FR/EN
 
| FR/EN
 +
|-
 +
| [http://racine-ad.fr/TNG/index.php Racine d'Alsace]
 +
| [[User:Louis42|J-Louis Valory]]
 +
| Public (registration)
 +
| 12.0.1.2b
 +
| 13.0.4
 +
| FR
 +
|-
 
|}
 
|}
  

Revision as of 11:10, 12 July 2021

Restricted Downloads of Alternate spellings are restricted to logged in users. If you do not have a user account on the TNG Wiki use the Request Account link to request a user account Restricted
Caution If you have trouble downloading with Google Chrome, Vivaldi, Brave or other Chromium based browser, try using a right-click and select Open in new Window, then F5, or use another browser such as Firefox


Caution



Ambox notice.png The latest version of this mod uses the guidelines for TNG v12+ cust_text.php files. If you are using TNGv12+, and any cust_text.php file in this mod is marked with a Bad Target error, you need to update your cust_text.php files before you can install this mod. [Show instructions]

If you upgraded to TNGv12+, and did not update your cust_text.php files as instructed in the upgrade readme script, then you must use the TNG Mod Manager to update them. To do so:

  1. Go to Mod Manager, and select its "Recommended Updates" tab.
    (If the "Recommended Updates" tab is not visible, then go to the Mod Manager Options tab, select "Display Settings", and turn on the "Recommended Updates" tab.)
  2. Click the "Update" button in the "Recommended Updates" tab.
    Installed mods do not interfere with the update, and if you already have (or think you may have) run this update, it will not hurt for you to run it again.

[See details in the TNGv12 Change Impacts Article][Hide the instructions]

TNG 14.0
TNG 13.0
TNG 12.0



Alternate spellings
Summary Allows searching on alternate spellings of a name.
Validation
Mod Updated 10 jun 2021
Download link v13.0.1.2b
TNG 13.0.1
Download stats Show statistics
Author(s) Michel Kirsch
Homepage Racines luxo-hennuyeres
Mod Support TNG Community Forums
Contact Developer MyMail
Latest Mod v13.0.1.2b for TNG v13
Min TNG V n.c
Max TNG V v13+
Files modified
admin_secondary.php
admin_secondmenu.php
admin_updateperson.php
ajx_delete.php
customconfig.php
deletelib.php
genlib.php
languages/Dutch-UTF8/cust_text.php
languages/Dutch/cust_text.php
languages/English-UTF8/cust_text.php
languages/English/cust_text.php
languages/French-UTF8/cust_text.php
languages/French/cust_text.php
personlib.php
search.php
searchform.php
searchlib.php
Related Mods
Notes



Purpose of the Mod

This Mod allows you to search for alternative names (other forms, spellings,...) for a person.
After installation and before using this Mod, you must go to your menus : Admin >> Import/Export >> Secondary Processes and click on the "Alternate spellings" button to create the new table and collect the alternate spellings already contained in your database.
The table will be created automatically and populated with your existing data.
The table name is modifiable by parameter. Before changing the table name, don't forget to delete the old table. After changing the name, don't forget to re-populate the table !

(See below About Tags, Uninstall and Mod Operation)

. Important : to UPGRADE to version 2, it is necessary to delete (or rename) your "extensions/alternate_spellings_vars.php" file !

Programming

= Testing : Thanks to Katryne Chauvigné and Rob Severijns
= Translations : Thanks to DeepL on-line translator.
= Author : Michel Kirsch from Charleroi-Hainaut-Belgium

Requirements

A TNG v13.0.1 installation in working order.But it probably works with older versions of TNG. Please let me know. Thank you.


Caution If you also use the Census Plus International mod, you must be install v13.0.1.2a of the Alternate spellings mod to eliminate the Not Unique error in personlib.php that prevents the Census Plus International from installing Caution


About Tags

For this mod to work, you must define the tags you want to process in your genealogy. To do this, adjust the list that you will find in the settings of this Mod (Admin Menu>>Mod Manager>> Click on the line of the Mod then click on the "Edit Options" button).
It is also necessary that the tags you have designated in this list are activated in TNG: Go to Admin Menu>>Types of events which will open the page of tags present in your genealogy.
Verify that the tag(s) you are interested in are present in the list AND that the column "On Import" is well on "Accept" for these tags.
If a tag is not defined, create it using the "Add New" tab. If it is not on "Accept", modify it by clicking on the appropriate icon to the left of the tag line.
Help is available at the top left of the page.

Click on the link at the right to Show/Hide a screenshot of the page.
The screen for Admin Custom Event Types

tag screen

To learn more about the tags, click on the link at the right. (source : Source is here)
Formated by the GEDCOM 5.5 norm.
 GIVN {GIVEN_NAME} A given or earned name used for official identification of a person.
                  ''(Un nom donné ou acquis utilisé pour l'identification officielle d'une personne)''
 NAME {NAME} A word or combination of words used to help identify an individual, title, or other item.
             More than one NAME line should be used for people who were known by multiple names.
             ''(Un mot ou une combinaison de mots utilisés pour aider à identifier une personne, un titre ou un autre élément.
             Si une personne était connue sous plusieurs noms, il faut utiliser une ligne NOM par nom connu.)''
 NICK {NICKNAME} A descriptive or familiar that is used instead of, or in addition to, one's proper name.
                 ''(Un descriptif ou un terme familier qui est utilisé à la place ou en plus de son nom propre.)''
 SURN {SURNAME} A family name passed on or used by members of a family.''(Un nom de famille transmis ou utilisé par les membres d'une famille.)''

List of genealogy programs :

    AQ        Ancestral Quest
    BKW       Brother's Keeper (Windows)
    FO        Family Origins
    FTM       Family Tree Maker (DOS)
    FTW       Family Tree Maker (Windows)
    Gen       Generations
    Leg       Legacy
    PAF       Personal Ancestral File
    Reunion   Reunion for the MAC
    TMG       The Master Genealogist

Tags defined by these programs These tags are not part of the GEDCOM 5.5 specification. All these tags must start with an underscore (_).

Tag Programs Signification
_AKA AQ3, PAF4, PAF5 used for the "also know as" name (Aussi connu comme)
_AKAN BKW6, PAF5 Also known as (Aussi connu comme)
_BIRN BKW6, PAF5 Birth name (Nom de Naissance)
_FKAN BKW6 Formally known as (Formellement connu comme)
_GERN BKW6, PAF5 German name (Nom allemand)
_HEBN BKW6 Hebrew name (Nom Hébreu)
_INDN BKW6 Indian name (Nom indien)
_OTHN BKW6 Other name (Autre nom)
_RELN BKW6 Religious name (Nom religieux)
_SLDN BKW6 Soldier name (Nom de guerre, de soldat)
_SHON BKW6 Short name (Nom court)

Other tags (not GEDCOM 5.5) All these tags must start with an underscore (_), but some do not follow this rule:

Tag Programmes Signification
AKA FO, FTM, Leg, PAF Also Known as (Aussi connu comme)
NAMR FTW5, Gen, Reunion Religious Name (Nom religieux)
NAMS FO, TMG, Reunion Name Sake namesake or even eponymous (homonyme voire éponyme)

IMPORTANT

Before installing, it is judicious to make a backup copy of the files that will be modified by this mod.

You can click on the [Expand] link on the right to display the list of TNG Modules change and the [Collapse] link to hide this section again.

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

admin_secondary.php
admin_secondmenu.php
admin_updateperson.php
ajx_delete.php
customconfig.php
deletelib.php
genlib.php
languages/Dutch-UTF8/cust_text.php
languages/Dutch/cust_text.php
languages/English-UTF8/cust_text.php
languages/English/cust_text.php
languages/French-UTF8/cust_text.php
languages/French/cust_text.php
personlib.php
search.php
searchform.php
searchlib.php

Copied Files

Source Destination Remark
alternate_spellings/alternate_spellings_functions.php TNGroot/alternate_spellings_functions.php
alternate_spellings/alternate_spellings_vars.php TNGroot/$extspath/alternate_spellings_vars.php This file will be protected against deletions when upgrading the Mod.

Created Table

tng_alternate_spellings

INSTALLATION

  • Unzip the received file directly in the "mods" sub directory of your TNG installation.
  • Via Mod Manager, install the Mod.

Upgrade

When upgrading to a newer version

  • Uninstall and eventually Delete the current Mod.
  • Important : to UPGRADE to version 2, it is necessary to delete (or rename) your "extensions/alternate_spellings_vars.php" file !
  • Proceed as for an installation with the new Mod.
  • Your variable file is protected and therefore keeps your parameters intact.
  • After the update go back to Import/Export>>Secondary processes>>"Alternate spellings" button to update the table.

Uninstall

To completely remove the mod, you must follow those 3 steps in the Mod Manager:

  1. Click the Drop 'Alternate' table button.
  2. Click the Uninstall button
  3. Click the Delete button.

Known Problems

Caution If you also use the Census Plus International mod, it must be install before the Alternate spellings mod since it causes a Not Unique error in personlib.php Caution


In the event of a problem

  • Try using the Mod Manager Remove capability
  • Copy the backup of the affected files back to your TNG directory
  • If the problem persists, open an issue in the TNG Community Forums or on the page of Michel Kirsch. At worst, send a mail to MyMail

How it works

You can click on the [Collapse] link on the right to hide this section or [Expand] to display the hidden section.
Usually, the Alternative Spellings encountered for a name are encoded in the databases
.

using the tags NAME, ALIA, _AKA, _AKAN, or _OTHN (but there may be others).
A default tag list is defined in the settings. You can complete or modify this list according to your needs. (via the Edit button of the Mod Manager)
After installation and click on the 'Alternate spellings' button (see 'Purpose of the Mod' above) a new table is created and filled with the values of all your tags according to the defined list (see above).
Once the table is filled in, you receive a small report with the number of values found for the tags in the list and a list with all the rejected values.
This list allows you to see (and click) the people for whom the same other spelling has been encoded more than once. It's up to you to correct your data.
Each time you modify the tag list, you must go back to the secondary processes and click on the "Alternate spellings" button to rebuild the table.
This table creation/filling operation can be performed several times safely for your data.

image3 The delivered report, after filling of the table.

Visualization

When you view a person's record, you will see that the alternate spellings of the name are :
1) grouped on the same line, each spelling being separated by the separator that you can set (via Edit in the Mod Manager). 2) clickable and allow you to search for all people with the same alternative spelling as the current person. (Image 2 and 3)

Research

Research can be done in three ways:

  1. by the method mentioned above, by clicking on the alternate spelling of a name.
  2. by the "Search" button on your site where a new "Alternate spellings" text area is present. (Image 4). You can enter a full name or a part of the name.

The search will return a list of names with other spellings of the name that contain what you entered.

  1. In the advanced search form, a new option for searching by last name is present in the drop-down list for the name. (image 5)


The search result includes an additional column 'Alternate spellings' with all the alternative spellings for the searched name.(image6)

Others

Internally, the Mod also provides:

  • the update of the new table when you add/modify/delete one of the concerned tags.
  • the deletion of the data in the new table when you delete a person.
  • the update of the new table when you delete a tree.

Parameters

You can change the following settings via the Edit button of the Mod Manager:

  1. The separator, the sign that will separate each alternative name value found. Leave a space before and after your separator for better readability. The default separator is a hyphen (-), but it can be a comma or any other sign you prefer.
  2. The list of tags. The list can be empty (in which case the Mod is not much use) or have one or more tags. Each of the tags must be separated by a comma in the list, excluding any other sign. Spaces are accepted, but will not be taken into account. It is intended for a series of standard tags. However, if you have used a personal tag, you can register it here.
  3. The alternate spellings are displayed on one line. You can add the normal display of alternate spellings in the page.
  4. The column title. By default, the column title is "Alternate spellings". If you don't like it, you can change it. Any other title is valid: 'Alternative spellings', 'Aliases, 'Other spellings', ...
    Modify and see your screens what your choice gives. WARNING. You will notice that there are two parameters for the English language (ISO and UTF-8). If you don't know which one to change, change both...
  5. Where to display alternative spellings in getperson.php. Either just under the Name, or after the name elements (prefix, title,...) and before the gender.

Languages

This version is delivered with the French, English and Dutch languages. If a language is added, the following variables from the language files cust_text.php must be added.

Click on [Expand] to display this section or on [Collapse] to hide it.

This version is delivered with the French, English and Dutch languages.
If a language is added, the following variables from the language files cust_text.php must be added.

// Alternate Spellings Mod - Michel Kirsch
$text['records'] = "Records";
$text['result'] = "Result";
$text['finished'] = "Finished";
$text['foundinserted'] = " found and inserted.";
$text['rejected'] = " rejected (already existing).";
$text['result0'] = "(Found 0 for the others tags)";
// Alternate Spellings Mod - Michel Kirsch

In addition, a small file containing the language-dependent variable must be created and placed in the mods/alternate_spellings directory.
Example for the English language: varEn.php

<?php
// variable used by the Alternate_Spellings Mod
$text['altspellings'] = "Alternate Spellings";
?>

Finally the Mod will take care of the parameters this way:

================== column_name EN ===================

%target:$modspath/alternate_spellings/varEn.php%
%fileoptional:%
		Dénom du nouveau champ
%parameter:$text['altspellings']:Autres formes%
%desc:<div style="text-align: left;"><font color="blue">Dénomination of the new field on your TNG pages. Will apply to buttons, labels and column names. WARNING: if you use accented characters, use HTML notation (&eum l, &egrav e, etc...)<br /></font>Don't add quotation marks! <br /> default: (Alternate Spellings)</div>%

Historic of modifications

Version Release Date Contents
v13.0.1.2b 09 jul 2021 In the search results, the width of the "Alternate Spellings" column can be limited by means of a new parameter.
v13.0.1.2a 10 juin 2021 Fix an installation problem with the Census Plus International Mod
v13.0.1.2 09 Mar 2021 If SearchNamesToo = 1 and there is no altspellings found, do a normal search on firstname + lastname
v13.0.1.1f 25 jan 2021 Assure max compatibility for language vars files. Add a tng_real_escape_string - if $SeachNameToo is set to 1, a list of names containng the search string is returned, even there are no alternate spellings found for this string. (Michal)
v13.0.1.1e 10 jan 2021 - Dutch and or French languages folders must no more be installed/copied
- Fix Mod compatibility with Regroup Person Profile Robin's Mod.
- Reduce the lenght of alspelling field to 200 in the table to avoid a max lenght error for the key
- Multi language works now with specifics varXx.php files containing the language dependent variable for buttons, labels and column Name
v13.0.1.1b 04 jan 2021 Fix a SQL error when deleting a person.
v13.0.1.1a 04 jan 2021 Search result Message adapted - Modify code to avoid conflict with Create SiteMap Mod - Table name is a parameter - It is possible to search on the Alternate spellings AND on the surname at the same time - Add a parameter to display Alternate spellings on one line AND display them normally (image 3).
v13.0.1.1 02 jan 2021 First online version.

Sites using this mod

If you download and install this mod, please add your TNG site to the table below:
If you have any problem to do it, send me a mail...

URL User Note Mod-Version TNG-Version User-language
Racines luxo-hennuyeres Michel Kirsch Mod's Developper V13.0.1.1e V13.0.2 FR/EN/NL/GE/SP
Genealogy of a Dutch East-Indies Family Rob Severijns Private V13.0.1.2a V13.0.4 NL/EN
Baza danych Rodziny Jarocińskich Michał Jarociński Non-public site. Brilliant mod! V13.0.1.2 V13.0.3 PL,EN (+FR/NL)
Malkins in New Zealand Rick Malkin Under Construction - Semi Public V13.0.1.1f V13.0.2 EN
Les Lapierre d'Amérique Normand Lapierre Site Privé/Private Site v13.0.1.2 13.0.3 FR/EN
Racine d'Alsace J-Louis Valory Public (registration) 12.0.1.2b 13.0.4 FR

Visualization


image0 getperson.php - Main screen, Mod NOT installed.


image1 Mod's action onthe alternate spellings of the name.

display All But changing in parameters can lead to this view too

image1

'The new research tex area. The search is done on "Alternate spellings contains: what-you-type-here"


image3

The advanced search form proposes a new option for the last name in the drop-down list of options.


image4

A list returned by a 'normal' search. A new column 'Alternate spellings' is added. Some names have alternate spelling(s).

By clicking on "KIRCHE", ...

... this result is returned.

image4a