Simple:Press Documentation

Plugin: TinyMCE Editor

Plugin Description
Plugin: TinyMCE Editor – This Simple:Press plugin adds the The TinyMCE rich text editor to the forum.

TinyMCE is a  WYSIWYG and more type of editor.

Plugin Features

Installing this Simple:Press plugin adds:

  • A new Editor TinyMCE Rich Text section in the “Available Plugins – Install Simple:Press Plugins” panel under the forum Admin menu path Forum > Plugins > Available Plugins. From this panel the plugin can be activated, or deleted by the Admin.
  • When properly installed, a new folder in the “forum-plugin” folder named “tinymce-richtext” containing the plugin’s files.

Activating this plugin provides:

  • A change to the new Editor TinyMCE Rich Text section in the “Available Plugins – Install Simple:Press Plugins” panel under the Admin menu path Forum > Plugins > Available Plugins so the Simple:Press plugin can be deactivated, or have its Options set up.
    • The Options link goes to the new “Components – Editor – TinyMCE Settings” forum Admin panel.
    • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.
  • A new “Components – Editor – TinyMCE Settings” forum Admin panel where options associated with the plugin are specified.
  • A new sub-menu entry “Editor (TinyMCE)” linked to the new “Components – Editor – TinyMCE Settings” forum Admin panel under the “Components” menu item access from the Admin menu at Forum > Components.
  • A new check box for “Rich text (TinyMCE) under the “Post Editing” section on the “Options – Global Settings” Admin panel where the Admin can select the TinyMCE editor as the default editor for the site.
    • The selection is available from the Admin panel by navigating to Forum > Options > Global Settings.
  • A new check box for “Rich text – TinyMCE” under “Preferred Editor” on the users’ profile where they can select to use the TinyMCE editor.
    • The selection is available after the users select the “Profile” button to be able to view or edit their profile, select the “Options” tab, and then the “Edit Posting Options” sub-menu button.
  • If the TinyMCE editor is selected for use, above the text input section of the “Add Topic” or “Reply to Topic” post forms the post author sees the TinyMCE plugins and edit buttons available in the editor as selected by the forum Admin on the “Components – Editor – TinyMCE Settings” forum Admin panel.

There are no new permissions added to the permission sets due to this plugin.

Plugin Requirements

Simple:Press version 5.5.5 and above is required.

This plugin must be installed, activated, and its options set before it is operational.

As part of the installation, a “Editor TinyMCE Rich Text” section is added to the Plugin Management panel under the admin menu Forum > Plugins > Available Plugins. From this panel the plugin can be activated, deactivated, deleted, uninstalled, or its options set using its “Activate/Delete” and “Deactivate/Uninstall/Options” selections.

  • The Options link goes to the new “Components – Editor – TinyMCE Settings” forum Admin panel.

There are no new permissions added to the permission sets due to this plugin.

The plugin does not have template tags so no recommendation regarding Custom or Child Themes is being made.

Plugin Installation and Activation

Please see Using Plugins on how to obtain and install this Simple:Press plugin.

  • Whatever method is used to add the Simple:Press plugin, the folder that should have been added to the forum plugin folder is named “tinymce-richtext“.
  • If using the “Simple:Press Upload Plugin – Upload a Simple:Press Plugin” panel at the forum Admin menu Forum > Plugins > Plugin Uploader, the folder to browse for after downloading it from the Simple:Press site is “tinymce-richtext.zip” before clicking the “Upload Now” button.

As mentioned there the default location for Simple:Press plugin folders is …/wp-content/sp-resources/forum-plugins. If this path is changed, it is important to note that the plugin’s folder and its content need to reside in the forum plugins folder wherever it has been moved and however it has been renamed. See Storage Locations for more information.

Activation is accomplished from the Admin Dashboard panel menu by selecting Forum > Plugins > Available Plugins from the drop down forum Admin menu. On the “Available Plugins – Install Simple:Press Plugins” panel select the Editor TinyMCE Rich Text plugin and click on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options” with a “Getting Started” Link.

  • The “Getting Started” link associated with the “Deactivate/Uninstall/Options” selections should be selected to view the pertinent information regarding the plugin.

