Comdev Misc Tool 4.1
==========================

You can choose to download only the Misc Tool component or the complete Panel Admin Suite. 
Before installing, we recommend you to take a look at the System Requirements.

System Requirements
-------------------

Script Type 			: PHP Server Side Scripting 

Operating System 		: Linux or Windows Server

Web Server 			: Apache or IIS 

PHP Version 			: PHP 4.2 or above 

PHP Configuration 		: ZLib library *
				: Safe_Mode = OFF
						
Database 			: MySQL 

Web Browser 			: Internet Explorer 5 or above, Firefox, Mozilla, Javascript and cookie enable 

Computer Hardware 		: PC and Mac 


* ZLib library is required to run the encrypted codes. We recommend PHP 4.2 and above as the lower 
  versions will results in buffer handling error.



Installation Guides
-------------------

1. Download the Misc Tool distribution ZIP file. 

2. Extract and upload the entire panel folder to the root level of your web server. 

		Example : http://your_domain_name.com/panel/ 
		
 
3. For Unix-based server, set the permission for the panel/_files folder and panel/config.php file to Read, Write, 
   Execute for all parties. You can set the file permission via your FTP client program.


		Example : chmod 777 _files, chmod 777 config.php
		
		
4. To access the Installation Wizard, visit to the URL of your panel folder (Panel Admin panel) using your web browser, http://your_domain_name.com/panel/.
   Follow the instructions in the Installation Wizard.
   
   * For Windows Server, you access to Panel Admin using http://your_domain_name.com/panel/index.php
   

5. Once the installation is completed, reset the file permission for 'config.php' file to 644.


6. You may proceed to login to the Administration area. 



Integration Guides
------------------

1. Using a text editor, open the web page file (.php file) that you wish to integrate the Misc Tool to, insert the line below to the top of the file, to call the 'config.php' file.

	<?php include_once("document_path_of_panel_folder/config.php");include_once($path["docroot"]."common/session.php");include_once($path["docroot"]."common/css.php"); ?>

	* Note: Always put the above code to the line 1, without any preceding character(s), not even a space.


2. Let's proceed to integrating the individual tool.


   Site Search
   -----------

   1. In your text editor, open the web page(s) you would like to display the search box, and the searched results.

      * Tips: The search box and the searched results can be separated to different pages.


   2. To show the search box, put the line below to your menu section.

      <?php include($path["docroot"]."misctool/home.sitesearch.php"); ?>


   3. In the body content part, insert the following line to display the search results.

      <?php include($path["docroot"]."misctool/home.searchresult.php"); ?>


   Tell A Friend
   -------------

   1. Insert this line to the menu of your php web page, to show the 'Tell A Friend' section.

      <?php include($path["docroot"]."misctool/home.tellafriend.php"); ?>


   Password Page
   -------------

   1. Assuming you have a password restricted page, called member.php that allows only registered users to access this page.


   2. To setup the login form, open the member.php file with your text editor, insert the line below, just ontop of the code / content portion you want to hide from public viewing.

      <?php include($path["docroot"]."misctool/home.passwordpage.php"); ?>

      * Tips: You can create either a Full Protected page, or Partial Protected page.
          * Full Protected Page (a blank web page with login form)
            - put the include line underneath the <body> tag

          * Partial Protected Page (a web page with header, follow by the login form)
            - put the include line on the top of <table> tag for body content.


   Mini Poll
   ---------

   1. Open the web page file you wish to addon the Mini Poll, on the menu section, enter the following line.

      <?php include($path["docroot"]."misctool/home.minipoll.php"); ?>


   Site Counter
   ------------

   1. On your web page file, point to the location you want to display your site counter, and insert this line.

      <?php include($path["docroot"]."misctool/home.sitecounter.php"); ?>


   Site Map
   --------

   1. In your preferable text editor, open your site map web page file, use the line below to display the site map entries on the body content.

      <?php include($path["docroot"]."misctool/home.sitemap.php"); ?>


* Substitute the 'document_path_of_panel_folder' for your own Document Path.


3. If you need code reference, you can look for this samplemisctool.php file.

