root/trunk/LinkedEntryCustomFields/README.txt @ 895

Revision 895, 3.6 kB (checked in by jallen, 16 months ago)

Adding a README (still needs more info!) and just the teensiest bit of help in the UI to the plugin description to enable the user to more easily find the the conversion action link.

Would love to see this improved so that if a user has not yet converted their RF data, they can't possibly miss it and if they already have, they won't be confused about the conversion link that remains.

  • Property svn:eol-style set to native
Line 
1#############################################################
2This is a placeholder README.
3If you are the author, please fill in the __sections__ below.
4If you are not the author, please bug the author.
5#############################################################
6
7## LinkedEntryCustomFields, a plugin for Movable Type
8## Author: Mark Paschal, Six Apart
9## Version: 1.0
10## Released under __LICENSE__
11##
12## $Id$
13 
14## OVERVIEW ##
15
16This plugin provides not only conversion of data created by the RightFields
17plugin (http://www.staggernation.com/mtplugins/RightFields/) to the native
18custom fields format supported by Movable Type but also provides an
19additional RightFields custom field type that the native custom fields did
20not support, linked entries
21
22 http://www.staggernation.com/mtplugins/RightFields/#TypeLinked
23
24## PREREQUISITES ##
25
26__detail MT version compatibility and anything else the plugin requires__
27
28## FEATURES ##
29
30__A longer description of the plugin's features for those who are still reading__
31
32## INSTALLATION ##
33
34If you are a Subversion user, you can check out the plugin code from the
35repository.  The command below will produce a folder that can be put directly
36into your MT "plugins" directory:
37
38  svn co \
39  http://code.sixapart.com/svn/mtplugins/trunk/LinkedEntryCustomFields/plugins/LinkedEntryCustomFields
40
41If you would like to download a zip archive of the code, go to:
42
43http://code.sixapart.com/trac/mtplugins/changeset/latest/trunk/LinkedEntryCustomFields/?old_path=/&filename=plugin&format=zip
44
45Unzip the archive.  It will produce a folder called "trunk" with the
46following structure:
47
48    trunk/
49        LinkedEntryCustomFields/
50                                plugins/
51                                        LinkedEntryCustomFields/
52                                                                lib/
53                                                                tmpl/
54                                                                config.yaml
55
56Copy/move the LinkedEntryCustomFields folder found inside of the trunk/plugins
57folder into your Movable Type "plugins" directory.
58
59Once the LinkedEntryCustomFields folder is installed in your installation's
60plugins directory you have finished the installation.  Note however that if
61you are running Movable Type under FastCGI, you will have to restart your
62webserver in order for the plugin to be recognized.
63
64## CONFIGURATION ##
65
66The plugin contains no special configuration outside of the nomal Custom
67Fields configuration.  Please see the following for more information:
68
69http://www.movabletype.org/documentation/professional/custom-fields/overview.html
70
71## USAGE ##
72
73If you are upgrading an installation which used the RightFields plugin, you
74can convert that data to the native custom fields format by going to your
75system-level Custom Fields preferences (under the preferences navbar menu
76in the System Overview).
77
78Click the link on the right sidebar titled "Convert RightFields to Custom
79Fields".  You data will be converted immediately and can be utilized via
80the normal mechanisms described in the documentation above.
81
82## KNOWN ISSUES ##
83
84__detail any known issues with current version, if any__
85
86## SUPPORT ##
87
88__specify where people can go for support__
89
90## SOURCE CODE ##
91
92Source
93
94SVN Repo:
95    http://code.sixapart.com/svn/mtplugins/trunk/LinkedEntryCustomFields
96
97Trac View:
98    http://code.sixapart.com/trac/mtplugins/log/trunk/LinkedEntryCustomFields
99
100Plugins:
101    http://plugins.movabletype.org/LinkedEntryCustomFields
102
103
104## LICENSE ##
105
106__specify the license the plugin is released under__
107
108## AUTHOR ##
109
110__insert arbitrary author info, e.g name, email, URL, company, etc__
Note: See TracBrowser for help on using the browser.