In-Link Version 1.7.3 Documentation
Last Modified on 6/3/01
http://inlink.intechnic.com

I. INTRODUCTION
II. REQUIREMENTS
III. INSTALLATION
IV. UPGRADING
V. FEATURES
VI. LICENSING
VII. VERSION HISTORY
VIII. FILE LIST

LATEST UPDATES!

1.7.3 - 6/3/01
• Fixed bug with pending links timing out.
  

I. INTRODUCTION

In-Link is a revolutionary SQL directory engine allowing you to effortlessly run a Yahoo-style directory directly from your web site. All of the information is stored in an SQL database and therefore is easily updateable. The engine features dynamic presentation of data and includes multiple customizable features. This engine can be used for many purposes, including storing and sorting of information of any kind. In-link requires very little configuration and is fully equipped with advanced features.

One of the strongest features of In-link is that it is completely template-based, meaning that the entire engine's look and its output can be modified, customized and integrated into any web site. In simple words, you can take In-link and easily make it look like a part of your web site! In-link has built-in template editors that allow you to modify any visual element of the engine, as well as a configuration editor that allows you to modify system parameters.

In-link is entirely based on SQL, making it a very flexible directory engine allowing for instantaneous updates and feeding live data directly into your web site. In-link is a truly dynamic engine that pulls, processes and displays all of the data on the fly directly from the database. SQL allows for smooth performance even on websites associated with large volumes of data and traffic. In-link places no limitations on the volume of data, data structural depth or complexity.

In-link includes a number of features that make this directory engine stand out. In-link stores detailed information about all the links in the database, including data the link was added, number of hits, number of votes and its overall rating. In-link allows to perform advanced search on all links and categories, set permissions for adding new links, add new links and rate the existing links. In-link displays top rated, new, and the most popular links, maintains a count on all the categories and links and keeps permissions for every category.

II. REQUIREMENTS

Apache web server - In-Link was built and tested on Unix based server. Windows based apache server should also work but has not been tested.

PHP version 3 or above - PHP must be compiled with MySQL support. The latest version of PHP is 4.0.4.

MySQL version 3.22 or above - In-Link was built and tested on MySQL 3.22. Newer version of MySQL should work flawlessly.

You can get the software necessary at the following URLs:

Apache - www.apache.org
PHP - www.php.net
MySQL - www.mysql.com

III. INSTALLATION

1. Download and unpack all the files that came with the inlink1.7.0.zip file.
2. Upload all of the files to a directory on your server.
3. Create a MySQL database for In-Link to use.
4. Set the permssion of the setup.php file in the admin directory to 777.
5. Set the permssion of the searchlog.dat file in the main directory to 777.
6. Set the permission of all the template files (in the admin directory also) to 777.
7. Run setup.php from the admin directory and follow the directions.
8. If installation was successful, you should now be able to edit your template files from the admin utility.

IV. UPGRADING

1. Download and unpack all the files that came with the inlink1.7.0.zip file.
2. Upload all of the files to your In-Link directory, overwriting any old files.
3. Either run setup.php again or goto the In-Link support site to generate a new setup file.
4. In-Link should be running perfectly with your old database.

V. FEATURES

In-Link includes a number of features that make it stand out. Some of the most notable features of In-Link are:

Templates
Everything on In-Link uses a template. Each page has a template and every element on In-Link, such as the search box, the add link box, has a template. The template for each category can be unique. By placing a file named x.txt, where x is the id number of the category, that category will use the x.txt file as its template instead.

Unlimited number of levels
Categories can go as deep as you want. The number of links is limited by only the capacity of your server.

Advanced search
Users can search thru your In-Link database using keyword and boolean search.

Link voting
Links can be voted and ranked based on their rating or hits.

Category permission
Admin can set the permission of a category to either allow users to add links, not allow, or allow add with approval. The links submitted will be placed in a pending links database until the admin approves the link.

Full featured admin utility
The admin utility is password protected and can administer categories and links. Links can be moved between categories. All values of a category and link can be modified.

VI. LICENSING

If you did not purchase a license for In-Link, a small In-Link logo and a link to the In-Link website will be automatically added to the bottom of every page.

