genealogy component (tng)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf ·...

56
Genealogy Component Genealogy Component (TNG) (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Upload: others

Post on 20-Aug-2020

12 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Genealogy ComponentGenealogy Component (TNG) (TNG)

– Users Manual

Version RC1 Updated: 13 November 2009

Page 2: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Table Of ContentsTable Of Contents

TABLE OF CONTENTS...................................................................................................I

INTRODUCTION..............................................................................................................1

DESCRIPTION ......................................................................................................................1WHO IS THIS FOR?..............................................................................................................2REQUIREMENTS....................................................................................................................3SUMMARY OF FEATURES.......................................................................................................4

PRELIMINARIES.............................................................................................................5

TNG SETUP.......................................................................................................................5Where to install TNG...................................................................................................5UTF-8 Usage in TNG .................................................................................................5Recommended TNG Administrator Settings................................................................6

Privacy Settings.......................................................................................................6Gedcom Permission Setting.....................................................................................7

COMMUNITY BUILDER SETTING..............................................................................................8

INSTALLATION...............................................................................................................9

QUICK COMPONENT INSTALLATION ........................................................................................9

CONFIGURATION.........................................................................................................10

SETTINGS..........................................................................................................................10Configuration Tab.....................................................................................................11Debug Tab.................................................................................................................11User Tab....................................................................................................................12

Delete TNG-User when Joomla-User Deleted......................................................12Sync TNG Password during login if primary account authenticated with TNG...12TNG Component Group Permission override TNG Assigned Permissions..........13TNG Component Group Permission overwrite TNG Assigned Permissions........13Stop existing TNG user from registering for new account within Joomla............13

Display Tab...............................................................................................................14Template Tab.............................................................................................................15Default Permissions Tab ..........................................................................................15

USER MANAGER................................................................................................................16User Manager Screen................................................................................................16Synchronization and the Three Sync Directions.......................................................19

Joomla => TNG.....................................................................................................20Joomla <=> TNG...................................................................................................21Joomla <= TNG.....................................................................................................21

Changing User Permissions......................................................................................22User Details Page...................................................................................................23

TEMPLATES.......................................................................................................................24

i

Page 3: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

KNOWN ISSUES.............................................................................................................27

TNG FILE EDITPERSON.PHP.................................................................................................27

LIMITATIONS................................................................................................................28

TNG UPDATES ................................................................................................................28TNG ADMINISTRATIVE WINDOW.........................................................................................28ANCESTOR AND DESCENDANT CHARTS..................................................................................28CSS MAY CLASH...............................................................................................................28THIRD PARTY TNG CODE..................................................................................................29

TO DO LIST ....................................................................................................................30

APPENDIX A - DETAILED INSTALLATION...........................................................31

LOG INTO JOOMLA ............................................................................................................31COMPONENT INSTALLATION .................................................................................................32

Enable The Plugins....................................................................................................34Configure The Component........................................................................................35Set the Path and Template.........................................................................................36

SETTING THE MENU ITEM....................................................................................................37Step 1: Menu Item......................................................................................................37Step 2: Select Menu Item Type..................................................................................37Step 3: Name The Menu Item ...................................................................................38

APPENDIX B - “PARAMETERS – BASIC”................................................................39

APPENDIX C – TIPS AND TRICKS............................................................................40

TNG DIRECTORY ACCESS..................................................................................................40TEMPLATE AND CSS HINTS................................................................................................41

APPENDIX D – ERROR MESSAGES..........................................................................47

COMMON INSTALLATION ERRORS..........................................................................................47Directory Error.........................................................................................................47Plugin Error..............................................................................................................48

OTHER ERROR MESAGES ....................................................................................................48

APPENDIX E - TESTING..............................................................................................52

CREDITS..........................................................................................................................53

ii

Page 4: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

IntroductionIntroduction

Description

This is the first public release of the Genealogy Component (TNG) for Joomla 1.5.x. The overall goal of this project is to integrate TNG v7 with Joomla 1.5 giving full native genealogy functionality within a content management system.

The Next Generation of Genealogy (available at http://lythgoes.net/genealogy/software.php) by Darrin Lythgoe. The program is a powerful way to manage and display your genealogy data on the Internet, all without generating a single page of HTML. Instead, your information is stored within database tables and dynamically displayed in an attractive fashion.

Joomla 1.5 is an award-winning content management system (CMS), which enables you to build Web sites and other powerful on-line applications. Many aspects, including its ease-of-use and extensibility, have made Joomla the most popular content management software available. Best of all, Joomla is an open source solution that is freely available to everyone.

The latest release can be downloaded from http://www.joomla.org.

At the time of this writing the Genealogy Component (TNG) is in Release Candidate 1 (RC1) status.

1

Page 5: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Who Is This For?

This component was written for those who enjoy doing genealogical research and wanted to find a way to bring their research to the attention of others within a Web 2.0 realm.

In other words, this component bridges the strength of TNG and Joomla thus allowing users to research their genealogy and discuss it at the same time.

If you have trouble installing this component, you may want to go to the forums and ask for help or look for answers to your questions. http://www.cmsgenealogy.com/

We do assume you have some level of knowledge and experience with using both TNG and Joomla before you attempt to install and use this component.

2

Page 6: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Requirements

Disclaimer:

You are using this software AT YOUR OWN RISK.

There is no expressed or implied warranty or guarantee that this will not break your site or delete any data.

Remember: always back up your site, including your database, before installing this or any software.

You Must Have:

TNG 7 or higher

Joomla 1.5 or higher

It is beyond the scope of this manual to explain how to install TNG, how to install Joomla 1.5, and how to use an FTP or any other program you may have to use to setup and access files on your server.

Those programs come with their own installations and sets of instructions.

The Genealogy Component (TNG), plugins, and extra templates can be downloaded from:

http://www.cmsgenealogy.com/

This manual provides you with the basics to get you up and running with the component. There are numerous other configuration and possibilities on how to use this component.

We suggest checking out the forums and the wiki area for other ways to use this component.

3

Page 7: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Summary Of Features

Made Native for Joomla 1.5.xThis component was written from the ground up to work smoothly

with the new Joomla 1.5 engine.

Single Sign OnA Single Sign On between TNG and Joomla. Users can create accounts

in the Joomla front end and their information is automatically transferred to the TNG database

SynchronizationThree methods of synchronization of users between Joomla and TNG.

Add And Delete Templates EasilyWe have created the ability to add templates to the component which

will be portrayed in the Joomla front end of the component. Extra templates are available on the component download site.

Choose Templates “On The Fly”You can choose your template from a pull down menu within the

component.

Allow for Direct and Joomla AccessThe component allows for the administrator and users to either access

TNG through the Joomla CMS or for TNG to stand on it's own.

Search Engine FriendlyThe component was written so search engines such as Google and

Yahoo have no problems indexing individual pages (if you allow access).

Operating System (OS) FriendlyThis component has been tested to work on Linux, Mac, and Windows.

For a list of compatible web browsers see Appendix C.

Control TNG PermissionsYou can use this component to control TNG user permission settings

without having to even open up TNG.

4

Page 8: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

PreliminariesPreliminaries

TNG Setup

Where to install TNG

The component was written in mind for TNG to be installed in a subdirectory within the Joomla directory.

For example:

var/www/joomla/tng

The component has been tested and found to run TNG outside of the Joomla directory. We do not advise this due to potential security risks.

UTF-8 Usage in TNG

If you are using the UTF-8 setup with TNG you must change some code in four of the TNG files. This is necessary for now and we have brought this to the TNG developer's attention.

The 4 files to change are:

(1) rpt_descend.php

(2) rpt_fam.php

(3) rpt_ind.php

(4)and rpt_pedigree.php.

In each of these files look, around line 15, for the code that reads:

define('FPDF_FONTPATH', 'font/');Change it to read:

define('FPDF_FONTPATH',$cms['tngpath'].'font/');

5

Page 9: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Recommended TNG Administrator Settings

Privacy Settings

This section is to explain how global TNG “Require Login” in TNG affects the Joomla user login.

If you want general non registered Joomla users, and more importantly search engines, to see your TNG pages within Joomla then you will set “Require Login” to “No”.

If you set “Require Login” to “Yes”, this will force users to login into Joomla in order to see any data at all. The same as if you were using TNG in a stand alone fashion.

Remember if you set this to “Yes” then this will also stop search engines from indexing your TNG pages.

6

Page 10: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Gedcom Permission Setting

This is a reminder if you do NOT want any public user to be able to download gedcoms from your site.

Go to the admin section of TNG and then to

Trees => Edit existing Trees

Check the box that states “Don't allow users to download GEDCOM files”. Even with this set you can still allow certain users to download a gedcom using the component user settings.

7

Page 11: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Community Builder Setting

If you use a program called Community Builder 1.2 RC4 or greater with Joomla, you must open the general settings on the CB Configuration Manager and set

“Login Field Type” to

“Username, email or enabled CMS authentication plugins”

If you fail to do this you will have user login issues and may not be able to log into your site.

8

Page 12: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

InstallationInstallation

Quick Component Installation

If you are proficient with Joomla and TNG here is the fast track install of the component. You may want to look through the manual if you need to learn what the various settings are for.

1. Install the component (com_tngbridge.zip).

2. Go to plugin manager and enable the two plugins that were installed – “Authentication – tngauth” and “User – tngBridge”.

3. Setup the component configuration. You only have to point to the directory where TNG is located and then click on save.

You probably will want to set up your new user permissions as well. The standard TNG template is included. If you want other templates they can be downloaded from the project website.

4. Create a new Joomla menu item and select “TNG Genealogy” as the menu item type.

That's It!

For a more detailed installation and explanation of various configurations of the component, please consult Appendix A of this manual.

If you get any installation error messages check appendix D. If that does not help then go to the Forum.

9

Page 13: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

ConfigurationConfiguration

Settings

This section will take you through the various configuration settings for the component. When you click on the Joomla Components => TNG Genealogy menu item in your Joomla administrative back end you will open up the configuration section for the component as shown below.

Notice the top line that read “Settings” (the screen shown), “Users”, “Templates”, and “About”. These are all separate sections within the component and are discussed in detail later in this chapter.

Right now, you are looking at the Settings Section which currently contains the subsections (tabs) that reads “Configuration”, “Debug”, “User”, “Display”, “Template”, and “Default Permissions”.

10

Page 14: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Configuration Tab

This is the area where you add the path to where your TNG install is located. All the other fields will automatically populate as the component pulls th information from your TNG configuration file.

Therefore, if you do not have TNG configured properly the component will not work.

Debug Tab

You can turn this on in case you are getting errors and need to track possible bugs down. Information is posted to the joomla/logs directory.

11

Page 15: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

User Tab

There are 5 settings that you can tell the component to do with users when they log into or create a new account through Joomla.

Delete TNG-User when Joomla-User Deleted

If you set this to “yes” - when you delete the user in joomla it will also delete that corresponding user in TNG.

Setting this to “no” means that you can delete the user in Joomla and that user will still remain in TNG.

Sync TNG Password during login if primary account authenticated with TNG

If you set this to “yes” - When a user logs into Joomla and they previously existed in TNG but not in Joomla, the user and password will automatically be added to Joomla.

12

Page 16: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

When the user is created in Joomla this way he/she will show as a registered Joomla user.

TNG Component Group Permission override TNG Assigned Permissions

This will determine if TNG permissions are used or if Default Joomla Permissions used based upon the Joomla Group that user becomes part of. Setting to Yes will use the Joomla component permissions.

TNG Component Group Permission overwrite TNG Assigned Permissions

This will determine if the TNG permissions are overwritten by the Default Joomla Permissions based upon the Joomla Group that user becomes part of. Setting it to yes will overwrite the TNG permissions.

Stop existing TNG user from registering for new account within Joomla

If you set this to yes, a user in TNG who does not have a Joomla account will not be able to set up a new Joomla account.

They can just log into Joomla with their existing TNG username and password and the component will automatically pull the username and password from TNG into Joomla.

13

Page 17: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Display Tab

Setting this to yes will place the TNG page information in your browser's header area.

Many people do not usually even notice this. Look way up there at the top of your browser and you will notice it. Every browser is different so it may be in a slightly different location.

Youcan also enable UTF-8 here if you are using it with TNG. If you set this to yes go back to the “Preliminaries” Chapter of this manual in the TNG setting section in order to see which TNG files you will need to modify.

14

Page 18: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Template Tab

Choose from the pull down menu the TNG template that you want to show on the front end in Joomla.

Default Permissions Tab

When a new user signs up through Joomla the Genealogy (TNG) component will pass the information to the TNG database and set the TNG permission level for the new Joomla user

These settings only pertain to new Joomla users when they first login through Joomla or created by the Joomla administrotor.

You can set your new Joomla user levels to correspond to various TNG user privileges.

It is beyond the scope of this manual to explain the intricacies of permissions in both Joomla and TNG. The component is only used as a control to set New and current User permissions for TNG access.

15

Page 19: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

User Manager

This next section is somewhat complex and it requires full understanding of how TNG permissions are set and used.

Basically we have synchronized the Joomla and TNG users and provided access to TNG permissions through the component.

User Manager Screen

16

Page 20: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

The User Manager screen shows what users are synchronized between your Joomla database and your TNG database. In other words, which users are commonly linked to both Joomla and TNG.

At a glance you will know whether or not the users are synchronized between the two systems.

Notice the highlighted “Super Administrator”, this is how you know your users are synchronized between Joomla and TNG.

Synchronization is discussed in the next section.

Looking at the columns from left to right in the picture above you will see:

ID – This is the Joomla user id numberFullname – this is the name of the joomla user

17

Page 21: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Username – this is what the Joomla user wished to call him/herselfGroup – which Joomla group the user belongs toEnabled – whether or not the user is enabled in JoomlaTNG – whether or not the user is listed in the TNG databaseTNG ID – the TNG user IDTNG Username – the name of the user in TNG

When you see a check mark in the TNG column you can be assured this users is also in the TNG database.

18

Page 22: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Synchronization and the Three Sync Directions

This is a very powerful feature of the Genealogy Component (TNG). It synchronizes and all the users in both Joomla and TNG.

Click on the Synchronize button in the top right corner of Genealogy Component (TNG) “User Manager” menu.

19

Page 23: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

This will open up into the Synchronize menu.

Looking at the picture above you will notice that there are three “Sync Directions” listed in the pull down menu.

Joomla => TNG

This is useful is you have been using Joomla for a while and just start using TNG. You can easily export all your users from Joomla into the TNG program database.

This is also good if you decide later to quit using Joomla and continue to use TNG. You will still have all your users in tact in the TNG program database.

20

Page 24: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

You can also click the “Update existing user Informations from (Joomla=>TNG)” button to update user information when using this function. If you allow your joomla users to change things like their emails and passwords – this will update the old information in the TNG program database.

Joomla <=> TNG

This function makes sure the same users are in both databases. If there are users in the TNG users database they get added to the Joomla users database and vice versa.

This is useful if you have TNG set up as a stand alone program and you also have Joomla accessing the same TNG database. In a sense you are running two fronts to TNG. You may have users that want only a TNG or Joomla access - or you may have user that want access to both.

You can sync the data between the two sites.

If you click the “click the update existing user information” button then whatever is in the joomla user database will override whatever is in the TNG user database for a matching user.

Joomla <= TNG

This function takes the users from the TNG program database and adds them to Joomla.

This is good for those who have been using TNG and have set up Joomla to use with TNG. You can move all your established users from TNG easily to Joomla and then just have your users log in to your front end of Joomla.

All users from TNG to Joomla will be set as “registered” users in Joomla.

21

Page 25: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Changing User Permissions

Instead of having to open up TNG to set TNG user permissions as you typically would if just using TNG in a stand alone mode, we have provided the convenience to change TNG user permissions within the component.

When you are in the component's “User Manager” menu, look for the highlighted users and click on the highlighted link in the “Fullname” column.

Notice in the picture above that the User “Super Administrator” is highlighted. This tells us that the user Super Administrator is synchronized

22

Page 26: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

with the TNG database. We know this because there is a check mark in the TNG column.

Click on the highlighted Super Administrator link and this will open up to the “Users Details” page to where you can set that individuals permissions for the TNG program.User Details Page

Here you can set the individual user permissions for TNG. These permissions coincide with the TNG user permissions. This screen also allows you to enter the TNG typical user information in to the TNG database.

As you can see in the picture below, all user rights have been checked. This will give this user full rights to TNG.

It is beyond the scope of this manual to explain TNG user rights. You may want to visit the TNG Forums or the TNG Wiki to get a grasp of the TNG permissions and how they relate to TNG users.

We have added the same functionality in in our component as TNG. We've just laid it out differently.

23

Page 27: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Templates

The component comes with the TNG basic template scheme. This is not the actual TNG template, but a template we made to mimic the look of the default TNG template.

Do NOT try to install TNG templates into this section of the component. We do not use templates made specifically for TNG. All our templates are made strictly as plugins for the Genealogy Component.

We have created some other templates for you that mimic the TNG templates. They can be downloaded individually from where you downloaded this component and installed them in this section of the component.

Click on “Templates” and you will open the section to install and uninstall our templates as seen in the screen below.

24

Page 28: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Once you upload the template and it installs, you will get a screen showing the installation results and a listing of all the files that successfully uploaded.

If you want to use the temlate you just installed, go back to the component settings area and choose the template you just added.

25

Page 29: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

If you want to delete templates click on “Template Uninstall” tab and you can chose which template you want to delete. This is pretty straight forward.

We will release some more templates from time to time and will also have a forum area where users can discuss templates and share their own template creations.

Again, remember that these are not TNG templates. These templates are made specifically for this component. Attempting to upload TNG templates into the component will give you an error.

26

Page 30: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Known IssuesKnown Issues

These are known issues with the currently release of Genealogy Component (TNG).

TNG File editperson.php

The editperson.php file breaks out of Joomla into it's own window. This is not the fault of the Bridge or Joomla. TNG tells it to.

On line 185 within getperson.php you will see the TNG core code in which TNG drops any admin functionality into a new browser window with

target=_blank: $row[changedate] .= <a href=\"$cms[tngpath]" . "admin/editperson.php?personID=$personID&amp;tree=$tree&amp;cw=1\" target=\"_blank\">$text[edit]</a>;

27

Page 31: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

LimitationsLimitations

TNG Updates

Every time there is an update to the TNG you may have to wait for an update of this component in order to use the new version of TNG.

We are working with the Developer of TNG to where we will hopefully not have to update this component every time TNG is updated.

Please contact the author of TNG, thank him, and let him know you enjoy using TNG with Joomla. Let him know that you would like to see TNG and Joomla better integrated.

TNG Administrative Window

The administrative section of TNG breaks out into it's own window outside of Joomla. This is by design by the TNG author. This may cause TNG to break out of Joomla some times.

Ancestor and Descendant Charts

The TNG charts will push out of Joomla fixed templates if set too large. For example if you have a fixed Joomla template at 800 pixels wide and you open up 8 generations to view which is greater than 800 pixels, this will expand outside of the Joomla fixed template.

For aesthetics you may want to set your generation view to what fits within your Joomla template.

CSS may Clash

Some Joomla templates may use the same CSS naming schemes that may cause it to clash with some of the TNG template CSS. This could cause things like your ancestor charts to be partially hidden behind parts of the

28

Page 32: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

joomla template and various other template abnormalities.

This means you may have to track down and figure out what is causing the issue. This is one of the reasons we added the “Install Template” functionality so you can “tweak” the templates then easily upload them through the component.

It is best to go to the component forums to ask questions about any issues you may be having.

Third Party TNG Code

We cannot guarantee that any changes that you do to your TNG code will work with our component. We only tested TNG in it's unadulterated form.

For example, any JavaScript code you add to TNG may clash with Joomla's moo-tools and may cause unexpected results when rendering your TNG pages.

Any code changes you find in both the TNG forums and the TNG Wiki may not work with this component. We have not tested any of the addons that can be found in the forums or wiki. Most likely they will have to be re-written to abide by Joomla and moo-tools JavaScript standards.

29

Page 33: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

To Do ListTo Do List

Provide direct menu options for key areas within TNG, while providing a parameter settings for customizing those key areas. Example: browsemedia -> notes

"On This Day" Module (TNG Birthday and Death Dates) native for Joomla 1.5

Add a plug-in to integrate TNG with the Joomla Search engine.

Write a Template Manual

30

Page 34: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Appendix A - Detailed InstallationAppendix A - Detailed Installation

The following are the steps to install the TNG bridge within Joomla 1.5.x:

Log Into Joomla

Login to your Joomla 1.5 administrative back end with Super Administrator rights.

31

Page 35: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Component Installation

Install the component in the same manner you installed the Plugins ad as you would any Joomla component.

In the Joomla back end menu go to Extensions and click on Install/Uninstall This will open up the Extension Manager of Joomla.

Here you will click on “Browse” button then select the com_tngbridge.zip file that you earlier saved to your computer from the download site.

Once you have found the file, finish loading the component in Joomla by clicking on the “Upload File & Install” button.

32

Page 36: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

When the component loads you will see a screen similar to the one in the picture below that may tell you the install was successful or not. If you have all check marks as seen in the picture below, the component installed successfully.

If you have any instalation problems it is best to go to the component Forum and ask for help. http://www.cmsgenealogy.com

33

Page 37: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Enable The Plugins

After you install the component, the next thing you need to do is enable the two plugins in the Joomla Plugin Manager.

In the Joomla admin menu go to Extensions then click on “Plugin Manager” as seen in the picture below. This will open up the plugin manager screen.

Look for the plugins labled “Authentication -tngauth” and “User -tngBridge”, then click on the red x to enable them. After you click the x it will turn to a check showing that the plugin has been enabled. See the picture below.

34

Page 38: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Configure The Component

Go to the “Components” heading, drop down, and click on “TNG Genealogy” and select “Settings”.

This will open up to the configuration settings.

35

Page 39: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Set the Path and Template

Set the “Folder Path to TNG:” to the path where your TNG files are located.

If you placed TNG in a subdirectory of Joomla as was previously recommended, and named that subdirectory “genealogy”, then your “folder Path To TNG” would be “ /genealogy”.

Don't forget to “Save”!!!

This completes the installation of the TNG - Joomla Bridge Component.

When you save the component settings it will validate the component and double check that the version of TNG you have installed is valid.

If something went wrong with the install you may get an error describing what you need resolve. This is discussed in Appendix D.

36

Page 40: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Setting the Menu Item

Step 1: Menu Item

In your Joomla administrative back end go to “Menus” then select which menu you want to create your TNG Genealogy menu item in.

Step 2: Select Menu Item Type

Select the green “New” button in the top right corner. This will open up the “Select Menu Item Type” dialog. Select the The “TNG Genealogy” link and this will open up the parameters menu.

37

Page 41: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Step 3: Name The Menu Item

Now that you are in the parameters screen you will see title, alias, and link. The link should already be filled in. All you will need to is give your menu item a name such as “Genealogy” or “Database”. click on save in the upper right corner of the screen.

You can go back to this menu item later and enter in any other parameters you want.

See Appendix A for instructions on the “Parameters” setting for this menu item.

Fire up your Joomla front end and click on the menu link you just created.

Ta! Da!

...if everything went well you now have TNG embedded within your Joomla content management system.

38

Page 42: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Appendix B - Appendix B - “Parameters – Basic”“Parameters – Basic”

Go back to where you created your menu item and open it up again. On the right side of screen you will see “Parameters – Basic” and under this you will see “TNG Link”.

This parameter will allow you to set what link within TNG you would like your menu option to goto. If you leave this blank it will take you to the default front page which is “joomla_home.php”.

Examples are (case is sensitive):surnames cemeteries headstones

browsemedia searchform places

mostwanted whatsnew

We plan to add additional functionality in the future.

39

Page 43: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Appendix C – Tips and TricksAppendix C – Tips and Tricks

TNG Directory Access

Question:

How to make it so people do not have access to my home directory. I only want them to be able to come through Joomla.

Answer:

There are many different ways to do this, but the easiest way is to just re-direct the TNG directory back to your home directory with a couple of lines of php.

Edit you index.php file in the TNG root directory and add this line at the very top of the page.

<?php// Permanent redirectionheader("HTTP/1.1 301 Moved Permanently");header("Location: http://www.myhomepage.com/");exit();?>

Use Google to search for other tricks to redirect or if you want to redirect by using a .htaccess file which can be a bit more complicated.

40

Page 44: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Template and CSS Hints

Note: you will need to have access to your template files stored in the “Joomla_Root/components/com_tngbridge/tng_templates” directory.

Q. TNG is too wide for my Joomla template, what should I do?

A. TNG is optimized for a screen that is at least 800 pixels wide. With that said there are two ways to fix this.

1. Use a different Joomla template--preferably one that has a fluid width.2. You can Use the Module Manager in Joomla's Admin to disable the

left or right column. If you need help figuring that out use the Joomla forums or read the documentation.

Q. How do I change the TNG footer?

A. The TNG footer can be found in "/footer.php" that is within each template directory.

<br /><This site powered by <a href="http://lythgoes.net/genealogy/software.php">The Next Generation of Genealogy Sitebuilding</a> &copy;, written by Darrin Lythgoe 2001-2008.

Q. The rows in an individual's information boxes are too tall how do I fix this?

A. This will change every line height in TNG and may not give you the desired look. Look below for a better solution.

Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

#tngwrapper2{

41

Page 45: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

line-height: normal; } Q. How do I Fix the height of the drop down menu?

A. Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

#tngwrapper2 ul#mnav li{ line-height: normal; }

Q. I have unwanted bullet points in my horizontal menu how do fix this?

A. Open templatestyle.css (if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

#tngwrapper2 ul#tngnav li { background-image: none; padding:0; margin: 0; }

Q. On the Individal's page the information boxes have unwanted bullet points and is not aligned to the left.

A. Open templatestyle.css (if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

/*tngbridge: fixes bullet points in TNG */ #tngwrapper2 ul li#info { background-image: none;

padding-left: 0;

42

Page 46: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

list-style-position:outside; }

/*tngbridge: fixes bullet points in TNG */ #tngwrapper2 ul li#media { background-image: none; padding-left: 0; list-style-position:outside; }

/*tngbridge: fixes bullet points in TNG */ #tngwrapper2 ul li#notes { background-image: none; padding-left: 0; list-style-position:outside; }

/*tngbridge: fixes bullet points in TNG */ #tngwrapper2 ul li#citations { background-image: none; padding-left: 0; list-style-position:outside; }

/*tngbridge: fixes bullet points in TNG */ #tngwrapper2 ul li#eventmap { background-image: none; padding-left: 0; list-style-position:outside; }

43

Page 47: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Q. The drop down menu submenus are are not aligned to the top dropdown box and are too wide.

A. Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

If this is not sufficient to fix the alignment look below for another solution.

/* tngbridge: fixes drop down menu widths */ #tngwrapper2 ul#mnav li{ /* all list items */

padding-left: 0; list-style-type: none; margin: 0 2px 0 0; } Q. My drop down menus have a weird highlight when hovering on them.

A. Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

/* tngbridge: fixes drop down menu highlight on hover for Beez */ #tngwrapper2 ul#mnav li a:hover,#tngwrapper2 ul#mnav li a:active,#tngwrapper2 ul#mnav li a:focus { background:none; color:#39692A ; }

Q. My drop down menu's sub menus are not aligned with the top level drop down

A. Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

44

Page 48: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

/* tngbridge: fixes submenu left alignment in Beez */ #tngwrapper2 ul#mnav ul{ padding:0; margin:0; }

Q. The horizontal menu on the Individual's page when hovering on it does not show the image.

A. Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

/*tngbridge: fixes hovering on horizontal menu in Beez*/ /*active tab*/ #tngwrapper2 ul#tngnav li a:hover {

background: url(tngtabactive.png) no-repeat; color:#FFFFFF;

}

