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

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


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

1. Download the module from http://drupal.org/project/autolink.
2. Download the AHAH Helper module from 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. Visit administer >> settings >> autolink to enable a plugin and view settings.
2. To enable a plugin, select the plugin from the dropdown list labeled
   'enabled plugin'. Note: once a plugin becomes enabled all settings are reset.
3. Click 'save configuration' to enable the plugin.
4. Once enabled, the plugin may add new configuration form items.
5. To configure the plugin, fill out new form elements and click save again.


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 these situations.


What is a plugin?
----------------
Autolink's extensible, pluggable system allows plugins to be written in order
to manipulate the way Autolink processes data. Plugins can define the type
of data that is converted during processing. Three examples of plugins come
with the Autolink package. The Autolink default plugin allows site-
administrators to generate links from pre-defined keywords. The Autolink
automatic links plugin automatically generates links from node titles, user
names, or taxonomy terms. And the drupal.org style link plugin links node IDs
in the same way that the drupal.org filter links issue numbers in brackets
formatted [#12345]. Plugins may even be written to perform text replacements
and not necessarily even generate links. To request a specific plugin for
Autolink please open an issue in the Autolink issue queue at
http://drupal.org/project/autolink.

Most plugins will use Autolink's filter method. Autolink adds its own filter
to handle plugin information, meaning the site-administrator needs to set
up the filter in most cases. To set up the Autolink plugin filter:

1. Visit administer >> settings >> input formats.
2. Click 'add input format' or edit an existing input format.
3. Select 'Autolink plugin filter for...' to enable the plugin filter.
4. Note: The plugin filter will only be available if the currently enabled
   plugin uses Autolink's filter method for processing and link generation.

For external plugins, consult the module's README.txt file for more information.


Developers:
----------
View DEVELOPERS.txt and autolink.api.php in the module folder for information
on module workflow and API functions. Soon to come, a tutorial on building
plugins for Autolink module.


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