Difference between revisions of "TextPlus Charts"

From TNG_Wiki
Jump to: navigation, search
(Added description of relationships with Ancestor Map and with "Male Female and Parent Lines")
Line 166: Line 166:
 
| This mod adds a "Text+" option to the "Initial Display" selection for Pedigree Chart and for Descendant chart.  This allows you to set up the Text+ charts as your default Pedigree and/or Descendant charts.
 
| This mod adds a "Text+" option to the "Initial Display" selection for Pedigree Chart and for Descendant chart.  This allows you to set up the Text+ charts as your default Pedigree and/or Descendant charts.
 
|-
 
|-
| [[Image:textplus15_setup.jpg]] |}
+
| [[Image:textplus15_setup.jpg]]
 +
|}
  
 
== Language Strings ==
 
== Language Strings ==

Revision as of 10:29, 30 October 2018

In TNGv12 and beyond, this mod uses the new 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]


TextPlus Charts
Summary Two new charts: Text+ Descendant Chart, and Text+ Ancestor Chart.
Validation
Mod Updated 28 Oct 2018
Download link
v12.0.0.15a
TNG 12.0

French, Dutch, German, Norwegian: languages_v12.0.0.15a &

See the Revision History to download older versions
Download stats
Author(s) Robin Richmond with translations by Ken Roy, Henny Savenije, Hendrik Martius, Bernard Wortelboer, & Jan-Thore Solem, and testing help from Henny Savenije and Alan Wilcox
Homepage TextPlus Charts (This Page)
Mod Support My Mod Support form or TNG Community Forums
Contact Developer My Mod Support form
Latest Mod 12.0.0.15a
Min TNG V 12.0
Max TNG V 12.0.0.2+
Files modified
Updates admin_pedconfig.php,
Descendant charts (descend.php, descendtext.php, desctracker.php, register.php),
Pedigree charts (pedigree.php, pedigreetext.php, verticalchart.php, ahnentafel.php, extrastree.php),
tngrobots.php,
cust_text.php (English, Dutch, French, German, Norwegian),
css/genstyle.css
Installs: rrtextplus_descend.php, rrtextplus_ancestor.php, rrtextpluslib.php, rrtextplus_innermenuedit.php, English textplus_help.php, English, Dutch, French, German, and Norwegian cust_text.php, German-UTF8/textplus_help.php, Several images in languages/English.
Related Mods
Notes
Some language strings have not yet been translated. See #Language_Strings


Purpose of the Mod

To define two new charts - Text+ Ancestor Chart, and Text+ Descendant Chart. Both charts follow a text format (basically an outline layout), and are accessed through the TNG "Inner Menu" (the link menu just below the TNG Tab Bar) on the Person Profile and on Pedigree and Descendant chart pages. The modified list of links in the Descendant Inner menu looks link this: Standard | Compact | Text | Text+ | Register | PDF

Features of the Text+ Charts

  • The Text+ Descendant Chart is very similar to TNG's Text Descendant Chart, but has several additional features.
  • The Text+ Pedigree Chart serves the same purpose as TNG's Text Ancestor Chart, but does not use the standard 4-generations-per-page Pedigree format. It can display at least 15 or so generations in one chart that is one page wide and several pages long. It also has some of the same 'additional features' as the Text plus Descendant Chart.

[Show Features]

Both charts:

  1. Draw lines to connect people with their children.
  2. Display places of birth and death instead of just dates.
  3. Display charts display alternate birth date and/or place (i.e. christening date/place) when the birth date and/or place is missing.
  4. Display burial date and/or place when the death date and/or place is missing. (When the "location" component of a burial placeplace contains the word "Cemetery", the entire Cemetery name is removed from the placename.)
  5. Display the last known place of residence and the date of that residence event for people who are living (if security contraints allow it).
  6. Can display ALL of a person's descendants or ancestors rather than a specific number of generations,
  7. Display a summary at the bottom of the chart, and
  8. Have options that control the size and spacing of the charts. Some parameters are available in the main window, and some parameters are available only in the Format for Printing window.
  9. Allow the user to save the size and spacing parameters to a cookie for use by subsequent charts.
  10. Have options that affect the information to be displayed in the chart.
  11. Use short-hand notation for some dates and places, to reduce the need to wrap data to a second line. See Reducing Line Wrapping below.
  12. Can use abbreviated place names (which are created by another mod), again, to reduce line-wrapping. See Reducing Line Wrapping.