Q. The horizontal menu has wrong text color.

A. Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheets can be found in the TNG directory. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

/*tngbridge: fixes horizontal menu active tab text color */ #tngwrapper2 #tngnav a.here {

color:#FFCC00; }

Q. Bullet points in TNG are not aligned correctly.

A. Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Joomla-TNG bridge template directory.

45

Page 49: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

/*tngbridge: fixes alignment of bullets in some pages should match genlib.css*/ #tngwrapper2 UL.normal { margin-left: 5px; margin-top: 0px; margin-bottom: 0px; padding-left: 1em; } Q. Some lines are overlapping ie. at the top of the Surname List page. A. Open templatestyle.css(if you are using a TNG template) and add this to the bottom. The stylesheet can be found in appropriate Genealogy Component (TNG) template directory.

/* tngbridge: fixes line overlapping on some pages */ ul.normal li p { margin-top: 8px; margin-bottom: 0; padding: 2px; }

46

Page 50: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Appendix D – Error MessagesAppendix D – Error Messages

Many error messages have been coded into the component. This is to help both you and the developers with issues you may be having with the component. This is by no means an exhaustive list of error messages contained within the component.

Common Installation Errors

If you forget to do something or the component cannot find something it needs it will let you know.

Directory Error

If you point to the wrong directory where you think your TNG program is located you will see the error “Wrong Settings: TNG path /../../begin.php not found.”

