|
Misc Tools > Documentation > Integration Guidelines
| Step 1 : Create new PHP page |
Create a web page where you would like to publish your Misc Tools. Save the web page file with .php extension, such as misctool.php
Note: You can put the file into web root directory or any directory on the server.
|
| |
Step 2 : Find document path |
To ensure that your Misc Tools works regardless the location of your web page, you will need to add your server's Document Path to all the PHP include codes.
To find the Document Path, open the ' /modulescontroller/config.php ' file with your text editor, and note this path down. Let's assume the Document Path is C:/wwwroot/user/modulescontroller/
|
| Step 3 : Call 'config.php' |
Insert the codes as below to your web page file to call the 'config.php', 'session.php' and 'css.php'. This will load all the necessary database connection, class declaration files and css control.
To do this, open the misctool.php file with a text editor, and put it to the topmost line (line 1) of the php file, without any preceded character.
<?php
include_once ("C:/wwwroot/user/modulescontroller/config.php");
include_once ("C:/wwwroot/user/modulescontroller/common/session.php");
include_once ("C:/wwwroot/user/modulescontroller/common/css.php");
?>
| Step 4 : Select tools to integrate |
| Site Search front-end integration guideline |
In your text editor, open the web page that you would like to display the search box, and the searched results. Note: The search box and the searched results can separate in different pages.
To show the search box, put the line below to your menu section.
<?php include("C:/wwwroot/user/modulescontroller/misctool/home.sitesearch.php"); ?>
In the body content part, insert the following line to display the search results.
<?php include("C:/wwwroot/user/modulescontroller/misctool/home.searchresult.php"); ?>
|
| Tell A Friend front-end integration guideline |
Insert this line to the menu of your php web page, to show the 'Tell A Friend' section.
<?php include("C:/wwwroot/user/modulescontroller/misctool/home.tellafriend.php"); ?>
|
| Password Page front-end integration guideline |
To setup the login form, open the member.php file with your text editor, insert the line below, just on top of the code / content portion you want to hide from public viewing.
<?php include("C:/wwwroot/user/modulescontroller/misctool/home.passwordpage.php"); ?>
|
Note: 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 front-end integration guideline |
Open the web page file you wish to addon the Mini Poll, on the menu section, enter the following line.
<?php include("C:/wwwroot/user/modulescontroller/misctool/home.minipoll.php"); ?>
|
| Site Counter front-end integration guideline |
On your web page file, point to the location you want to display your site counter, and insert this line.
<?php include("C:/wwwroot/user/modulescontroller/misctool/home.sitecounter.php"); ?>
|
| Site Map front-end integration guideline |
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("C:/wwwroot/user/modulescontroller/misctool/home.sitemap.php"); ?>
|
| Back to the top |
|
|
|
)
)