To deactivate the plugin, click on “Deactivate”. The “Deactivate/Uninstall/Options” label changes to “Activate/Delete”.
To re-activated the plugin, click on on “Activate”. The “Activate/Delete” label changes to “Deactivate/Uninstall/Options”.

Plugin Administrative Options

After activation, a) on the aforementioned “Available Plugins – Install Simple:Press Plugins” panel, click “Options” on the Editor TinyMCE Rich Text plugin section or b) under the Components entry on the Forum menu on the left side forum Admin page click the Editor (TinyMCE) sub-menu item to get the “Components – Editor – TinyMCE Settings” Admin panel with the “TinyMCE Options” and “TinyMCE Toolbars and Plugins” sections.

Components – Editor – TinyMCE Settings Admin Panel with Default Settings

  • TinyMCE Options Section Selections
  • Height of the Editing Window
  • Set the height of the editing window in the editor by inserting a value in the text box to the right of “Editing window height (in pixels):”. The default is 360.
  • If there are no other selections to be made on the panel, click the “Update” button at the bottom of the panel to save the selections.
    • Otherwise, proceed to the next selection.
    • Rejecting Embedded Formatting

Some users may paste content into the editing window that has been copied from a source with embedded formatting such as MS Word or even from their browser display. This can add a large amount of unwanted and unseen data to a post and will usually force a unique display when the post is shown.

  • To set an option to reject any such post and force the user to paste their content into one of the toolbar filters (MS Word or Text) that automatically removes the embedded formatting, select the check box to the left of “Reject posts with embedded formatting and force correct use of paste options”. This is strongly recommended when using the Rich Text Editor.
    • The check box is selected if it contains a green check mark.
    • If there are no other selections to be made on the panel, click the “Update” button at the bottom of the panel to save the selections.
      • Otherwise, proceed to the next selection.
  • TinyMCE Toolbar and Plugins Section Selections

In most cases the default TinyMCE toolbar is all that is needed. If it is desired to add more, the TinyMCE Rich Text Editor can utilize 2 tool-bars. Buttons are specified by their name and the list is comma delimited. The ‘|’ character specifies a separator.

TinyMCE Plugins can also be utilized. Plugin buttons must be placed on the ‘add’ toolbar button fields.

The pre-supplied TinyMCE Plugins are:

  • image
  • media
  • paste
  • link
  • textcolor
  • charmap
  • spoiler
  • sphelp

Built in TinyMCE Buttons available are:
(1) The Simple:Press Default set

  • bold
  • italic
  • underline
  • strikethrough
  • bullist
  • numlist
  • blockquote
  • outdent
  • indent
  • hr
  • link
  • unlink
  • forecolor
  • charmap
  • code
  • formatselect
  • alignleft
  • aligncenter
  • alignright
  • alignjustify
  • pastetext
  • removeformat
  • undo
  • redo
  • spoiler
  • image
  • media
  • sphelp

(2) Additionally Available:

  • justifyleft
  • justifycenter
  • justifyright
  • justifyfull
  • cut
  • copy
  • paste
  • cleanup
  • help
  • fontselect
  • fontsizeselect
  • styleselect
  • sub
  • sup
  • backcolor
  • backcolorpicker
  • visualaid
  • anchor

 

  • TinyMCE Plugins Selection
  • TinyMCE Plugins can be utilized.
  • Plugin buttons MUST be place on the ‘add’ toolbar button fields.
  • The pre-supplied TinyMCE Plugins set as default are:
    • link
    • textcolor
    • charmap
    • image
    • media
    • paste
    • code
    • sphelp
    • spoiler
  • In the text box below “TinyMCE plugins:”, separated by a space insert the plugins to be used on the TinyMCE editor.
  • If there are no other selections to be made on the panel, click the “Update” button at the bottom of the panel to save the selections.
    • Otherwise, proceed to the next selection.
  • Toolbar 1: Selections
  • In the text box below “Toolbar 1:”, insert the functions to be in the buttons of toolbar 1.
    • Separate the buttons by a space ” ” character.
    • Buttons can be be grouped.
      • Separate the groups by a “|” character.
    • The default is “bold italic underline strikethrough | bullist numlist | blockquote outdent indent hr | link unlink | forecolor charmap | code”
  • If there are no other selections to be made on the panel, click the “Update” button at the bottom of the panel to save the selections.
    • Otherwise, proceed to the next selection.
  • Toolbar 2: Selections
  • In the text box below “Toolbar 2:”, insert the functions to be in the buttons of toolbar 2.
    • Separate the buttons by a space ” ” character.
    • Buttons can be be grouped.
      • Separate the groups by a “|” character.
    • The default is “formatselect | alignleft aligncenter alignright alignjustify | pastetext removeformat | undo redo | spoiler | image media | sphelp”
  • If there are no other selections to be made on the panel, click the “Update” button at the bottom of the panel to save the selections.
    • Otherwise, proceed to the next selection.