47

Page 51: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Plugin Error

If you forgot to enable the plugins, the component will let you know it with the message “The tngBridge-usr-Plugin is not enabled” or “The tngBridge-auth-Plugin is not enabled”.

Other Error Mesages

" Unable to copy begin.php into Joomla root area which is required for TNG to run within Joomla."

48

Page 52: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Check the read/write permissions of your TNG directory. You must be able

to write to the directory. If for some reason the file is not writing to your

TNG directory you must manually put it there by using an ftp or other

similar program. Do not overwrite your original “begin.php” file. Rename it

to “begin0.php”.

"Unable to update the genlib.php within $tng_path."

Do the same as above.

"Could not update TNG Path within config.php.

Same as above.

" Unable to create customconfig.php within TNG root directory which is

required for TNG to run within Joomla."

Check the read write permission of your TNG directory. If you still cannot

get it to write you may have to open this file and change it manually. Go to

the forums for help.

49

Page 53: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

“Unable to update the logconfig.php to support TNG class elements.”

Check the read write permission of your TNG directory. If you still cannot

get it to write you may have to open this file and change it manually. Go to

the forums for help.

"Unable to update the \$cms[tngpath] variable within TNG's config.php."

Make sure the path is correct for where you installed TNG files. For

example if you installed TNG in a directory called “TNG” then your path

