--------------------------------------------------------------------------------
||||||||||||||||||||||||||||||||||| AUTOLINK |||||||||||||||||||||||||||||||||||
--------------------------------------------------------------------------------

Project page:
------------
http://drupal.org/project/autolink


Installation:
------------

1. Download the module from http://drupal.org/project/autolink.
2. If you want to use the keyword links plugin, download the AHAH Helper
   module at http://drupal.org/project/ahah_helper.
3. Unpackage each module into your site's sites/all/modules directory.
4. Enable the modules by visiting administer >> build >> modules.
5. Enable any of the additional plugin modules to access plugins.


Configuration:
-------------
1. Autolink uses an input filter to generate links. To set up input filter
   navigate to administer >> configuration >> content >> input formats and
   create or edit an input format, adding the Autolink filter to the format.
2. To enable a plugin, navigate to the input format's configuration page.
3. You will be displayed a list of located Autolink plugins once you arrive
   at the input format's filter configuration page. To enable a plugin, select
   the 'enable' link next to the desired plugin.
4. Once enabled, you may see a 'configure' link appear next to the newly enabled
   plugin. To configure the plugin, select the link and complete the form. Note:
   configuration forms may differ between plugins.
5. To adjust the weight - the order in which plugins are processed - drag plugins
   up or down to decrease or increase their weights respectively. Lower weighted
   plugins will be processed first.


Module use:
----------
Module use can vary depending on the plugin that is currently enabled.
Continue reading for instructions on how to use the module in various situations.


What is a plugin?
----------------
Autolink aims to provide an extensible method for generating links automatically
in content. As such, we've developed a system for developers that allows them
to write effective and efficient link generation plugins that fit seemlessly
and automatically into the Autolink user-interface. This allows other modules
to take advantage of the functions and processes that exist within Autolink,
and it ensures a consistent interface for the user or site administrator.


Keyword links plugin:
--------------------
The keyword links plugin provides an additional interface for defining specific
keywords to be converted to links. It supports generation of links to internal
site content, external urls, taxonomy terms, and different types of search results.


Pattern links plugin:
--------------------
The pattern-based links plugin provides a couple of methods of generating links
from patterns in content. It supports pre-defined patterns like [node-id:123]
as well as Token-based patterns. Note: Token-based pattern matching is harder
on site performance until the cache is built because of the nature of the
plugin's processes.


Markup generator:
----------------
As an added bonus, this version of Autolink also comes with an abstract markup
generator. This allows site-administrators or contributors to enter a pre-defined
pattern like [markup:apples] to generate specific markup around the keyword 'apples'.
This plugin will be built upon as the project moves forward. Note that this
particular plugin does require some knowledge of HTML as this point.


Developers:
----------
View DEVELOPER.txt and autolink.api.php in the module folder for information
on module workflow and API functions.


Maintainer/project lead: jordojuice
jordan.halterman@gmail.com