If you purchased a license for In-Link, there will not be a link and you are not required to display the logo or the link to the In-Link website.

To purchase a license for In-Link, you can goto the Intechnic Store to purchase a license for $195. If you have already installed In-Link on your website, you can goto the Licensing and Support page in the Admin Utility and purchase a license through its built in utility.

A license will give you full technical support and setup help for In-Link.

VII. VERSION HISTORY

1.7.2 - 5/22/91
- Fixed bug footer links not showing up.
- Fixed a bug with search which would not work if more than one keyword was used.
1.7.1 - 4/16/01
- Fixed bug with pending link descriptions disappearing when edited.
- Fixed a bug with the admin search page.
1.7.0 - 4/15/01
- Brand new installation script. No longer need paths.
- Password protected Admin Utility.
- New setup file. No more config.cfg. Easier to setup In-Link options.
- Displays sub-categories under category link.
- New search query log. See what users are searching for.
1.6.1 - 3/25/01
- Fixed a counter error when approving a pending link.
1.6.0 - 3/20/01
- All text elements for the main sections have been moved to static.txt for easy translation into a different language.
- New header and footer capabilities. Header and footer currently do not support embedded php code.
- Custom template for each category by placing x.txt in the templates folder where x is the category number.
- Fixed error with Today's hits.
- Links can now be moved to a different category from Admin.
- Added a recount links function to recount the number of links that a category shows.
1.5.6 - 3/9/01
- Fixed an error for Netscape that would display hidden tags.
- Fixed rating image error and an error with pending link approval.
1.5.5 - 2/27/01
- New admin features, allows editing of pending links information and category location.
- Can no longer add blank entries to links or categories.
- Fixed a bug that allows rating to be above 5.
- Fixed a bug that would return "In-Link not licensed for this server".
1.5.2 - 2/22/01
- Moved config.cfg to the admin directory for security reasons, improved support and licensing.
1.5 - 1/10/01
- Changed description field to textbox. Prevent multiple votings on same site.
1.4 - 10/6/00
- Made new template for the root category.
- Licensing utility from the admin page.
1.3.4 - 9/6/00
- Changed template system for section templates so each field has its own tag.
1.3.3 - 9/1/00
- Added confirmation page for deletions and counter resets.
1.3
- Major update. Added new/pop/top markers for links.
- Multiple columns for category display.
- Created individual templates for sections of the page, Ex. the search box.
1.2
- Added image generation for counter display and the ability to choose between text counter and graphical counter.
1.1
- Updated search engine with and/or boolean and limiting of search results.
- Added template editor and config editor.
1.0
- Initial In-Link release. Most basic functions included.

VIII. FILE LIST

-In-Link-
addlink.php
confirm.php
go.php
index.php
new.php
rate.php
readme.html <- the file you are reading right now.
search.php
searchlog.dat
searchlog.php
style.ccs
top.php
|
+------func- 
|	functions.txt
|	static.txt
|
+------templates-
|	addlinkform.txt
|	addlinktemplate.txt
|	cattemplate.txt
|	conftemplate.txt
|	footer.txt
|	header.txt
|	linktemplate.txt
|	maintemplate.txt
|	newtemplate.txt
|	rateform.txt
|	ratetemplate.txt
|	roottemplate.txt
|	searchform.txt
|	searchtemplate.txt
|	toptemplate.txt
|
+------admin-
	config.php
	confirm.php
	edit.php
	go.php
	index.php
	license.php
	login.php
	pcat.php
	pending.php
	search.php
	setup.php
	template.php
	top.php
	|	
	+------func-
	|	afunctions.txt
	|	astatic.txt
	|
	+------templates-
		admintemplate.txt
		admsearchtemplate.txt
		atoptemplate.txt
		cattemplate.txt
		configtemplate.txt
		conftemplate.txt
		edittemplate.txt
		licensetemplate.txt
		linktemplate.txt
		logintemplate.txt
		pcattemplate.txt
		pendcattemplate.txt
		pendtemplate.txt
		plinktemplate.txt
		roottemplate.txt
		templtemplate.txt