will be “/TNG”.

Some server set ups require that you put your absolute path here. The easiest

way to find this is if you have TNG already running, go into the TNG

administrative section >> Setup >> Paths and Folders >> Root Path and try

the path listed there. If you are still having issues ask in the forums under the

Joomla section.

"You are attempting to use this component with an invalid TNG version "

Check to make sure you are using the correct version of TNG that this

component is calling for. At the time of this writing TNG was at 7.x

"We were unable to query the TNG database, make sure you have a working

TNG application."

Check to make sure your stand alone TNG application is working. It is also

possible that your database server is down.

"We were unable to find your TNG config.php file.”

50

Page 54: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Check your TNG directory to make sure the file is still there and it has the correct

read/write permissions.

We were unable to find your genealogy application within …"

Make sure your TNG directory is still there or if you moved it and not pointed the

bridge to the new directory you will get this error.

"Config Default Permissions file not writable!"

Check the read/write permissions of your config.php file found in your TNG

directory.

"Can't initialize TNG; please check your TNG-Bridge Configuration is

valid, please check your TNG-Bridge Config!"

Check your settings and if you are using the correct version on TNG that the

bridge calls for.

There are many other errors that you might see that are not listed here. These

are built into the component so it is easier for you and the developers to

track down what the issue may be.