The Text+ Descendant Chart also:

  1. Displays the date and place of marriage.
  2. Displays the starting person's parents, with date and place of birth and death.
  3. Can hide living and private individuals, so that a chart generated by an administrator can be shared with people who do not have permission to see living and private individuals.
  4. Can display generation numbers and sibling numbers (i.e. sibling counts)

The Text+ Ancestor Chart:

  1. Can display the siblings of each ancestor, giving a richer view of the family tree,
  2. Can display generation numbers, and sibling numbers (i.e. sibling count),
  3. Can highlight the ancestors in any specific generation.

[Hide Details]

Settings

This mod adds option values to two TNG administrative chart settings:

  1. The Text+ Ancestor Chart can be set as the default "Pedigree" chart. To do so:
    • Open the "Pedigree Chart" section of the form at Admin>>Settings>>Chart Settings form.
    • Select "Text+" in the "Initial Display" drop-down box.
  2. The Text+ Descendant Chart can be set as the default Descendant chart. To do so:
    • Open the"Descendant Chart" section of the form at Admin>>Settings>>Chart Settings.
    • Select "Text+" in the "Initial Display" drop-down box.

Run-time Options

  1. Print Formatting - Text+ charts cannot depend on the web browser to wrap long lines at the right margin. (To learn why, see Margins and Line-Wrapping below.) As a result, both Text+ chart programs depend on run-time parameters to control the width of the Text+ charts. Each of these controls have initial defaults, and the values that are used when printing a chart can be saved to be used as the default for subsequent charts.
  2. Content Controls - The content of Text+ charts can be adjusted at run-time with options such as
    • Generations numbers & sibling numbers;
    • Adding siblings to an Ancestor chart,
    • Using a more compact chart format, and
    • Highlighting the names in a chosen generation.

The Print Formatting and Content Control options are illustrated in the Visualizations below, and are described in detail in the Text+ Charts help file].

Compatibility With Other Mods

No known conflicts with published mods. However, there is a conflict with older versions of an Add New Items mod that was written by Ian Fettes.

Related Mods

Count Descendants
First, if you want to use both Count Descendants and TextPlus Charts, you should install Count Descendants v9+ and TextPlus Charts v15+

