Difference between revisions of "Gedcom Import Purge"
Robinrichm (talk | contribs) |
Robinrichm (talk | contribs) |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 47: | Line 47: | ||
=== Purging Medialinks === | === Purging Medialinks === | ||
− | <!-- *** BEGIN DOUBLE TOGGLE --><div class="mw-collapsible mw-customtoggle- | + | <!-- *** BEGIN DOUBLE TOGGLE --><div class="mw-collapsible mw-customtoggle-mlinks1 mw-customtoggle-mlinks2" id='mw-customcollapsible-mlinks1' style="text-decoration:underline;color:#0645ad;">[Show Details]</div> |
− | <div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible- | + | <div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible-mlinks2' style="border:thin solid grey;"><!-- BEGIN TOGGLED CONTENT --> |
+ | <!-- BUTTON AT THE TOP OF TOGGLED CONTENT --><div class="mw-customtoggle-mlinks1 mw-customtoggle-mlinks2" style="padding-left:2em;text-decoration:underline;color:#0645ad;float:right;">[Hide details]</div> | ||
When the Gedcom Import Process purges data from the tree being loaded, it does not delete any Medialinks, presumably because | When the Gedcom Import Process purges data from the tree being loaded, it does not delete any Medialinks, presumably because | ||
* Many TNG admins don't count on GEDCOM to load (all) of their media items and links; they manually add other media items and links, and | * Many TNG admins don't count on GEDCOM to load (all) of their media items and links; they manually add other media items and links, and | ||
Line 59: | Line 60: | ||
## Use the new "createdbygedcom" Medialinks field to flag the Medialinks it creates and | ## Use the new "createdbygedcom" Medialinks field to flag the Medialinks it creates and | ||
## Purge (delete) Medialinks that are flagged as having been created by a Gedcom Import - but only if the user checks the new "Purge media links created by previous Gedcom imports" checkbox in the Gedcom Import kickoff form, | ## Purge (delete) Medialinks that are flagged as having been created by a Gedcom Import - but only if the user checks the new "Purge media links created by previous Gedcom imports" checkbox in the Gedcom Import kickoff form, | ||
− | + | # Modifies the Medialinks section of the Edit Media form to display and edit the "createdbygedcom" flag. The flag is turned off when new Medialinks are created via TNG data entry, and, from that point, can be changed, though it is not likely to be changed. | |
− | # Modifies the Medialinks section of the Edit Media form to display and edit the "createdbygedcom" flag. The flag is turned off when new Medialinks are created, and, from that point, can be changed, though it is not likely to be changed. | + | <!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle-mlinks1 mw-customtoggle-mlinks2" style="text-decoration:underline;color:#0645ad;text-align:right;">[Hide details]</div> |
− | <!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle- | ||
</div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> | </div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> | ||
Line 67: | Line 67: | ||
<!-- *** BEGIN DOUBLE TOGGLE --><div class="mw-collapsible mw-customtoggle-cm1 mw-customtoggle-cm2" id='mw-customcollapsible-cm1' style="text-decoration:underline;color:#0645ad;">[Show Details]</div> | <!-- *** BEGIN DOUBLE TOGGLE --><div class="mw-collapsible mw-customtoggle-cm1 mw-customtoggle-cm2" id='mw-customcollapsible-cm1' style="text-decoration:underline;color:#0645ad;">[Show Details]</div> | ||
<div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible-cm2' style="border:thin solid grey;"><!-- BEGIN TOGGLED CONTENT --> | <div class='mw-collapsible mw-collapsible-content mw-collapsed' id='mw-customcollapsible-cm2' style="border:thin solid grey;"><!-- BEGIN TOGGLED CONTENT --> | ||
− | !-- BUTTON AT THE TOP OF TOGGLED CONTENT --><div class="mw-customtoggle-cm1 mw-customtoggle-cm2" style="text-decoration:underline;color:#0645ad;float:right;">[Hide details]</div> | + | <!-- BUTTON AT THE TOP OF TOGGLED CONTENT --><div class="mw-customtoggle-cm1 mw-customtoggle-cm2" style="text-decoration:underline;color:#0645ad;float:right;">[Hide details]</div> |
Until version 12, TNG's Gedcom Import process ignored Citation Medialinks, basically assuming (I presume) that the Gedcom medialinks were repeated in the relevant higher-level source and person or family records. In fact, because TNG did not handle citation medialinks, the "Modify Gedcom files for TNG" option in the Gedcom Converter mod specifically creates those higher-level medialinks when it encounters citation medialinks. | Until version 12, TNG's Gedcom Import process ignored Citation Medialinks, basically assuming (I presume) that the Gedcom medialinks were repeated in the relevant higher-level source and person or family records. In fact, because TNG did not handle citation medialinks, the "Modify Gedcom files for TNG" option in the Gedcom Converter mod specifically creates those higher-level medialinks when it encounters citation medialinks. | ||
Line 91: | Line 91: | ||
<!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle-cm1 mw-customtoggle-cm2" style="text-decoration:underline;color:#0645ad;text-align:right;">[Hide details]</div> | <!-- BUTTON AT THE BOTTOM OF TOGGLED CONTENT --><div class="mw-customtoggle-cm1 mw-customtoggle-cm2" style="text-decoration:underline;color:#0645ad;text-align:right;">[Hide details]</div> | ||
</div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> | </div><!-- END TOGGLED CONTENT and END DOUBLE TOGGLE --> | ||
− | + | ||
== Related Mods == | == Related Mods == | ||
I do not know of any conflicts with other mods. | I do not know of any conflicts with other mods. | ||
Line 149: | Line 149: | ||
{| border="3" cellspacing="1" cellpadding="2" class="wikitable" | {| border="3" cellspacing="1" cellpadding="2" class="wikitable" | ||
| <span style="color: red">'''The Mod Options - in a Mod Settings Block'''</span> | | <span style="color: red">'''The Mod Options - in a Mod Settings Block'''</span> | ||
− | The Mod Settings Block for Gedcom Import Purge is at '''Admin>>Setup>>Import Settings'''. You can jump straight there from the "Change Mod Options" link in the Inner Mod Menu. | + | The Mod Settings Block for Gedcom Import Purge is at '''Admin>>Setup>>Import Settings'''. You can jump straight there from the "Change Mod Options" link in the Inner Mod Menu.<br> |
[[Image:gedcom_import_purge-after-modsettingsblock.jpg]] | [[Image:gedcom_import_purge-after-modsettingsblock.jpg]] | ||
|} | |} | ||
Line 156: | Line 156: | ||
{| border="0" cellspacing="1" cellpadding="2" class="wikitable" | {| border="0" cellspacing="1" cellpadding="2" class="wikitable" | ||
! Mod Version !! TNG Version !! Date !! Note | ! Mod Version !! TNG Version !! Date !! Note | ||
− | |- | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
| [[Media:gedcom_import_purge_v12.0.0.5.zip|12.0.0.5]] | | [[Media:gedcom_import_purge_v12.0.0.5.zip|12.0.0.5]] | ||
| 12.0+ | | 12.0+ | ||
Line 168: | Line 168: | ||
# Added the "Suppress the creation of citation medialinks" checkbox on the Admin Gedcom Import kickoff form. | # Added the "Suppress the creation of citation medialinks" checkbox on the Admin Gedcom Import kickoff form. | ||
# Added code to suppress citation medialinks when the checkbox is checked. | # Added code to suppress citation medialinks when the checkbox is checked. | ||
− | # Adds a Save buttons to the left of the BodyText field in the Edit Media form, so that the user doesn' | + | # Adds a Save buttons to the left of the BodyText field in the Edit Media form, so that the user doesn't always have to scroll to the top or bottom of the form to finish. |
− | + | ||
− | |- | + | |- style="vertical-align:top;" <!-- ############################################################## --> |
| [[Media:gedcom_import_purge_v12.0.0.4.zip|12.0.0.4]] | | [[Media:gedcom_import_purge_v12.0.0.4.zip|12.0.0.4]] | ||
| 12.0+ | | 12.0+ | ||
| 15 May 2018 | | 15 May 2018 | ||
| No functional changes; made compatible with TNGv12. | | No functional changes; made compatible with TNGv12. | ||
− | |- | + | |
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
| [[Media:textplus_charts_v10.1.0.3p.zip|10.1.0.3p]] | | [[Media:textplus_charts_v10.1.0.3p.zip|10.1.0.3p]] | ||
| 10.1-11.1 | | 10.1-11.1 | ||
| 26 Mar 2017 | | 26 Mar 2017 | ||
| Removed the second line from the cust_text.php target location search string | | Removed the second line from the cust_text.php target location search string | ||
− | |- | + | |
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
| 10.1.0.3 | | 10.1.0.3 | ||
| 10.1-11.1 | | 10.1-11.1 | ||
| 26 Mar 2017 | | 26 Mar 2017 | ||
| A technical update that, mostly, just makes [[Show Mod Names]] optional, and avoids a installation conflict introduced by TNGv11.0.1. That is, this version omits the adminlib.php patch that was part of v2 of this mod, and changes this mod's database setup program so that it works independently of that adminlib.php patch (which was fixed in TNGv11.0.1). | | A technical update that, mostly, just makes [[Show Mod Names]] optional, and avoids a installation conflict introduced by TNGv11.0.1. That is, this version omits the adminlib.php patch that was part of v2 of this mod, and changes this mod's database setup program so that it works independently of that adminlib.php patch (which was fixed in TNGv11.0.1). | ||
− | |- | + | |
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
| 10.1.0.2 | | 10.1.0.2 | ||
| 10.1-11.0.1 | | 10.1-11.0.1 | ||
| 25 May 2016 | | 25 May 2016 | ||
| Removed a unneeded <script> element that incorrectly referenced an external file, and that - under rare circumstances I still don't understand - could cause the database setup program to log you out from your TNG session. Also fixes a similarly incorrect <script> element in adminlib.php. | | Removed a unneeded <script> element that incorrectly referenced an external file, and that - under rare circumstances I still don't understand - could cause the database setup program to log you out from your TNG session. Also fixes a similarly incorrect <script> element in adminlib.php. | ||
− | |- | + | |
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
| 10.1.0.1b | | 10.1.0.1b | ||
| 10.1-11.0 | | 10.1-11.0 | ||
| 25 Mar 2016 | | 25 Mar 2016 | ||
| Fixed an error in a JavaScript warning. Cleaned up the code. Changed the Mod Parameters to strings rather than boolean values to be more tolerant of data entry errors. | | Fixed an error in a JavaScript warning. Cleaned up the code. Changed the Mod Parameters to strings rather than boolean values to be more tolerant of data entry errors. | ||
− | |- | + | |
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
| 10.1.0.1a | | 10.1.0.1a | ||
| 10.1-10.1.3 | | 10.1-10.1.3 | ||
| 21 Feb 2016 | | 21 Feb 2016 | ||
| No new end-user functionality. Now depends on [[Show Mod Names|Show Mod Names v2+]]. | | No new end-user functionality. Now depends on [[Show Mod Names|Show Mod Names v2+]]. | ||
− | |- | + | |
+ | |- style="vertical-align:top;" <!-- ############################################################## --> | ||
| 10.1.0.1 | | 10.1.0.1 | ||
| 10.1-10.1.3 | | 10.1-10.1.3 | ||
Line 232: | Line 238: | ||
| [[User: lastejas|See Here]] | | [[User: lastejas|See Here]] | ||
| EN | | EN | ||
+ | |- | ||
+ | | [https://SmeeFamily.com/ Pete's Research] | ||
+ | | [[User:TBirdUK|TBirdUK]] | ||
+ | | Public/Private | ||
+ | | 12.0.0.5 | ||
+ | | 12.01+ | ||
+ | | English | ||
+ | |- | ||
+ | | [https://WokingFamily.com/ Woking Family Tree Project] | ||
+ | | [[User:TBirdUK|TBirdUK]] | ||
+ | | Public/Private | ||
+ | | 12.0.0.5 | ||
+ | | 12.01+ | ||
+ | | English | ||
|- | |- | ||
|} | |} |
Revision as of 08:19, 18 December 2019
Gedcom Import Purge | ||
---|---|---|
Summary | Causes the Gedcom Import Process to delete Medialinks records that have been deleted from the source database, and to retain some Places records that otherwise would be purged. | |
Validation | ||
Mod Updated | 2 Dec 2019 | |
Download link | v12.0.0.5.zip
Older versions can be downloaded from the Revision History. | |
Download stats | ||
Author(s) | Robin Richmond | |
Homepage | this page | |
Mod Support | My Mod Support form or TNG Community Forums | |
Contact Developer | My Mod Support form | |
Latest Mod | v12.0.0.5 | |
Min TNG V | 10.1 | |
Max TNG V | at least 12.2 | |
Files modified | admin_dataimport.php, admin_gedimport.php, gedimport_trees.php, gedimport_misc.php, admin_editmedia.php, js/mediafind.js, js/mediautils.js, micro_medialinks.php, ajx_updateorder.php, admin_importconfig.php, admin_updateimportconfig, English/data_help.php, English cust_text.php.
Installs shared files: rrshared_innermodmenu2.php, rrshared_modsettingsblocks2.php, img/rrshared_wikilogo.gif | |
Related Mods | ||
Notes |
Purpose of the Mod
This mod changes the Gedcom Import process to
- Add a flag (a new database field) to Medialinks that are created by Gedcom Imports,
- Optionally, purge Medialinks that have that flag, but retains Medialinks without the flag (i.e. that were created through TNG data entry), and
- Retain certain Places that are purged by the native code.
Without this mod, the Gedcom Import Process:
- Leaves all Medialinks intact, including those that have been removed from the source database,
- May purge Place records or Places data that is not replaced by the Gedcom Import.
Details
Purging Places
When the "pristine" (unchanged by a mod) Gedcom Import process starts - and "all current data" is being replaced - it deletes all People, Families, Events, Notes, Citations, Sources, and Repositories in the tree being loaded, assuming it will replace them with data in the Gedcom file.
It is more careful with Places, since Places can contain data that cannot be (or is oftent not) loaded from Gedcom. Thus, when it purges Place records, it retains records that contain latitude or longitude values or descriptive notes. Still, it ignores placelevels and medialinks to Places, both of which cannot be loaded from Gedcom files.
Consequently, the Gedcom Import Purge mod modifies the Places purge at the start of the Gedcom Import process so that it retains:
- All Places when there are multiple trees, but just one Place list,
- Places with a longitude, latitude, note, or placelevel value, and
- Places with a Medialink.
Purging Medialinks
When the Gedcom Import Process purges data from the tree being loaded, it does not delete any Medialinks, presumably because
- Many TNG admins don't count on GEDCOM to load (all) of their media items and links; they manually add other media items and links, and
- Gedcom does not support medialinks for places or cemeteries, and any such links in the database must have been created manually, using the TNG editors
However, as a result, Media links that have been deleted from the source database (that produced the Gedcom) will remain in TNG indefinitely, unless deleted manually
Consequently, the Gedcom Import Purge mod
- Installs a setup program that create a new database field named "createdbygedcom" for keeping track of Medialinks that are created by the Gedcom Import Process.
- Modifies the Gedcom Import process to:
- Use the new "createdbygedcom" Medialinks field to flag the Medialinks it creates and
- Purge (delete) Medialinks that are flagged as having been created by a Gedcom Import - but only if the user checks the new "Purge media links created by previous Gedcom imports" checkbox in the Gedcom Import kickoff form,
- Modifies the Medialinks section of the Edit Media form to display and edit the "createdbygedcom" flag. The flag is turned off when new Medialinks are created via TNG data entry, and, from that point, can be changed, though it is not likely to be changed.
Citation Medialinks
Until version 12, TNG's Gedcom Import process ignored Citation Medialinks, basically assuming (I presume) that the Gedcom medialinks were repeated in the relevant higher-level source and person or family records. In fact, because TNG did not handle citation medialinks, the "Modify Gedcom files for TNG" option in the Gedcom Converter mod specifically creates those higher-level medialinks when it encounters citation medialinks.
Now that the TNG Gedcom Import process does create citation medialinks, Gedcom files that have citation medialinks and higher-level medialinks generate redundant medialinks. In addition, (as of TNGv12.2) not all TNG program that display medialinks handle citation medialinks cleanly.
Consequently, the Gedcom Import Purge mod
- Installs a setup program that create a new database field named "createdbygedcom" for keeping track of Medialinks that are created by the Gedcom Import Process, and
- Modifies the Gedcom Import process to:
- Use the new "createdbygedcom" Medialinks field to flag the Medialinks it creates
- Purge (delete) Medialinks that are flagged as having been created by a Gedcom Import - if the user checks the new "Purge media links created by previous Gedcom imports" checkbox in the Gedcom Import kickoff form,
- Modify the Places purge so that it retains:
- All Places when there are multiple trees, but just one Place list,
- Places with a longitude, latitude, note, or placelevel value, or
- Places with a Medialink.
- Ignore Citation Medialinks - if the user checks the new "Ignore Citation Medialinks" checkbox in the Gedcom Import kickoff form.
Some possible next steps:
- The Gedcom Gedcom Converter mod should implement an option not to create those higher-level medialinks, and/or an option to remove the citation medialinks if it creates higher-level medialinks.
- The Gedcom Import Purge mod should (perhaps) have an option to keep citation medialinks, and to ignore redundant higher-level medialinks.
- (Doing so might require the converter to look ahead in the Gedcom file to determine whether such redundant links exist, so it may not be practical to implement this feature.)
Finally, note that it is common for Gedcom files to have direct links from media items to sources,people, and places, independently of citation medialinks. Thus, when I speak of suppressing or removing higher-level medialinks, I am referring to the redundant ones that duplicate a citation medialink, not to the direct medialinks.
Related Mods
I do not know of any conflicts with other mods.
- Admin Media Search - This mod changes the way that TNG displays all medialinks, and it handles citation medialinks, which are a significant concern of this mod.
- Gedcom Import Mediatype and Gedcom Import Monitor are related only in that they also affect the Gedcom Import kickoff form and the Gedcom Import process. Aspects of those mods are coordinated with this mod, but there are 'no dependencies among them and this mod.
- If the optional Show Mod Names mod is installed, this mod will utilize its functionality.
Installation
Files Installed
This mod has two mod subfolders:
- gedcom_import_purge_v12.0.0.5 - The subfolder that you expect to exist for any mod that installs files. It contains
- rrgedcomimportpurge_dbsetup.php This is ordinarily run once, from a link in the Mod Manager, to define the new Medialinks table field that keeps track of medialinks that are created by the Gedcom Import. The field is called createdfromgedcom.
- The shared folder RR-shared_mod_includes_v12.0.0.3, which contains files that support mod option management in many of my mods:
- rrshared_innermodmenu2.php - Inner Mod Menus
- rrshared_modsettingsblocks2.php - Mod Settings Blocks
- img/rrshared_wikilogo.gif - An icon that links to a mod's TNG Wiki page.
The shared folder is packaged with several mods, each of which may install some or all of its files. Once a file from the shared folder has been installed (by any mod), that file will not be overwritten or removed by the subsequent installation or un-installation of any mod (including this one), nor will its presence generate any Mod Manager errors.
If you unzip mod distribution files directly into your mods folder, then the presence of this second subfolder and the installation of its files should be invisible to you. But if you generally copy mod subfolders to your mods folder, you need to make sure to copy the folder RR-shared_mod_includes_v12.0.0.2 (well, unless you are confident that it is already in your mods folder because it was part of another mod).
[Show Installation Details]
Requirements
- A working TNG installation.
- An installed current version of the Mod Manager.
- You should backup files listed in the panel on the right.
Procedure
- Remove and delete previous version of this mod.
- Backup the files updated by this mod. They are listed in the panel at the upper right.
- Download the .zip file, Extract its .cfg file to the mods folder.
- Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.
Problems?
- Try using the Mod Manager Remove capability
- Contact me through My Mod Support form.
Visualizations
In the Mod Manager, After Installation, showing the database setup hyperlink.
You must follow the hyperlink shown above to run the setup program that creates the database field through which TNG remembers which media links were created by a Gedcom Import. |
The Database setup program |
The Gedcom Import Kickoff Form (Admin>>Import/Export) AFTER INSTALLATION:
New or changed elements on the Gedcom Import Kickoff form:
|
Message As the Gedcom Import starts:
This message is visible only if you choose the "Old style import" checkbox (or, if you have installed Gedcom Import Monitor, the "Scrolling progress listing"). Note that the Gedcom Import process will not purge any medialinks the first time you run it after installation, since the new database field hasn't yet been populated by flags that say that the Medialink was created by a Gedcom Import. |
Revision History
Mod Version | TNG Version | Date | Note |
---|---|---|---|
12.0.0.5 | 12.0+ | 2 Dec 2019 |
|
12.0.0.4 | 12.0+ | 15 May 2018 | No functional changes; made compatible with TNGv12. |
10.1.0.3p | 10.1-11.1 | 26 Mar 2017 | Removed the second line from the cust_text.php target location search string |
10.1.0.3 | 10.1-11.1 | 26 Mar 2017 | A technical update that, mostly, just makes Show Mod Names optional, and avoids a installation conflict introduced by TNGv11.0.1. That is, this version omits the adminlib.php patch that was part of v2 of this mod, and changes this mod's database setup program so that it works independently of that adminlib.php patch (which was fixed in TNGv11.0.1). |
10.1.0.2 | 10.1-11.0.1 | 25 May 2016 | Removed a unneeded <script> element that incorrectly referenced an external file, and that - under rare circumstances I still don't understand - could cause the database setup program to log you out from your TNG session. Also fixes a similarly incorrect <script> element in adminlib.php. |
10.1.0.1b | 10.1-11.0 | 25 Mar 2016 | Fixed an error in a JavaScript warning. Cleaned up the code. Changed the Mod Parameters to strings rather than boolean values to be more tolerant of data entry errors. |
10.1.0.1a | 10.1-10.1.3 | 21 Feb 2016 | No new end-user functionality. Now depends on Show Mod Names v2+. |
10.1.0.1 | 10.1-10.1.3 | 6 Feb 2016 | New mod. |
Sites using this mod
If you download and install this mod, please add your site to the table below.
URL | User | Note | Mod-Version | TNG-Version | User-language |
---|---|---|---|---|---|
Robin Richmond's Genealogy Database - admin function; not visible. | Robin Richmond | Mod developer | 10.1.0.3 | 11.1.0 | English |
Hooley Family Links | Rick Hooley | Public/Private | See Here | See Here | EN |
Pete's Research | TBirdUK | Public/Private | 12.0.0.5 | 12.01+ | English |
Woking Family Tree Project | TBirdUK | Public/Private | 12.0.0.5 | 12.01+ | English |
- Mods for TNG v12
- Mods for TNG v11
- Mods for TNG v10
- Admin dataimport.php mods
- Admin gedimport.php mods
- Gedimport trees.php mods
- Gedimport misc.php mods
- Admin editmedia.php mods
- Js/mediafind.js mods
- Js/mediautils.js mods
- Micro medialinks.php mods
- Ajx updateorder.php mods
- Admin importconfig.php mods
- Admin updateimportconfig mods
- Data help.php mods
- English cust text.php mods