

/////////////////> WhereBisDu v1.1 for PHPNUKE <//////////////////////
//                                                                  //
//  Copyright (C) 2002 Felix Geithner, master@theoffiz.com          //
//                                                                  //
//  This script is freeware, as long as the header is kept in tact. //
//  Use of this script is on own risk and no support is offerd.     //
//  To report a bug let me know by email.	     	        	    //
//                                                                  //
//                                                                  //
//////////////////////////////////////////////////////////////////////


INSTALLATION GUIDE
WhereBisDu v1.1 for PHPNUKE
by the canadian offiz [www.theoffiz.com]

----------------------------------------------------




1. Introduction and Requirements
--------------------------------
WhereBisDu v1.1 is a module for PHPNUKE.
It requires PHPNUKE 5.4., 5.5, 5.6 or 6.0 to be installed.
(not tested on other versions)






2. Installation
---------------
Extract archive to temp dir and copy included as noted below:
---------------------------------------------------------------------------------


// FILES ////////////////////////

README.txt (do not upload)
docs/INSTALL.txt (do not upload)
docs/LICENSE.txt (do not upload)

html/modules/WhereBisDu/index.php
html/modules/WhereBisDu/wbdgeo.inc
html/modules/WhereBisDu/wbdtrack.php
html/modules/WhereBisDu/wbdmaphigh.swf
html/modules/WhereBisDu/wbdmaplow.swf
html/modules/WhereBisDu/colorpicker.php

html/modules/WhereBisDu/language/lang-english.php
html/modules/WhereBisDu/language/lang-french.php
html/modules/WhereBisDu/language/lang-spanish.php
html/modules/WhereBisDu/language/lang-german.php

html/modules/WhereBisDu/images/hirachy.gif
html/modules/WhereBisDu/images/noflash.jpg
html/modules/WhereBisDu/images/blank.gif

html/wbdflashloader.php

blocks/block-TopWhereBisDu.php

admin/case/case.wherebisdu.php
admin/links/llinks.wherebisdu.php
admin/html/modules/wherebisdu.php

images/admin/wherebisdu.gif
images/wbdflags/*.gif          //includes all country flags

sql/wbd_v1_1.sql      // only to use with an mysql editor







3. INSTALLATION
------


- Use the sql file 'wbd_v1_1.sql' to create the necassery tables in your DB using a MySL-Editor. Replace the prefix 'nuke_' with the prefix you use in your database if needed.



- Upload all the files in the folder 'html' in the shown location to your webserver.



- You need to include this line in the file 'footer.php':

	require("modules/WhereBisDu/wbdtrack.php");

for example, like this:

function footmsg() {
    global $foot1, $foot2, $foot3, $foot4;
    echo "<font class=\"tiny\">\n"
	."$foot1<br>\n"
	."$foot2<br>\n"
	."$foot3<br>\n"
	."$foot4<br>\n"
	."</font>\n";
	require("modules/WhereBisDu/wbdtrack.php");
 }

(If the theme use tables for display the footer then you must include the line inside the function themefooter ( or whereever you create the footer ).)


- Modify or create the language file as desired to display the standard content in the pages and in the Flash Movie.
Read the file 'Flash&HTML.txt' to see all the allowed HTML tags and special characters in the Flash Movie.


- The  administration is pretty much selfexplanatory. ;)
Call it through your administration page (for example: http://www.yourdomain.com/admin.php). Make it publicly available (if desired) in the modules.


- Last but not least, you need to modify the settings in the Admin Tool to your desired system settings. Nothing big - just fun stuff. You'll see. ;)
Go to the Admin Tool via your admin page and click on 'WhereBisDu'. In the Admin Tool you'll see the link 'Configure Settings' on the top right of the page. The main settings include the following:


// Access ///////////////////////////////////
- Useraccess
Here you can set the access for your visitors.
Set 'Member' if you only want members of your web site to see other member location and other member name.
Set 'Anonymous' if you want all visitors of your web site to see member location and member name.
Of course, if you set the hole module to only be accessable by members this setting is meaningless. ;)


// Flash ///////////////////////////////////
- Set the name of the Shockwave File:
set here the quality of the Shockwave file
wbdmaphigh.swf => high quality (440 KB)
wbdmaplow.swf => low quality (230 KB)
 
- Set the value for the first theme Color in the Flash Movie:
Set here the prefered Color Hex Value for the border color of the Flash Movie.
(Color = Colorpicker for websave hex colors) 

- Set the value for the second theme Color in the Flash Movie:
Set here the prefered Color Hex Value for the color of shapes inside the Flash Movie.
(Color = Colorpicker for websave hex colors) 

- Set the path to the registration page:
Set the path to the  page to create an account on your web server starting from the main directory.
on Phpnuke 5.4 : "user.php"
on Phpnuke 5.5 - 6: "modules.php?name=Your_Account"
Don't use a slash (/) or spaces at the end or begining!


// Module ///////////////////////////////////
- Set the limit for items on the Top Country Page:	 
Set this to the number of results you wish on each Main Page in the public section.

- Set the limit for items on the Country Page:	 
Set this to the number of results you wish on each Country Page in the public section.

- Display flag images in Module Main Pages:
Set this to 'yes' if you want to display the flag images in Module Main Page.
Set this to 'no' if you don't want to display the flag images in Module Main Page.
You would set this most likely to 'no' out of performance reasons.


// Block ///////////////////////////////////
- Set the limit for Countries in the Block:	 
Set this to the number of results you wish in the Block.

- Display flag images in the Block:
Set this to 'yes' if you want to display the flag images in the Block.
Set this to 'no' if you don't want to display the flag images in the Block.
You would set this mostly to 'no' out of performance reasons.


// Path ///////////////////////////////////
- Set the path to the flag images:	 
Set the path to the flag images starting from the main directory.
Don't use a slash (/) at the end!

- Set the path to the user info page:
Set the path to the member info page on your web server starting from the main directory.
On Phpnuke 5.4 : "user.php?op=userinfo&uname="
On Phpnuke 5.5 - 6: "modules.php?name=Your_Account&op=userinfo&uname="
Don't use a slash (/) or spaces at the end!


// Admin Tool ///////////////////////////////////
- Set the limit for items on the Admin Top Country Page:	 
Set this to the number of results you wish on each Main Page in the admin section.

- Set the limit for items on the Admin Country Page:
Set this to the number of results you wish on each Country Page in the admin section.









4. USE
------

This version allows:
 1) admins to configure the main settings for the module via the Admin Tool.
 2) admins to delete a single IP Address and its data.
 3) admins to delete a hole Country and its data.
 4) admins to define if the useraccess to see member data in the Flash Map and the Listing is resticted to members only or also anonymous user.
 5) admins to define the text in the Pages and the Flash Movie via the language file in their prefered language.
 6) web site visitors to see Visitor Locations on the Visitor Map.
 7) web site visitors to sort the content by country, by city, by state, by ip address and by domain name.




5. VERSION RELEASE
------

v1.1.2
admin
- can configure the main settings for the module via the Admin Tool
- can set a color theme (2 colors) for the Flash Movie via color picker in the Admin Tool
- new table added for storing the configuration settings in db



v1.1.1
admin
- can delete a single IP Address and its data
- can delete a hole Country and its data
- can define if the useraccess to see member data in the Flash Map and the Listing is resticted to members only or also anonymous user
- can define the text in the Pages and the Flash Movie via the language file in their prefered language

user
- can see Visitor Locations on the Visitor Map
- can sort the content by country, by city, by state, by ip address and by domain name





