Difference between revisions of "Person Map"

From TNG_Wiki
Jump to navigation Jump to search
Line 121: Line 121:
 
| Yes ||   || No || No || No || align="right"|32,077 ||  align="left"|The Event Map section is completely invisible and there is no way to make it visible. The map won't load at all.
 
| Yes ||   || No || No || No || align="right"|32,077 ||  align="left"|The Event Map section is completely invisible and there is no way to make it visible. The map won't load at all.
 
|-
 
|-
| Yes ||   || No || No || Yes || align="right"|210,017 ||  align="left"|The Event Map section is collapsed. There is a ''Click to Display'' link. When you click it a grey arrow will be shown. When you click that, the map will show.
+
| Yes || &nbsp; || No || No || Yes || align="right"|210,017 ||  align="left"|The Event Map section is collapsed.<br />There is a ''Click to Display'' link. When you click it the map will show.
 
|-
 
|-
| Yes || &nbsp; || No || Yes || No || align="right"|1,004,408 ||  align="left"|The Event Map section is completely visible and there is no way to hide it. This is the default behavior when this mod is not installed.
+
| Yes || &nbsp; || No || Yes || No || align="right"|1,004,408 ||  align="left"|The Event Map section is completely visible and there is no way to hide it.<br />This is the default behavior when this mod is not installed.
 
|-
 
|-
| Yes || &nbsp; || No || Yes || Yes || align="right"|0 ||  align="left"|
+
| Yes || &nbsp; || No || Yes || Yes || align="right"|1,059,504 ||  align="left"|The Event Map section is completely visible. There is also a ''Click to Hide'' link.
 
|-
 
|-
 
| Yes || &nbsp; || Yes || No || No || align="right"|0 ||  align="left"|
 
| Yes || &nbsp; || Yes || No || No || align="right"|0 ||  align="left"|

Revision as of 05:52, 5 March 2013

Ambox notice.png PAGE UNDER CONSTRUCTION - PAGE UNDER CONSTRUCTION
TNG All



Person Map
Summary Adds options to the Map Settings dialog to fine tune the showing of the map on the person pages.
Validation The mod is XHTML compliant.Valid-xhtml10.png
Mod Updated {{{mod_last_update}}}
Download link person_map_v9.1.0.2.zip
TNG 9.1


TNG 9.0
person_map_v9.0.0.2.zip

Dutch language file
French language file
Spanish language file
German language file
Download stats See download statistics
Author(s) Bart 'Roebie' Degryse
Homepage Person Map
Mod Support TNG forum
Contact Developer
Latest Mod 9.1.0.3 for TNG v9.1 and up
9.0.0.3 for TNG v9.0
Min TNG V 9.0.0
Max TNG V 9.2.0 beta 2
Files modified
admin_mapconfig.php
admin_updatemapconfig.php
cust_text.php
genlib.php
genstyle.css
getperson.php
mapconfig.php
Related Mods
Notes



Purpose of the mod

This mod will add options to the Map Settings dialog to fine tune the showing of the map on the person pages.


Developer

This mod was developed by Bart 'Roebie' Degryse
Idea by Cyndi Wiseman in response to a question by Mitch Gariador.
Version 9.x.0.1 features in response to a question by Roger Mitchell.
Version 9.x.0.3 features in response to a question by Sam Clark.


Requirements

  • A working TNG installation.
  • A backup of all affected files (see the list in the summary in the upper right corner of the page)
  • An installed current version of the Mod Manager (is already included in TNG v9)


Installation

  1. Download the appropriate zip file as shown in the summary in the upper right corner of the page. NOTE that I host these zip files on my own server. That way I can count the number of downloads for each mod I made and estimate the relevance of such mod.
  2. Extract all the files from the downloaded zip file (1 cfg file and 2 images) into the mods folder.
  3. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files to install the mod.
  4. Go to Admin >> Setup >> Configuration >> Map Settings.
  5. Make sure Enable Maps is set to Yes
  6. Also make sure to set Hide Public Maps to Start to No
  7. Next set the three new options Show the map on the person page, Allow to toggle the visibility, Reset location markers on unhide and Scroll event map section to to your liking. More on these options in the next two paragraphs.
  8. Don't forget to press the Save button.
  9. If the mod doesn't behave as expected, please clear your browser's cache as a first measure:
    1. Log out of your TNG website
    2. Clear your browser's cache
    3. Close and reopen your browser
    4. Log in into your TNG website


Features

The latest version of this mod adds tree options to the Map Settings dialog.

  • Start with expanded event map section
  • Allow to toggle the visibility

The next paragraph will give a detailed description of the effect of these parameters especially in conjunction with other TNG settings.

  • Reset location markers on unhide

When you open the page the map will show a given region. Now suppose you scroll the map to show another region. Now hide the map, next unhide the map. The map will still show the latest region. Setting this option to Yes, forces the map to reload when you unhide it, making it show the former region again.

  • Scroll event map section to

If the getperson page is higher than the browser viewport this option will define the page's behavior: scroll to the top of the event map section, or the bottom or center it in the viewport.

  • There is also an image just before the Click to display/hide link to draw a bit of attention


Detailed Behavior Description

This paragraph will describe the effect of several of the Map Settings options on the behavior of the getperson page, not only the ones added by the mod itself but also the TNG options. It has become quite extensive as there are many possible combinations. To limit the width of the table I've given each option a number (see below).

