root/trunk/AutoLink/AUTOLINK-README.txt

Revision 1551, 2.1 kB (checked in by breese, 6 months ago)

updated readme

Line 
1#
2# README.txt file for the AutoLink Movabletype Plugin
3#
4
5ABOUT AUTOLINK
6
7AutoLink provides users with a way of creating a list of "hot words."
8Whenever these words appear in a post, they are automatically linked to
9a designated URL. For example, if you were to frequently write about
10Movable Type, and anytime you mention the phrase "Movable Type" in a
11post you want it to be linked to http://www.movabletype.org/ without
12having to enter the link manually. This plugin will do that for you.
13
14More advanced users could use AutoLink to setup linking rules that will
15turn Wiki formatted words into links into their internal/external wiki.
16
17PREREQUISITES
18
19Prior to installation, the following requirements must be satisfied:
20
21  * User has MovableType 4.1 or later installed
22    - it could work on 4.0, but it has not been tested
23
24INSTALLATION
25
26To install this plugin follow the instructions found here:
27
28    http://tinyurl.com/easy-plugin-install
29
30ABOUT AUTOLINK RULES
31
32Users manage how AutoLink is to convert strings, phrases and patterns
33into linkified text through a set of "rules." Each rule has the following
34properties:
35
36* Label - a human readable description of the rule and its intention
37* Pattern - the string to convert into a link
38* Destination URL - the URL that the pattern will be linked to
39* Regular Expression? - Process the pattern specified as a regular
40  expression, otherwise process it is a simple string or phrase
41* Link all occurrences? - Link all occurrences of the pattern, or just
42  the first occurrence.
43* Case insensitive? - Make the pattern case insensitive.
44
45ACCESSING THE INTERFACE
46
47Each blog in your installation of Movable Type is allowed to manage
48its own unique set of AutoLink rules.
49
50You can edit your list of AutoLink rules by clicking "AutoLink Rules"
51from the Manage menu in Movable Type.
52
53SUPPORT
54
55Please post your bugs, questions and comments to the AutoLink project
56homepage:
57
58  http://www.majordojo.com/projects/autolink.php
59
60RESOURCES
61
62  AutoLink:
63  http://www.majordojo.com/projects/autolink.php
64
65  Movable Type:
66  http://www.movabletype.org/
67
68LICENSE
69
70AutoLink is licensed under the GPL.
Note: See TracBrowser for help on using the browser.