The forum Admin can select which of the installed editors is to be used as the default editor on the “Options – Global Settings” Admin panel. The process is discussed below and on the Plugin: Editors Codex page.

  • Selecting the Default Editor
  • Navigate to Forum > Options > Global Settings to see the “Options – Global Settings” Admin panel with its “Post Editing” section.
  • In the “Post Editing” section under “Select Default Editor:”
  • Click on the check box to the left of “Rich text (TinyMCE) to use the TinyMCE editor as the default.
    • The check box is selected if it contains a green check mark.
  • Click on one of the other editor selections if the TinyMCE editor is NOT to be used as the default.
    • The other editor’s check box is selected if it contains a green check mark.
  • If there are no other selections to be made on the panel, click on the “Update Global Options” button at the bottom of the panel to save the selections.

To be complete for multilingual forums, the language translation files for this plugin should be installed or downloaded/properly placed in the appropriate forum-language folder for SP plugins using one of the procedures below in the “Plugin Language Translation” section of this page.

Plugin Language Translation

A plugin may not have language translation files, but in general each Simple:Press plugin has its own language translation files each with multiple pages for translating the forum plugin’s message strings.

Forum Plugin translation files are to reside in a unique forum folder location as defined by the “Simple:Press Plugin Language Files” entry on the “Integration – Storage Locations” forum Admin panel available through the forum Admin menu at Forum > Integration > Storage Locations.

  • The default location for forum plugin translation files is the folder “…/wp-content/sp-resources/forum-language/sp-plugins”.

Information regarding downloading language files, “mo’ language file placement, and translation (language localization) is found at Localization.

WARNING: On the Localization page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.

More information is available regarding translation files at Simple:Press Translations. which is the repository for Simple:Press language translation files. On the base page, select the “Getting Started Guide” link for basics about it’s use. On that page, select the “register a username here” link to obtain a password to the site. Use the “Contact Form” link to request the desired language if it is not currently available. The “Contact Form” link may also be used to volunteer to be a validator for a translation project.

This plugin’s available language translation files with translation statistics, and message translations can be viewed at TinyMCE Richtext within the repository for Simple:Press language translation files.

  • Installing this Simple:Press Plugin’s Language Translation “.mo” files
    The plugin’s language translations files for each language can be correctly located in two ways.

    • Using the Admin Word:Press “Site Language” and Simple:Press “Language Translation” Features
      WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
        • Under the “Language Translation Selection Sequences” heading, the “Coordinated Language Translation File Download Using the Simple:Press ‘Language Translation’ Selection” section, follow the instructions at “Adding its Translation File(s) After Downloading/Activating a Simple:Press Theme or Simple:Press Plugin”.
          • Follow the instructions to select the “Site Language” and then get to the admin page with the “Integration – Language Translations” section where there should be an entry for “Editor TinyMCE Rich Text” along with an “Install” button.
          • Click on the “Install” button for this plugin to install the language translation file for the current “Site Language” language.
            • Note: If the message “No Translation Project Exists” is displayed rather than the “Install” button, a translation file for that language could not be found in GlotPress at this time. Consider posting in the Simple:Press forum if it is felt there needs to be one added.
          • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
          • As called out in the section, continue to change the “Site Language” language and repeat the process until all desired translation files for this plugin have been installed.

       

    • Manually Finding and Storing Simple:Press Plugin’s Language Translation ‘mo’ files
    • WARNING: On the Localization codex page, the Language Translation “.mo” Files Overview should be reviewed and well understood for naming convention and language translation file placement.
    • After reviewing the material discussed under the “Language Translation Selection Sequences” heading, the “Manual Installation of Simple:Press Language Translation Files section, follow the steps outlined at “Finding and Storing ANY Simple:Press Plugin’s Language Translation ‘mo’ files”.
    • Each time through the process at the step, “Scroll down the list and click on the name of the plugin whose language files are being sought to see the translation file Version Number available”, substitute “Tinymce Richtext” for the phrase “the name of the plugin whose language files are being sought”.
    • Be sure to verify the locale (filename) for the “.mo” file matches the language code for the language as referenced in the “Warning” above. If it does not, change it to match.
    • Repeat the steps for each language it is desired to have a translation file (french, spanish, etc.) for the plugin on the website.

