meta data for this page
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
plugin:tinymce [2022/09/03 09:35] – [Settings page] duncanc | plugin:tinymce [2023/12/02 12:49] – [config.php] duncanc | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | ====== TinyMCE ====== | ||
+ | ---- plugin ---- | ||
+ | description: | ||
+ | author | ||
+ | type : editor | ||
+ | compatible : 3.x | ||
+ | tags : editor | ||
+ | |||
+ | sourcerepo : https:// | ||
+ | |||
+ | ---- | ||
+ | |||
+ | This plugin provides TinyMCE 4 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. | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==== Install through phpList==== | ||
+ | Install on the Plugins page (menu Config > Manage Plugins) using the package URL '' | ||
+ | |||
+ | ==== Install manually==== | ||
+ | Download the plugin zip file from https:// | ||
+ | |||
+ | 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, '' | ||
+ | |||
+ | ''/ | ||
+ | |||
+ | If you have placed the plugin directory outside of the web root then you must move or copy the `elfinder` directory from the plugin' | ||
+ | |||
+ | 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 '' | ||
+ | |||
+ | The upload directory will be shared by all admins. You can give each ordinary admin their own private directory by adding | ||
+ | |||
+ | <code php> | ||
+ | |||
+ | |||
+ | elFinder will use a subdirectory of UPLOADIMAGES_DIR named after the admin login id (1, 2, 3 etc.), creating the subdirectory on first-use. The subdirectory is private to the admin, and there is no sharing of image files. The URL of an image will therefore be something like this for admin id 2 | ||
+ | |||
+ | < | ||
+ | |||
+ | To give all admins, including super admins, their own subdirectory add | ||
+ | |||
+ | <code php> | ||
+ | ==== Settings page ==== | ||
+ | |||
+ | The Settings page has a TinyMCE group where you can configure the plugin. | ||
+ | |||
+ | * The URL of tinymce.min.js | ||
+ | * | ||
+ | * The width and height of the editor window. The default width is 0 so that the editor fills the surrounding element. | ||
+ | * You can select to generate a full HTML page when editing a message template. The template will then include ''< | ||
+ | * | ||
+ | * 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 have been copied from the [[http:// | ||
+ | |||
+ | See http:// | ||
+ | |||
+ | ===== Location of TinyMCE ===== | ||
+ | |||
+ | ==== URL of tinymce.min.js ==== | ||
+ | |||
+ | Starting in version 2.2.0 the plugin includes a copy of TinyMCE instead of loading from its Content Delivery Network. This is due to TinyMCE 4 no longer being supported. | ||
+ | |||
+ | If the default plugin directory has been used then the URL should be set correctly, e.g. | ||
+ | |||
+ | ''/ | ||
+ | |||
+ | But if you have changed the location of the plugin directory then you will probably have to amend this value. It needs to be the URL to the tinymce.min.js file. | ||
+ | |||
+ | |||
+ | |||
+ | ===== 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:// | ||
+ | |||
+ | 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' | ||
+ | |||
+ | ===== 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, | ||
+ | |||
+ | ====== Support ====== | ||
+ | Please raise any questions or problems in the user forum https:// |