root/trunk/AutoLink/AUTOLINK-README.txt

Revision 651, 2.2 kB (checked in by breese, 7 months ago)

updated readme and added a todo item

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