This mod coordinates with Count Descendants v9+ in two distinct ways.

  1. The Descendant Inner menu links:
    • The Text+ Descendancy Chart program installed by this mod contains a link to the Count Descendants chart. But the "Count" link is displayed only if Count Descendants is installed.
    • Similarly, the Count Descendants Chart installed by Count Descendants contains a link to the The Text+ Descendancy Chart, and that "Text+" link is displayed only if this mod ([[[TextPlus Charts]]) is installed.
  2. The Admin >> Setup >> Chart Settings form
    Both mods add
    (1) An option to the "Initial Display" selection box in the "Descendancy Chart" section of the Chart Settings form, and
    (2) A help link next to that selection box
    The two mods coordinate over that help link in two ways:
    1. Both mods insert nearly-identical Javascript (document).ready functions that install the help link only if the other (document).ready function installed by the other mod has not already created the link, and</li>
    2. Both mods add text to the Chart Setting help file describing the choice(s) they add to the Chart Settings form.
      The two help file links to the help text necessarily use different anchors in the Chart Settings help file, and that only one of the two help file links get created. However, since both new blocks of text are small, and at the bottom of the help file, the text created by both mods should be visible no matter which link has been created and followed by a user.

Ancestor Map

  • The Inner Menu of the Text+ Ancestor chart has a link ('Map') to the Ancestor Map. That link is visible only if the program installed by Ancestor Map (mappedigree.php) exists.
  • As TextPlus Charts is installed, it modifies mappedigree.php (if it exists) to add a "Text+" link to the Inner Menu of mappedigree.php. But if Ancestor Map is installed after TextPlus Charts,
    • mappedigree.php will not have the "Text+" link in its Inner Menu, and
    • TextPlus Charts will be marked as "Partially Installed" because it expects mappedigree.php to have that "Text+" link. (Thus, Ancestor Map must be uninstalled before TextPlus Charts can be uninstalled.)

There are a couple of straightforward fixes to the mixup between Ancestor Map and TextPlus Charts. One should be implemented soon.

Male Female and Parent Lines

  • The Inner Menu of the Text+ Ancestor chart has a link to the Parent Lines chart installed by Male Female and Parent Lines. That link is visible only if the chart program (lines.php) installed by Male Female and Parent Lines exists.
  • TextPlus Charts does not modify lines.php. As a result:
    • The Inner Menu of the Parent Lines chart does not link to the Text+ Ancestor Chart, and
    • The mod uninstallation conflict that occurs with Ancestor Map does not occur with Male Female and Parent Lines.

Show Mod Names
Like almost all of my mods, the code installed by TextPlus Charts collects information that can be used by Show Mod Names, but only if Show Mod Names is installed. TextPlus Charts is not dependent on Show Mod Names.

Installation

This mod has a subfolder. Make sure that you copy the subfolder to the mods folder along with the .cfg file. There is also a separate .cfg file for language translations. It must be downloaded and installed separately. [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]

Visualizations

The screen clips displayed here are not fully annotated. A much more thorough explanation of the Text+ charts can be found in the Text+ Charts help file on the mod author's TNG site

1. Text+ Descendant Chart - In the main window (as opposed to the "Format for Printing" window)
  • In the three line Inner Menu (white text on dark teal)
    1. In the "Generations" selection box on the first line of the Inner Menu, the value 'all' has been selected so that all generations of the individual's descendants are to be displayed. The Text+ Chart format can handle over 15 generations in one page-width.
    2. Four checkboxes on the second line of the Inner Menu control optional features of the chart.
    3. On the third line of the Inner Menu,
      • The Page Width option is used by the TextPlus Chart program to decide where to wrap lines within the chart. (See Margins and Line-Wrapping below to understand why the Text+ programs cannot depend on the web browser to wrap lines at the right margin.)
      • There is a help file for the Text+ Charts. (In general, TNG has help files only for Admin programs, not for end-user programs.)
      • The "Format for Printing" button is enlarged to indicate that users who want to print a Text+ chart should essentially always use the Format for Printing feature to control the shape of Text+ Charts and make sure that they fit the desired page width.
  • In the chart itself:
    1. The chart starts with information about the starting person's parents.
    2. Unlike the native Descendant Text Chart, The Text+ Descendant chart shows places of birth and death, plus date and place of marriage.
      • Most of the data lines in this particular chart are wrapped onto a second line, using logic that is based on the Page Width option mentioned above.
    3. Like the native Descendant Text Chart, branches of the Text+ Descendant Chart's descendant tree can be compressed.
    4. The chart ends with an overview of what was printed. It even knows how many people have been hidden when branches of the descendant tree were collapsed.
Textplus15 descendant main.jpg
2. Text+ Descendant Chart in the Format for Printing window.
  1. The "Format for Printing" fieldset supplies chart layout parameters that customize a chart for the printer page width.
  2. The "Chart Content" fieldset duplicates the content-control checkboxes that were in the main window.
  3. The formatting and chart content fieldsets, and the Expand/Collapse controls at the top of the chart are not printed to a printer.
  4. The content of the chart is the same as it is in the main window; thus the summary at the bottom of the chart is not shown in this screen clip.
Textplus15 descendant print.jpg
3. Text+ Ancestor Chart in the main window.
  1. The controls in the three-line Inner Menu are either the same or analogous to the Inner Menu controls in the Text+ Descendant Chart.
  2. The "Focus on Generation" control causes names in the selected generation 1 (that is, Clarence Lester Richmond) to be highlighted.
  3. Note that, unlike a typical Ancestor Chart, the Text+ Ancestor Chart does not display each generation in a distinct column. Instead it uses what might be called a double outline format to indent each generaton. As a result, for a particular number of generations, Text+ Ancestor Charts oare much narrower and longer than typical Ancestor Charts.
  4. This screen clip shows a section of the chart that displays nine generations. (See Christian Moyer and Anna Barbara BERGERY.)
  5. As with the Text+ Descendant chart, the line wrapping is done by the program, not by the web browser.
Textplus15 ancestor main.jpg
4. Full Text+ Chart Examples saved as PDFs

(Note: In the Ancestor Chart PDFs, some of the vertical lines are colored. I have no idea why. They are black in the web browser.)

5. Text+ Pedigree Setup in the Admin >> Setup >> Chart Settings Form
This mod adds a "Text+" option to the "Initial Display" selection for Pedigree Chart and for Descendant chart. This allows you to set up the Text+ charts as your default Pedigree and/or Descendant charts.
Textplus15 setup.jpg

Language Strings

There are numerous language strings, and Dutch, French, Germand, and Norwegian translations. However, in the initial release of v12.0.0.15 of this mod, not all of the strings have been translated into each language. As translations come in, I will update the language .cfg files, and add a suffix to the .cfg file version number.

Margins and Line-Wrapping

Because the Text+ charts draw vertical lines connecting the generations, these charts cannot simply allow long lines of data to wrap at the browser window's (or printed page's) right margin. The Text+ chart programs have to know the window (or printed page's) width and the font size so that they can wrap lines of data at the appropriate point.

As a result, the Text+ chart programs contain a form that specifies printing options. Some parameters are visible in the 'main' program window. Other parameters that deal with font size and page width are visible only in the 'Format for Printing' window. Those parameters are described in detail in the Text+ chart help page.

It is significant to note that the algorithm used by Text+ programs is not perfect, so one of the print-formatting options is a fudge factor that adjusts the page width when the algorithm misses its mark. As a result, to print a report cleanly can take a few cycles of looking at print previews in the web browser, and adjusting the fudge factor to assure that lines are

  • not so long that the web browser wraps them all the ways to the left margin, and
  • not so short that they leave to large a right margin on the paper.

Reducing Line-wrapping

The Text+ charts use the following techniques to reduce the amount of text required to display a person's data end place information, and thus to reduce the amount of line-wrapping required to print a chart:

  • "Unknown" is displayed as "??" instead of "Unknown"
  • If an individual was born and died in the same place, the placename is displayed only once, e.g. Cleveland, Bradley, Tennessee, USA;15 Nov 1815 - 04 Jan 1887 .
  • When both the date and place are unknown, nothing is printed.
  • I also use an unpublished mod to create shorter versions of USA place names (e.g. "Cleveland, Cuyahoga, OH" for "Cleveland, Cuyahoga County, Ohio, USA". At present, this scheme depends on both the Gedcom Converter and Placename Format mods - plus the unpublished mod. If you're interested in using short place names, let me know, and I'll share the mod with you.

Inner Menu Utility

If you install the TextPlus Charts mod and other mods that place links on the Ancestors or Descendants Inner Menus, those Inner Menus can become awkwardly long. This mod installs utility program that eliminates the native Descendant and/or Ancestor Text chart in selected chart programs. The utility is available through a link in the mod description in Mod Manager. Be aware, however, that, with TNGv11, the native Text Descendant chart has a new ancestor-tracking feature that is not found in the Text+ Descendant chart. Specifically, the native Text Ancestor chart now displays the child number of each ancestor. (That is, it could indicate that the current person is the first child of the 3rd child of the 2nd child, etc.)

Revision History

Mod Version TNG Versions Date Note
v12.0.0.15a


French, Dutch, German, Norwegian: languages_v12.0.0.15a

12.0-12.0.2+ 28 Oct 2018 Added options . Internal changes include
  • Removed my styling for little blue information icons in favor of the icon image that is part of TNGv12
  • Fixed a filename reference,
  • Coordinated more closely with Count Descendants v9,
  • The utility that can remove the old "Text" links is now invoked only through the mod's description in the

Mod Manager mod list (not through the Admin Chart Settings)

v10.1.0.13b
French, Dutch, German, Norwegian UTF8 translations: utf8_v10.1.0.13
French, Dutch, German, Norwegian non-UTF translations: iso_v10.0.1.13
Zip file that includes all three .cfg files: v10.0.1.13b-all
10.1.0 - 11.0.1.2+ 5 Dec 2017 * The only meaningful functional enhancement is that, in the Descendant Text+ Chart, the counts in the summary at the bottom of the chart change as you collapse and expand tree branches.

User interface changes:

  1. The fontsize, page size, and indentation controls on the Format for Printing page are highlighted more clearly, and do not print on a printer.
  2. Checkboxes on the innermenu now are shaded out when they are not applicable. Previously, they were hidden.

Also:

  1. The innermenu now has a button labeled 'Format for Printing' that is equivalent to the 'Print' button, instead of just a reminder to use the TNG button.
  2. Reworked the style classes that this mod defines in genstyle.css so that
    • They have a prefix of "cg" and are less likely to affect other programs, and
    • The rrnoprint class is no longer used - removing a dependency on Show Mod Names
  3. Fixed the fan chart link in the innermenu
  4. Removed the second line from cust_text.php target location search strings so that
  5. Added a standalone program to remove or restore the old Text chart links in the innermenus of various programs.
  6. Removed the mod-parameter that tried to hide the old Text chart link.
  7. Rewrote the Help file, added several screen clips, and moved the screen clips to the language folder.
  8. The Show Mod Names mod is now optional
10.1.0.12 10.1.2 - 11.0.1 15 Jun 2016 Added the system parameter that suppresses the link to the plain text charts, and the mod and its install programs now coordinate with the Ancestor Map and the Fan Chart.

French, Dutch, German, Norwegian UTF-8 translations: 10.1.0.12.zip
French, Dutch, German, Norwegian ISO translations: 10.0.1.12

11.0.0.11 download 10.0.2 - 10.0.3 17 Feb 2016
  • Fixes a comment typo in css/genstyle.css
  • Registers the mod and displays mod names using the Show Mod Names v2 conventions, and thus requires Show Mod Names. (Note: This dependency was removed in subsequent versions)
  • Implements label tags and no-wrap styling to improve the wrapping of the Text+ menus.
  • Adds help links to affected fields on the Administration >> Setup >> Chart Settings form, (Thus uses Blue Info Button)(The dependency was removed in subsequent versions)
Languages 10.0.2.10b 10.0.2 - 10.1.2 14 Sep 2015 Modified a few German, Dutch, and Norwegian strings that Google Translator messed up.

UTF-8 language strings v10.0.2.10b.zip
ISO language strings v10.0.2.10b.zip

10.1.0.10b & 10.0.2.10b 10.0.2 - 10.1.2 6 Sep 2015 Added annotation to make the Chart Formatting Form and help text easier to find and use, especially on the pretty-print page. Also fixed a bug that prevented non-English language installations from saving printer formatting settings to a cookie.
languages 10.0.2.8b 10.0.2 - 10.1.1 27 May 2015 New German translations.
10.0.2.10 & 10.1.0.10 10.0.2 - 10.1.1 25 May 2015 In the config file:
  • To avoid conflicts with a new mod from Eric Hoppe, changed a couple of target locations to put my Text+ innermenu link AFTER the text link instead of BEFORE the register link.

In descendtextplus.php and pedigreetextplus.php:

  • No longer changes the font family for the chart - uses the same font family and size as other charts
  • Removes an extra </div> that could have affected the footer of some sites.

In descendtextplus.php:

  • Positions the conditional descendcount.php link after the PDF link, instead of before.
10.0.2.9 & 10.1.0.9 10.0.2 - 10.1.1 12 Apr 2015 Displays christening data if birth data is missing, and burial data if death data is missing.
10.0.2.8 & 10.1.0.8 10.0.2 - 10.1 3 Feb 2015
  • Added two content-control parameters to the Text+ Descendant program.
  • The Text+ content-control parameters are now on the "main" screen as well as the Pretty Print screen.
  • Added the two Text+ programs to tngrobots.php.
  • Minor user interface enhancements.
10.1.0.7 10.1 12 Jan 2015 Updated database function calls for TNG v10.1 compatibility.
10.0.2.7 10.0.2-10.0.3 10 Jan 2015 Moves the printer-configuration form to the "Pretty-Print" page so that users can view charts without having to fuss with the printer configuration settings.
10.0.2.6 10.0.2 12 Aug 2014 First production release

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 Robin Richmond Mod developer 10.1.0.12 11.0.1 English
Mitchell Families Online Roger Mitchell Another great tool for visitors, very well implemented! 10.1.0.8 10.1.0 English
Turner mob Margaret Grogan Turner Another great tool for visitors, thanks! 10.0.2.6 10.0.3 English
Hooley Family Links Rick Hooley Public Site 10.1.0.10a 10.1.1 EN
Wortelboer Genealogy Bernard Wortelboer Public site 10.1.0.10b 11.0.0 NL, EN
Solem Jan-Thore Solem Not public 10.1.0.7 10.1.0 Norwegian
Moss family tree Chris Moss Best text-based display. Public. 10.1.0.12a 11.1.2 EN, DE, FR
Brady Family Tree in Western Australia Darryl Brady Public site 10.1.0.12 11.0.1 EN, DE
Roots & Relatives Remembered Ron Krzmarzick Public & Private 12.0.0.15a 12.0.2 EN,DE,CS,ES
Our Family Links Chuck Filteau Public site, modified Template 12 10.1.0.12 v10.1.2 EN