Difference between revisions of "MediaWiki Integration"

From TNG_Wiki
Jump to: navigation, search
(updated for TNG 9.2)
(Sites using this mod)
Line 319: Line 319:
 
| [[User:HiTowerUK|Roger Mitchell]]
 
| [[User:HiTowerUK|Roger Mitchell]]
 
| On-going project of expansion
 
| On-going project of expansion
| 9.0.0.1
+
| 9.2.0.3
| 9.1.2
+
| 9.2.1
 
| EN
 
| EN
  

Revision as of 11:51, 18 July 2013

Ambox notice.png V8.1.5 of the Wiki Integration mod resolves the compatibility issue with the Relationship Display Mod in TNG 8.1.2 and adds new capability to create Source and Repository pages on your wiki.
V8.1.6 of the Wiki Integration mod resolves the compatibility issue with the Living Color Mod which must be installed after the Wiki Integration mod.
V9.0.0.0 includes the expanded Source and Repository page links and does not contain any known conflict with other mods.
If you also install the Geocode Assist Mod it should be installed after this mod, so the geocode globe displays after the location name.
TNG 9.0
TNG 8.0
TNG 7.0


Media Wiki Integration
Summary Integrates MediaWiki with TNG for Individuals, Places, Repositories, and Sources
Validation V9 mod is XHTML compliant.Valid-xhtml10.png
Mod Updated {{{mod_last_update}}}
Download link mediawiki_v9.2.0.3.zip for
TNG 9.2.0

mediawiki_v9.0.0.1.zip for
TNG 9.0

mediawiki_v8.1.6.zip for
TNG 8.1.2

mediawiki_v8.1.4.zip for
TNG 8.0

mediawiki_v1.2.zip for
TNG 7.0
Download stats View download statistics
Author(s) Brian McFadyen
Homepage Wiki Integration (this page)
Brian McFadyen's TNG Integration for history
Mod Support TNG Forums
Contact Developer
Latest Mod 9.2.0.3 for TNG V9.2
9.0.0.1 for TNG V9
8.1.6 for TNG V8.1.2
8.1.4 for TNG V8
1.2 for TNG V7
Min TNG V 7.1.0
Max TNG V 9.2.0
Files modified
genlib.php
getperson.php
personlib.php
link_wiki.php
substitution_list.php
Related Mods
Surname First Mod is recommended for wiki person page indexing in TNG V7
Use Name Order of Surname first (with commas) in TNG V8
Notes
For TNG V7 you must edit the config file before installing it to reflect the URL for your own MediaWiki installation
For TNG V9, if you also install the Geocode Assist Mod, it should be installed after the Wiki Integration mod.



Introduction

The Wiki Integration mod allows an integration of MediaWiki with TNG for Places and Individuals. The TNG Wiki modification is intended to provide a wiki environment for genealogy related stories, histories, and facts that is directly accessible from the individual person pages within the TNG software.

In particular, it will help create automated link between people and places from within your individual person pages.

An example of the results have been categorized into two primary sections:

on Brian McFadyen's Wiki

V8.1.5 of the mod extends the capability to also allow creating links for sources and repositories and resolves the incompatibility with the Relationship Display Mod in TNG 8.1.2


Restrictions

Note the TNG Wiki Integration mod has the following restrictions:

If you have not installed MediaWiki do NOT install this mod.
  • it must be using the same database as TNG.
If your MediaWiki does not use the SAME database as TNG, do NOT install this mod.

See the TNG Forum Entry MediaWiki Integration for additional details and history of the mod.

See also the MediaWiki - Installing for a visual supplement to the MediaWiki Installation Guide documentation.


Resulting GenWiki - TNG features

  • Within the person pages, an icon ( Doc.gif ) to the right of people's names will be displayed each time a wiki page is found that matchs the individual's name
  • If the TNG user is logged in with admin privileges then a grayed icon ( New doc.gif ) to the right of all possible wiki link points will be displayed
  • Within the person pages, all places are examined for string matches to the wiki database.
  • Examples of this may be found on the page: Example Page. Check the place "Tiverton" next to "Died" and the wiki link icon Doc.gif next to a couple of the names.
  • The appearance of the icon or place link is automatic if there is a corresponding wiki page.
  • It is also possible to include links in the notes for pictures and histories, however this is a strictly manual entry (using standard html href=.... language) as in this example - check the History line at the bottom, there is an embedded link.

