#
# README.txt file for the QuickLink Movabletype Plugin
# 

ABOUT QUICKLINK

QuickLink provides users with a way of creating a list of "hot words."
Whenever these words appear in a post, links are automatically generated
for them. For example, if you were to frequently write about Web Services,
and you wish to have links automatically generated to various WS 
specifications, then you may configure QuickLink to replace every
occurence of the word "SOAP" with '<a href="http://w3c.org/TR/SOAP">SOAP</a>'.

More advanced users could use QuickLink to setup linking rules that will
turn Wiki style formatting rules, into valid HTML, or to censor out
profanity. In essense, QuickLink is a powerful regular expression manager
for MovableType.

PREREQUISITES

Prior to installation, the following requirements must be satisfied:

  * User has MovableType 3.x installed
  * User has HTML::Template installed

INSTALLATION

To install QuickLink in Unix, execute the following commands:

     > tar zxvf QuickLink-VERSION.tar.gz
     > cp -a QuickLink-VERSION/* $MT_HOME/plugins

Where MT_HOME is where you have MovableType installed, and where mt.cgi
can be found.

You will know if QuickLink installed properly if you can see QuickLink listed
under Configure Active Plugins.

ACTIVATING QUICKLINK FOR ENTRY PREVIEWS

Unfortunately in order to preview QuickLink changes before making a post,
you will need to edit $MT_HOME/lib/MT/App/CMS.pm

ACCESSING THE INTERFACE

Each blog in your installation of MovableType is allowed to manage
an independent QuickLink list.

To access the QuickLink interface, visit the main page for your MT
blog. At the bottom of the center column you should see "Edit My
QuickLinks" in a "Plugin actions" table. Click on "Edit My QuickLinks"
to access your instance of QuickLink for that blog.

SUPPORT

Please post your bugs, questions and comments to the QuickLink project
homepage:

  http://www.majordojo.com/projects/QuickLink/

If possible, please turn on debugging before you submit the report, and
submit your debugging info with the bug. To turn on debugging, set DEBUG to 1
in lib/MTPlugins/QuickLink.pm. Then consult your web server's error log
for the information reported by QuickLink when accessing its interface
through a browser.

HELP AND DONATIONS

QuickLink represents a lot of work by one individual. While the author
is happy to write this software, and support it completely free of charge,
the author also appreciates and form of support you can provide. Please
consult the following URL to learn more:

  http://www.majordojo.com/donate.php

RESOURCES

  QuickLink:
  http://www.majordojo.com/projects/QuickLink/

  MovableType:
  http://www.movabletype.org/

  Other MT plugins:
  http://mt-plugins.org/

LICENSE

QuickLink is licensed under the GPL.