Documentation

Linkr is a link submission system that allows you to create a powerful directory of links in seconds. It has intuitive user interface and easy to use control panel.

I. LIBRARIES AND FRAMEWORKS

This application uses these great technologies:

• CodeIgniter 1.7.2 - (User Guide)
  • Datamapper 1.7.1 for CI - (User Guide)
  • Datatables Library 0.4.1b for CI
• jQuery 1.4.2 - (Website)
  • jQuery UI 1.8.2 - (Website)
  • Datatables 1.6 - (Website)
• 960.gs (backend) - (Website)
• TinyMCE 3.3.8 - (Website)

II. SYSTEM REQUIREMENT

• PHP 5.0 or greater
• MySQL 4 or 5 with mysqli extension (recomended)
• mod_rewrite module if you are using Apache (optional)

III. HOW TO INSTALL

• Create a MySQL database
• Point your browser to your linkr root address (e.g. http://localhost/linkr), the installation process will begin.
• Follow the the instruction of each step. In the first step, you need to modify database.php located in "/app/config/database.php" in order to advance to the next step.
• Remove the “install” folder from your server.
• Thats all!

IV. HOW TO DEVELOP A NEW SKIN

This application is a skin based user interface. To develop a new skin, simply create a copy of a default skin (located in /skins/default/) and then modify the config.xml file. There is no need PHP skill here since you are only playing around with CSS and javascript.

The basic config.xml looks like this:

<?xml version="1.0" encoding="utf-8"?>
<detail>
	<name>Your Skin Name</name>
	<author>Your Name - your@email</author>
	<copyright>Your Name © 2010</copyright>
	<version>1.0</version>
	<description>My Linkr Skin</description>
	<stylesheets>
		<stylesheet media="all">css/style.css</stylesheet>
		<stylesheet media="print">css/print.css</stylesheet>
	</stylesheets>
	<javascripts>
		<javascript hook="header" type="external">js/header.js</javascript>
		<javascript hook="footer" type="embedded">js/footer.js</javascript>
	</javascripts>
</detail>

If you are familiar with joomla template system, so this must be easy, although this is not exactly the same. What you need to do is create a custom css/js file, upload to your skin folder, and register them in config.xml. Finally, you need to activate your new skin from your admin control panel.

V. BUILT-IN WIDGETS

Built-in widgets are generally a php file that does a specific function. These php files are located in "app/widgets/". Before you use them, let you know that this feature is an experimental.

Currently there are 5 built-in widgets:

• favorite.php - to show favorite listings.
• new.php - to show most recently added.
• popular.php - to show popular listings.
• pagelist.php - shows your site's pages.
• jumpbox.php - displays combo box to jump from one directory to another.

To include them in your widget, simply add a new widget from your admin panel, and wrap the filename in a special tag:

<l:include>
	popular.php
</l:include>

Some built-in widgets are also allow you to pass arguments

<l:include>
	popular.php?show=10&info=hits,description,url&more=show more
</l:include>

VI. CREDITS

• 108 Mono Icons, http://www.tutorial9.net/resources/108-mono-icons-huge-set-of-minimal-icons/
• Free Web Design Icon Set, http://semlabs.co.uk/journal/free-web-design-icon-set
• Splashy Icons, http://splashyfish.com/icons/
• Siena Icon Set, http://www.webdesignerdepot.com

VII. FAQ

Please find the Troubleshooting Guides and FAQ at http://linkr.demo.pixel6.net/page/faq.html