Wiki Integration Links


Strategies for integration

Two different customizable strategies are available for the Wiki Integration:

  • Strategy 1 This approach is targeted at Location Strings that have been entered in a somewhat unrestricted manner. This strategy starts from the left, and checks for a GenWiki page that matches just the first segment, then the first two segments, then the first three segments, then four, five, etc. The largest continuous set of segments that match is turned into a GenWiki link. Then, the search starts again at the first non-matched segment and repeats the search. Segments that do not match a page are simply printed as text. This strategy is the default implemented by the mediawiki_v1.2.cfg file.
  • Strategy 2 This approach was developed by Roger Navarre and works very well for well structured location strings. This approach is targeted at location strings with the following format:
town, county, state/province, country

See Brian McFadyen's site on recommendation on how to replace the link_wiki.php with the files used by the second strategy.

MediaWiki extensions

Although links to the TNG generated pages can be created using standard wiki html links within your wiki pages, a small extension to the MediaWiki language makes this a little easier.

Note for V8.1.5 and above of this mod, you should copy the wiki language extension - persons.php from the TNG extensions folder to your wiki/extensions directory and follow the recommendations in the Post Installation.

For previous versions of the mod, this MediaWiki extension can be downloaded and installed from the MediaWiki Extensions on Brian McFadyen's web site.

The MediaWiki extension provides

A <tng> tag that uses the following syntax:

  • <tng i=XXX>Description</tng> for links to a person page using the person ID
  • <tng f=XXX>Description</tng> for links to a family page using the family ID

The previous <person> tags will continue to work the same as the new shorter <tng> tags.

The TNG person/family IDs may be determined by examination of the TNG person/family pages, or hovering your mouse over any TNG person/family link and monitoring the browser status line.

With the V8.1.5 version of the mod, the following tags were also added to persons.php:

  • <tng s=XXX>Source Title</tng> for links to return to a Source page
  • <tng r=XXX>Repository Name</tng> for links to return to a Repository page

The Source ID number should be the number displayed on the page created when clicking on document icon from the TNG source page. Note this should be the number only that follows the S id.

The Repository ID number should be the number displayed on the page created when clicking on document icon from the TNG repository page. Note this should be the number only that follows the REPO id.

See the Creating Wiki Links to TNG pages for illustrations on how to use the Wiki Language extension and on resulting links if the Wiki Language extension is not installed correctly.

See the Customizing the person.php file for illustrations on how to update the person.php in your wiki/extensions directory after installing the Wiki Language extension.

Developer

Mod developer is Brian McFadyen.

Modified by Ken Roy to support MediaWiki links for Repositories and Sources.

Modified by Jeff Robison to resolve conflict with the Relationship Display Mod in TNG 8.1.2

Modified by Rick Busbee to resolve conflict with the Living Color Mod in TNG 8.1.2

Modified by Linc Haymaker and Ken Roy for TNG V9

Revision History

Version Date Contents
V9.0.0.1 7 June 2012 Updated to not create the wiki link icons for the Person Preview on search results.
V9.0.0.0 2 February 2012 Updated for TNG V9
V8.1.6 25 Aug 2011 Updated to resolve conflict with the Living Color Mod in TNG 8.1.2
V8.1.5 27 Aug 2011 Updated zipfile to v8.1.5a to include the missing mediawiki/new_doc.gif file from V8.1.5
V8.1.5 6 Jun 2011 Updated to resolve conflict with the Relationship Display Mod in TNG 8.1.2 and to add new capability to link to Sources and Repositories, so that you can provide extended descriptions on your wiki for your TNG sources and repositories.
V8.1.4 16 Jul 2010 Bug Fix. Correction to yesterday's correction attempt.
V8.1.2/3 15 Jul 2010 Bug Fix. Failed attempts to correct the mistaken deletion of "Group Sheet" links on individual page.
V8.1.1 29 May 2010 Corrections to work with TNG V8.
V8.1.0 27 May 2010 Updated config file for TNG V8. The wiki URL, Wiki URL style, and Wiki table prefix are now editable parameters. See Mod Manager Syntax
V1.2 Dec 6, 2009 Updated config file documentation to point to TNG Wiki. This file is identical as that of V1.1 included in the Mod Manager zip file, but which will soon be eliminated from the bundle.
V1.1 12 May 2009 original Mod Manager config file