Another aspect that has been overly discussed on and off the mailing list is the impact on bandwidth. To tackle this I have done some tests. Using the Firefox addin HttpFox I have recorded the list of files and the amount of data fetched from the web server each time I refresh a certain page on my TNG website. The details on the recorded information are in this excel file. The numbers marked in red are the ones that are related to the Event Map section. I have summed them in the excel file and you can also find them in the table below. Remember that these are not absolute figures, they will vary for each website and each getperson page, even for each browser brand. It's the relationship between them that matters most. Or like it was mostly formulated on the mailing list: is the map loaded or not?

Note 1: I have only recorded this information for the getperson page. That explains why there's not always a number mentioned.
Note 2: Depending on the settings a different part of genstyle.css is fetched. That's why I have decided to add this file to the list of Event Map section related files.
Note 3: This tests where done without caching. With caching on the amounts of data fetched should be (far) lower as many of the files can be perfectly cached.

Option Number Added by
Enable Maps 1 TNG
Hide Admin Maps to Start 2 TNG
Hide Public Maps to Start 3 TNG
Start with expanded section 4 MOD
Allow to toggle the visibility 5 MOD
Bytes fetched 6 MOD

An empty cell means that the setting doesn't matter for the described effect.

1 2 3 4 5 6 Description
Site wide behaviour
No         27,697 Maps are disabled
Behavior of admin site
Yes No         Maps will show
Yes Yes         A grey arrow will show instead of a map. When you click it the map will show.
Behavior of getperson page
Yes   No No No 32,077 The Event Map section is completely invisible and there is no way to make it visible. The map won't load at all.
Yes   No No Yes 210,017 The Event Map section is collapsed.
There is a Click to Display link. When you click it the map will show.
Yes   No Yes No 1,004,408 The Event Map section is completely visible and there is no way to hide it.
This is the default behavior when this mod is not installed.
Yes   No Yes Yes 1,059,504 The Event Map section is completely visible. There is also a Click to Hide link.
Yes   Yes No No 0
Yes   Yes No Yes 0
Yes   Yes Yes No 0
Yes   Yes Yes Yes 0
Behavior of other public pages (cemeteries, ...)
Yes   No No No  
Yes   No No Yes  
Yes   No Yes No  
Yes   No Yes Yes  
Yes   Yes No No  
Yes   Yes No Yes  
Yes   Yes Yes No  
Yes   Yes Yes Yes  

Other Languages

Those who use other languages in addition to English can find appropriate mods to add Dutch, French or Spanish custom text additions in the summary in the upper right corner of this page. Follow the same procedure as explained above to install them.

Note that these language mods are only for the 9.0.0.0 version of the mod. New ones will come soon!


Visualization of this mod

The following images show the visual effects of installing the mod.

Without the mod installed

This is how the Admin >> Setup >> Configuration >> Map Settings page looks in the default TNG 9 template 3 layout.

Without the mod installed
With the mod installed

Once you have this mod installed this is how that same page will look like. As you can see a new option has been added.

With the mod installed
With the latest version installed

Once you have the 9.x.0.2 version of this mod installed this is how that same page will look like. As you can see two more options have been added.

With the latest version installed
The event map section with the map closed

Once you have the 9.x.0.2 version of this mod installed this is how the event map section of the getperson page will look like. As you can see there is an image in front of the Click to display link.

The display image
The event map section with the map opened

Once you have the 9.x.0.2 version of this mod installed this is how the event map section of the getperson page will look like. As you can see there is an image in front of the Click to hide link.

The hide image


In the event of a problem

  • Try using the Mod Manager Remove capability
  • Contact me through the TNG forum.
  • Contact me by email. My email address is in the description column of this mod on the Mod Manager page
  • Copy the backup of the affected files back to your TNG directory


Revision History

Version Release Date Contents
v9.0.0.2
v9.1.0.2
21 February 2013 Added an image in front of the Click to display/hide link
v9.1.0.1 19 February 2013 First version of the mod for TNG v9.1+ (jQuery)

Has of course the same features as v9.0.0.1

v9.0.0.1 19 February 2013 Added two more options to the mod's feature set
v9.0.0.0 2 August 2012 Initial config file release for TNG v9.0.0 upto v9.0.3


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
no public site Bart 'Roebie' Degryse Mod developer v9.1.0.2 TNG 9.1.2 NL/EN/ES/FR
Mitchell Families Online Roger Mitchell Another great mod from Bart! v9.1.0.2 TNG 9.1.2 EN
no public site Joyaa Antares v9.1.0.1 TNG 9.1.0 EN
Our Roy and Boucher Family Ken Roy v9.1.0.1 TNG 9.1.1 EN, FR
The Tathams of County Durham Robert Collingwood v9.1.0.1 TNG 9.1.2 EN
Palmer Family and Friends Gerry Hubacka Not a public site. v9.0.0.2 TNG 9.0.3 EN
Nordic Ancestry Mogens C Fenger Not a public site v9.1.0.2 TNG 9.1.2 DA,EN
Chamberlain and Eidenbenz Genealogy Graham Chamberlain v9.1.0.2 TNG 9.1.2 EN,DE,FR,ES,NL
Osborne Morris Families Steve Osborne v9.1.0.2 TNG 9.1.1 EN
Brad and Kathy's Genealogy Brad Mohr v9.1.0.2 TNG 9.1.2 EN
Roy~Royes Family Links Bruce Roy v9.1.0.2 TNG 9.1.1 EN
DiFava/Brandt Family Tree Larry & Linda DiFava v9.1.0.2 TNG 9.1.2 EN
Familienforschung Pannier Martin Pannier v9.1.0.2 TNG 9.1.2 DE,EN,(FR)
Gilbert family history Warren Gilbert v9.1.0.2 TNG 9.1.2 EN