modules/easylink/README.txt

EasyLink Module README

Credits
-------
This module was developed for the Royal Oak Schools website by The Linuxbox Corporation.  If you have any questions, comments or feedback, please send e-mail to:

techstaff@linuxbox.com

Description
-----------
The purpose of this module is to make link creation in TinyMCE as easy as possible for non-technical users.  It adds a button to the TinyMCE toolbar that will open a pop-up window with a list of nodes the user can create a link to.  The user then clicks on the title of the node they wish to link to and the link is created.  This allows users to create links without having to know how to create URLs.  The list of pages is defined by giving a view on the configuration page.  Using a view allows the list of nodes to be easily customized through a familiar interface.

Installation
------------
1. Unpack the tarball in your modules directory.

2. Copy the subdirectory 'easylink' to the TinyMCE plugins directory (ex:
modules/tinymce/tinymce/jscripts/tiny_mce/plugins/easylink)

3. Register the plugin with TinyMCE by adding the following lines to plugin_reg.php

$plugins['easylink'] = array();
$plugins['easylink']['theme_advanced_buttons1'] = array('easylink');

4. After the module AND the plugin have been installed, enable the module.

5. Easylink ships with a default view that shows all pages authored by the current user.  If you would like to use this view installation is complete.  If you would like to use a different view, create it in the usual way and continue to step 6.

6. Go to the easylink configuration page (administer -> settings -> easylink ) and set the view you wish to use.

Configuration is now complete.  Goto a page with a TinyMCE editor on it and click the icon with the red 'ez' letters on it to see it in action!

1	EasyLink Module README
2
3	Credits
4	-------
5	This module was developed for the Royal Oak Schools website by The Linuxbox Corporation. If you have any questions, comments or feedback, please send e-mail to:
6
7	techstaff@linuxbox.com
8
9	Description
10	-----------
11	The purpose of this module is to make link creation in TinyMCE as easy as possible for non-technical users. It adds a button to the TinyMCE toolbar that will open a pop-up window with a list of nodes the user can create a link to. The user then clicks on the title of the node they wish to link to and the link is created. This allows users to create links without having to know how to create URLs. The list of pages is defined by giving a view on the configuration page. Using a view allows the list of nodes to be easily customized through a familiar interface.
12
13	Installation
14	------------
15	1. Unpack the tarball in your modules directory.
16
17	2. Copy the subdirectory 'easylink' to the TinyMCE plugins directory (ex:
18	modules/tinymce/tinymce/jscripts/tiny_mce/plugins/easylink)
19
20	3. Register the plugin with TinyMCE by adding the following lines to plugin_reg.php
21
22	$plugins['easylink'] = array();
23	$plugins['easylink']['theme_advanced_buttons1'] = array('easylink');
24
25	4. After the module AND the plugin have been installed, enable the module.
26
27	5. Easylink ships with a default view that shows all pages authored by the current user. If you would like to use this view installation is complete. If you would like to use a different view, create it in the usual way and continue to step 6.
28
29	6. Go to the easylink configuration page (administer -> settings -> easylink ) and set the view you wish to use.
30
31	Configuration is now complete. Goto a page with a TinyMCE editor on it and click the icon with the red 'ez' letters on it to see it in action!
32