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. Thanks to Sam and to Jerry Liebowitz for extensive testing and to Ken Roy and Martin Pannier for translations.

Requirements

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

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.

Extract all the files from the downloaded zip file (1 cfg file and 2 images) into the mods folder.

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.

Don't forget to press the Save button.

If the mod doesn't behave as expected, please clear your browser's cache as a first measure:

Log out of your TNG website

Clear your browser's cache

Close and reopen your browser

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 (zipped). 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

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

1

2

3

4

5

Bytes fetched

Description

Site wide behaviour

No

27,697

Maps are disabled

Behavior of admin site

Yes

No

Maps will show

Yes

Yes

A grey button labeled Show/hide clickable map shows, but no 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 itself 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 Event Map section is expanded and the map will show.

Initially only some parts of the Event Map section are loaded even though they are not visible yet. The map itself is not loaded yet.

Yes

No

Yes

No

1,004,408

The Event Map section is completely visible and there is no way to hide it.

Obviously the map is fully loaded.

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.

Here too the map is fully loaded.

Yes

Yes

No

No

7,421

The Event Map section is completely invisible and there is no way to make it visible.

The map itself won't load at all.

Yes

Yes

No

Yes

96,969

The Event Map section is collapsed.

There is a Click to Display link. When you click it the Event Map section is expanded. The map is not yet visible: you only get a Load the map link (with the famous grey arrow). When you click this link the map finally loads and shows.

Initially only some parts of the Event Map section are loaded even though they are not visible yet. The map itself is not loaded yet.

Yes

Yes

Yes

No

91,840

The Event Map section is completely visible and there is no way to hide it.

The map is not yet visible: you only get a Load the map link (with the famous grey arrow). When you click this link the map finally loads and shows.

Yes

Yes

Yes

Yes

98,089

The Event Map section is completely visible.

There is also a Click to Hide link.

The map is not yet visible: you only get a Load the map link (with the famous grey arrow). When you click this link the map finally loads and shows.

Behavior of other public pages (cemeteries, ...)

Yes

Since the Hide Public Maps to Start option only affects the getperson page and this mod doesn't affect other pages than the getperson page, the map on these pages shows, just as it does without the mod.

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!

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

The Event Map section collapsed

This is how the Event Map section of the getperson page might look like (depending on your settings of course). As you can see there is an image in front of the Click to display link to draw a little more attention.

The Event Map section expanded

Here the Event Map section is already expanded. You can see that the Click to hide link has its own image.

The following images show the effect of the Scroll event map section to option. To make this screenshots I resized my browser so that the viewport is smaller than the page, but larger than the Event Map section. Then I've scrolled to the bottom of the page. This I consider the starting point which you can see in the first image (the Collapsed column). Then I've set the mods settings to:

Hide Public Maps to Start: No

Start with expanded section: No

Allow to toggle the visibility: Yes

Each image shows the effect after clicking the Click to display link (see also image The Event Map section collapsed above).

Collapsed

Top

Middle

Bottom

Browser default

This is my starting point: the Event Map section is collapsed

Note that if the viewport is not high enough to accomodate for the Event Map section + a 10 pixel wide border around it, the section will not be centered (it just didn't look good) but scrolled to the top of the section.

This is the behavior when the mod doesn't do any scrolling. This behavior is browser dependent, although most browsers behave the same.

Fixed problem introduced by v9.1.0.6 changes to display the Wiki icon in TNG v10.1 where the version number was not changed in the admin_updatemapconfig.php which caused a problem when updating Map Settings.

Bugfix: the Dutch translation of the Click to hide and Click to display labels was not suited for being used by this mod. This version enables to have a custom text. This custom text is set by the language mod.You only need this update if you want to get the Dutch text right. If you do update however you will have to update all the Person Map mods you're using.Example: You cannot update the main mod and the Dutch language mod but keep using the 9.0.0.1 version of the French language mod.

v9.0.0.3v9.1.0.3

12 March 2013

Changed layout and labels of the options added to the Map Settings page

Added new option Scroll Event Map section to

Bug fix to avoid hiding of the map on other pages than getperson.php

v9.0.0.2v9.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: