/phplist-plugin-tinymce

TinyMCE plugin for phplist 3.x

Primary LanguageJavaScript

TinyMCE Plugin

Description

This plugin provides TinyMCE 4 for editing messages and templates within phplist.

It also integrates the elFinder file manager to provide file upload and selection.

Compatibility

TinyMCE and elFinder are compatible with all the major browsers, see the TinyMCE site http://www.tinymce.com/index.php and the elFinder site https://github.com/Studio-42/elFinder/

Installation

Dependencies

This plugin is for phplist 3.

Requires php version 5.3 or later.

Set the plugin directory

The default plugin directory is plugins within the admin directory.

You can use a directory outside of the web root by changing the definition of PLUGIN_ROOTDIR in config.php. The benefit of this is that plugins will not be affected when you upgrade phplist.

Install through phplist

Install on the Plugins page (menu Config > Plugins) using the package URL https://github.com/bramley/phplist-plugin-tinymce/archive/master.zip.

In phplist releases 3.0.5 and earlier there is a bug that can cause a plugin to be incompletely installed on some configurations (https://mantis.phplist.com/view.php?id=16865). Check that these files are in the plugin directory. If not then you will need to install manually. The bug has been fixed in release 3.0.6.

  • the file TinyMCEPlugin.php
  • the directory TinyMCEPlugin

Install manually

Download the plugin zip file from https://github.com/bramley/phplist-plugin-tinymce/archive/master.zip

Expand the zip file, then copy the contents of the plugins directory to your phplist plugins directory. This should contain

  • the file TinyMCEPlugin.php
  • the directory TinyMCEPlugin

Enable the plugin

Click the small orange icon to enable the plugin. Note that only one editor should be enabled, otherwise phplist will choose the first that it finds.

Location of the TinyMCE and elFinder directories

The TinyMCE and elFinder directories must be within the web root.

If you have the default plugin location, define("PLUGIN_ROOTDIR","plugins") in config.php, then the plugin will use the correct paths automatically.

If you have placed the plugin directory outside of the web root then you must move or copy the tinymce and elfinder directories from the plugin's directory to somewhere within the web root.

Then use the Settings page (menu Config > Settings) to specify the path to each directory. In the TinyMCE settings section enter

  • the path to TinyMCE
  • the path to elFinder

Each path should be from the web root, such as /tinymce, not the filesystem path.

Also, if you move or rename the phplist directory or the plugin directory after installing the plugin, then you will need to modify the paths to TinyMCE and elFinder as they will not change automatically.

Configuration

The width and height of the editor window can be specified on the Settings page.

The UPLOADIMAGES_DIR value in config.php must be set to the location of a directory where elFinder can store uploaded images. The directory must be writable by the web server. Note that the value is relative to the web root and must not contain a leading '/'.

If the UPLOADIMAGES_DIR value in config.php is set to false then elFinder will be disabled and image uploading will not be possible.

Custom configuration

Other settings for the editor are entered directly on the Settings page. A default toolbar and plugin configuration has been copied from the Basic Example page.

See http://www.tinymce.com/wiki.php/Configuration for how to specify configuration settings.

Upgrade from phplist 2.10.x with FCKEditor

In phplist 2.10 the FCKIMAGES_DIR value in config.php defines the directory into which images will be uploaded. The value is relative to the phplist root directory.

In phplist 3.x a different value, UPLOADIMAGES_DIR, is used to define the directory. This value is relative to the web root, not to the phplist root directory. To continue using the same upload directory you must set UPLOADIMAGES_DIR correctly. So, for example, if the existing image upload directory is /lists/uploadimages then the FCKIMAGES_DIR would be uploadimages but the value for UPLOADIMAGES_DIR would be lists/uploadimages.

Upgrading TinyMCE

The plugin includes TinyMCE 4.0.10 but will not automatically upgrade to a new release of TinyMCE. You can download a later release of TinyMCE from http://www.tinymce.com/download/download.php. Then install on your web site and specify the path to the directory on the Settings page. Do not overwrite the version of TinyMCE in the plugin as that would then be lost if you upgrade the plugin later.

Donation

This plugin is free but if you install and find it useful then a donation to support further development is greatly appreciated.

Donate

Version history

version     Description
2014-07-13  Accumulated minor changes
2014-03-24  Include host name in links
2013-11-05  Initial version for phplist 3