Plugin Special Notes

The TinyMCE editor is one of several available as a plugin for the forum. Please see the Plugin: Editors Codex page for more information on the available editors.

Plugin Usage

Forum Admins use the plugin set up the plugin’s options and use the editor when developing posts.

Forum users / members can select the TinyMCE editor even it is not the default editor selected by the forum Admin or deselect it if it is the default editor. The process is discussed below and on the Plugin: Editors Codex page.

  • Users Selecting the TinyMCE Editor for Posts
  • On the forum page header users select the “Profile” button to be able to view or edit their profile
  • Then select the “Options” tab
  • Finally select the “Edit Posting Options” sub-menu button to see the “Edit Posting Options” items.
  • Under “Preferred Editor:”
    • To use the TinyMCE editor click on the check box to the left of “Rich text – TinyMCE”
      • The check box is selected if it contains a green check mark.
    • To NOT use the TinyMCE editor, click on the check box to the left of one of the other editor options shown.
      • The TinyMCE editor check box is NOT selected if it does NOT contain a green check mark.
      • The selected editor’s check box is selected if it does contain a green check mark.
    • Click on the “Update Posting Options” button at the bottom of the panel to save the settings.

If the TinyMCE editor is selected for use, the TinyMCE editor edit options set up by the forum Admin are available to the forum user when developing posts.

  • Using TinyMCE Editor Edit Options
  • If the TinyMCE editor is selected for use, above the text input section of the “Add Topic” or “Reply to Topic” post forms the post author sees the TinyMCE plugins and edit buttons available in the editor as selected by the forum Admin on the “Components – Editor – TinyMCE Settings” forum Admin panel.
  • In a forum, click on the “Add Topic” or “Add Reply” buttons to get to their respective forms.
  • To use the TinyMCE editor functions, click on their associated button above the post text input area on the form.
  • After completing the form, click on the “Submit Topic” or “Submit Reply” button to submit the post.

Template Tags Used in the Plugin

There are no Template Tags used in this plugin.

Actions and Hooks Used in the Plugin

There are no Actions and Hooks available in Template Tags for this plugin.

There are six (6) other Actions and Hooks available for this plugin.
In file ‘sp-tinymce-init.php’

  • apply_filters(‘sph_add_tm_plugin’, $tm[‘plugins’]) – Allows modification of the TinyMCE plugins in use just prior to being output/returned.
  • apply_filters(‘sph_tm_init’, $tiny) – Allows modification of the TinyMCE “tiny” array elements before being used.
  • apply_filters(‘sph_mce_external_plugins’, array()) – Allows adding in external TinyMCE plugins along with the Simple:Press plugins before being used.
  • apply_filters(‘sph_tinymce_buttons_1’, $tm[‘buttons1’]) – Allows modification of the TinyMCE buttons display code used on toolbar 1 just prior to being output/returned.
  • apply_filters(‘sph_tinymce_profile_buttons_remove’, array(‘spoiler’, ‘charmap’, ‘blockquote’, ‘pastetext’)) – Allows modification of TinyMCE buttons on the profiles because space is tight by removing some or adding in different ones by the user.
  • apply_filters(‘sph_tinymce_buttons_2’, $tm[‘buttons2’]) – Allows modification of the TinyMCE buttons display code used on toolbar 2 just prior to being output/returned.

Plugin and Template Tag Changelog

Since Simple:Press version 5.5.

Codex page sync’d to code version 5.6.1 and plugin version 3.2.3.

More Topics In SimplePress: Plugins


Copyright © 2006-2019 Simple:Press. All Rights Reserved.