Most of the error messages are self explanatory. Please go to the forums if

you need help.

51

Page 55: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

Appendix E - TestingAppendix E - Testing

This is a list of operating systems and Web Browsers that were tested using the Genealogy Component (TNG).

FreeBSDFirefox

LinuxRedhat - Firefox 2Ubuntu – EpiphanyUbuntu – Firefox 3Ubuntu – Firefox 3.5Ubuntu – Flock 2Ubuntu – KonquerorUbuntu - Opera

MacFirefox 3

Safari 3

Opera

XPInternet Explorer 7 Firefox 3 Firefox 3.5

VistaInternet Explorer 6Internet Explorer 7Internet Explorer 8 Firefox 3Firefox 3.5 Flock 2.52OperaSafari 4.03

Note:

The Component was also tested with Community Builder and Jomsocial

with no adverse affects.

Remember to set Community Builder up correctly as shown earlier in this

manual.

52

Page 56: Genealogy Component (TNG)downloads.joomlacode.org/frsrelease/4/6/6/46671/manual_rev8.pdf · Genealogy Component (TNG) – Users Manual Version RC1 Updated: 13 November 2009

CreditsCredits

Sean Schwoerer – TNG-Joomla Bridge Senior Program Developer

Joseph Cox – TNG-Joomla Bridge Junior Developer

Patrick Craig – TNG-Joomla Bridge Junior Developer

Tom Kuehn – TNG-Joomla Bridge Beta Tester and Quality Assurance

Mark Obcena – Mootools Developer and Consultant

Keeto – Mootools Developer and Consultant

Darrin Lythgoe – TNG Developer and Consultant

Wendel Voigt – TNG-phpNuke Bridge Developer and Consultant

53