Chart Types Help

From TNG_Wiki
Jump to: navigation, search
Chart Types Help
Summary Displays pop-up text with description of all of the native chart types, as well as a few mod-created chart types.
Validation
Mod Updated 20 Sep 2020
Download link v13.0.0.0b
TNG 13.0
Download stats
Author(s) Robin Richmond
Homepage Robin Richmond's Genealogy Database
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod 13.0.0.0b
Min TNG V 13.0
Max TNG V 13
Files modified
all native TNG chart programs
Related Mods
Notes


Purpose of the Mod

To give users an overview of the TNG chart types.
In each native chart program, this mod adds the label "Chart Types" and a small blue information icon that pops up a help file that describes the available chart types. There are separate help files for Ancestor and Descendant charts.

The mod replaces the "Generations" selection box in each program with that "Chart Types" label and moves the "Generations" selection box to a second Inner Menu line.

Mod Options

none

Related Mods

This mod's help files describe all native TNG charts plus the TextPlus Charts charts, the Ancestor Map, the Count Descendants] chart, and the charts produced by the Male and Female Descendant and Parent Ancestor Lines if and only if those mods are installed.

Conflicts

I don't know of any conflicts. Please let me know if you encounter any

Installation

This map uses the normal installation process. It installs two PHP files:

  1. An Include file that that reads the chart descriptions from languages files, and displays those descriptions in a popup, and
  2. A program (linked from the popups) that prints the contents of the popup.

The Chart Types help files are also stored in the mod subfolder, they are not installed to TNG language folders. Instead, they are loaded directly from the mod subfolder. (FWIW, the primary reason that the help files are not installed is to allow translators to edit and view the files without having to install and uninstall the 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

  1. Remove and delete previous version of this mod.
  2. Backup the files updated by this mod. They are listed in the panel at the upper right.
  3. Download the .zip file, Extract its .cfg file to the mods folder.
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files.

Problems?

  1. Try using the Mod Manager Remove capability
  2. Contact me through My Mod Support form.
[Hide Details]

Translations

The mod's help files can be translated into other languages, just like native TNG files. However, since native TNG help files are visible only to TNG admins, very few of them have been translated. On the other hand, the Chart Types help files are intended to be seen by end-users, so there is a greater justification for translating them.

All of the Chart Types help files are stored in and loaded directly from the mod subfolder, where they are stored in a subfolder named "languages", in files named {language}_ancestortext.php and {languages}_descendtext.php. For example, the French-UTF ancestor chart help file (in mod version 13.0.0.1) would be stored in chart_types_help/languages/French-UTF_ancestortext.php.

Next Steps

I plan to define chart's description in a separate file. Doing so would make it much easier for the mod developer, translators, or even site administators to update the description of specific files, and possibly enable mod developers to define help files for their own mods.

Visualizations

The help file popup in the native Text Descendant chart program
Chart type help-descend.jpg
You can see the full help files on the mod author's website:

Revision History

Mod Version TNG Version Date Note
v13.0.0.0b 13 20Aug2020 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
Ancestor charts
Descendant charts
Robin Richmond Mod author 13.0.0.0b 13 English