User Tools

Site Tools

Translations of this page:

plugin:tinymce

TinyMCE

Compatible with version

3.x

plugin This plugin provides TinyMCE, an HTML text editor, for editing messages and templates. This is for phplist 3.x.

Repository
Source

Tagged with editor

By Duncan Cameron

This plugin provides tinyMCE for editing messages and templates. It also integrates the elFinder file manager to provide file uploading and browsing.

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 Enable button to enable the plugin. Note that only one editor can be enabled.

Location of the elFinder directory

The elFinder directory 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 path automatically.

If you have placed the plugin directory outside of the web root then you must move or copy the `elfinder` directory from
the plugin's directory to somewhere within the web root. Then use the Settings page (menu Config > Settings) to specify the path to the elFinder directory. The path should be from the web root, such as /elFinder, 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 path because it will not change automatically.

Configuration

config.php

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.

Settings page

The Settings page has a TinyMCE group where you can configure the plugin.

  • The URL of tinymce.min.js
  • Custom configuration settings.
  • The width and height of the editor window.
  • You can select to generate a full HTML page when editing a message template. The template will then include <html>, <head> and <body> elements. This setting defaults to Yes.
  • Similarly you can select to generate a full HTML page when editing a message. This is useful only when you do not use templates, otherwise the template and the message will both contain <html>, <head> and <body> elements. The default value is No. If this field is set to Yes then it is ignored if Allow templates to be edited as full HTML pages is also set to Yes.
  • The website path to elFinder.

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.

Location of TinyMCE

Starting in version 2.1.0 of the plugin TinyMCE is loaded from its Content Delivery Network. Earlier versions of the plugin included a copy of TinyMCE but that is no longer the case.

If you want to customise TinyMCE, such as by adding further plugins to it, then you can install a local copy. You must then enter the URL for tinymce.min.js in the TinyMCE group on the Settings page. For example, if you installed TinyMCE in the directory tinymce_4.4.3 of your web site then the setting would be /tinymce_4.4.3/tinymce.min.js.

Upgrade elFinder

The plugin includes elFinder 2.1.6 but will not automatically upgrade to a new release. You can download a new release of elFinder from http://studio-42.github.io/elFinder/#elf_l1_Lw.

To install the build, expand the zip file, copy the elfinder_xxx directory to your web site, and specify the path to the directory on the Settings page. It is recommended to use a new directory rather than overwriting the elFinder version in the plugin's directory, so that it will not be affected if you upgrade the plugin.

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.

Support

Please raise any questions or problems in the user forum https://discuss.phplist.org/

plugin/tinymce.txt · Last modified: 2016/10/19 09:05 by duncanc

Resources
Contact Us

e: info@phplist.com

Boring Bit

phpList is a registered limited company

UK Company No. 07582966

VAT Registration 122 0788 37

© phpList 2016