Requirements

For TNG:

  • A working TNG installation.
  • For improved GenWiki People Name indexing, it is recommended that the TNG option to list Surnames first be used.
found under Admin - General Settings - Name Order See also the Surname First Mod if running TNG V7
  • A backup of your TNG files
    • genlib.php (V7)
    • globallib.php (v8)
    • personlib.php
    • getperson.php
  • An installed current version of the Mod Manager.

For MediaWiki:

If you have not installed MediaWiki do NOT install this mod
  • The MediaWiki must be installed into the same TNG database and support table name prefixes
If your MediaWiki does not use the SAME database as TNG, do NOT install this mod.
  • A backup of your MediaWiki files
  • Installation of the Wiki Language Integration
  • An edited version of the person.php file in your wiki/extensions directory that reflects your wiki URL and treeID
  • Suggested Wiki Customizations to add the People and Place categories to your wiki sidebar

See also the MediaWiki - Installing for a visual supplement to the MediaWiki Installation Guide documentation.

Automated Install

  1. Download the appropriate mediawiki installation package from the status box above.
  2. Extract the zip file into your TNG admin/mod_folder for V7 or your /mods folder for V8
  3. If using TNG V7, edit the mediawiki_v1.2.cfg file as shown below
  4. Follow the normal automated installation for Mod Manager, as shown in the example Mod Manager - Installing Config Files

Note that the Wiki Integration Mod requires that your wiki database tables be installed in the same database as TNG. If your current MediaWiki installation is not using the same database as TNG, DO NOT install this mod.

Post Installation

TNG version: 8.0
If using TNG V8 and above, you must
  1. use the mod EDIT button on the Mod Manager page to enter additional details on your wiki
    • Wiki URL address
    • Wiki URL style
    • Wiki Database table prefix
  2. copy the persons.php file from the TNG extensions folder to your wiki/extensions folder, and
  3. edit the new persons.php file to provide
    • the URL for your TNG site
    • your treeID
$tng_url = "http://localhost/tng";
$treeID = "myTreeID";

so that the added <tng tags for Source and Repositories will be there in addition to the Individual and Family page return tag capabilities initially provided by Brian McFadyen.

Edit Config File (V7 Only)

TNG version: 7.0

Note that you must edit the config file to replace lines 127-128 which are

        $wiki_url = "http://yourownsite.ext/wiki/";
        $wiki_prefix = "wiki_";
with the URL for your own web site and the wiki table prefix that you used.

Failure to edit the wiki URL, will result in a link to an invalid web site instead of your own MediaWIki installation.

Note that the trailing slash should probably not be included in the URL above, since it resulted in a double slash which also generates an invalid URL for the wiki page.

Manual Install

No longer recommended and may not be current.

Manual Install instruction for previous versions are available on Brian's site.

The MediaWiki Integration on the TNG Forum also provide some instructions.

Note this TNG mod requires that you have MediaWiki installed using the same database as TNG. See the TNG Forum Entry MediaWiki Integration for additional details.

The following links provide information on integrating MediaWiki with TNG:

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
McFadyen Parker Genealogy Brian McFadyen Mod Developer. Best site to see this mod in action 8.1.4 8.0.1 EN
Genealogieën van de Veenkoloniën Henny Savenije 9.0.0.0 9.0.0 AF, DE, EN, ES, FR, IT, NL, NO, PT, SU, SV
Our Acadian, French-Canadian, and Maine Ancestors Ken Roy Installed on a test site only 9.0.0.1 9.0.3 EN, FR
Gentry-Rigsby-Kramitz Family Genealogy Thom Rigsby Just installed, only a few pages created 9.0.0.0 9.0 EN-US
Van den Heuvel Marco van den Heuvel Just installed, not much info yet. 9.0.0.0 9.0.3 NL, EN
Kleinmann Family Tree John Kleinmann Building it out now. Click "Narratives" on the left hand menu. 9.0.0.1 9.1.2 EN
MFO Sample Wiki Page Roger Mitchell On-going project of expansion 9.2.0.3 9.2.1 EN
... ... ... ... ... ...

TNG User sites using MediaWiki

Examples of sites using MediaWiki... but not the TNG Wiki Integration mod

Misc MediaWiki Genealogy sites

Related Links