Using WP Super Edit

 

WP Super Edit is fairly easy to install and use. This WordPress plugin is compatible with WordPress 2.6 and above, and does require a modern web browser. If it doesn’t work for you, I’m really sorry! And please let me know!

Installation

  1. Take the whole whole “wp-super-edit” folder and put it in the wp-content/plugins/ directory of your Web site. How it gets there is up to you (FTP, WebDAV, RSYNC, SCP.. choose your poison!)
  2. Activate the plugin on the WordPress Plugins administration panel
  3. Click on the Settings option and you will see WP Super Edit in the sub menu.
  4. WP Super Edit should lead you through the final installation steps. Please be patient! WP Super Edit will attempt to save original settings while installing. WP Super Edit will not work until the installation has been completed!

Upgrade

  • Versions 1.5 or earlier:
    Before you install WP Super Edit
    , you should deactivate the old version of WP Super Edit and remove the superedit folder from the wp-content/plugins folder of your WordPress installation. Follow the installation instructions for the updated version. The updated version should use the wp-super-edit folder in wp-content/plugins and be more compatible and easier to update in the future. Due to the changes in the WordPress editor your old settings will not be updated for the new version of WP Super Edit.

Configuration Notes

You should always try to simply reload your editor first and if your changes are not shown then you should resort to emptying the browser cache.

TinyMCE uses compressed javascript scattered in several files. These files are cached differently than regular HTML. Sometimes you may have to empty your browser cache or temporary files to see configuration changes in your editor.

In some highly unusual cases, I have seen caching issues at hosting companies and ISPs where you may have to force WordPress to rewrite the TinyMCE javascript cache file saved in the wp-content/uploads/js_cache folder. You may be able to do this by loading the tiny_mce_config.php file in your web browser. This file is usually located at something like http://<your wordpress install>/wp-includes/js/tinymce/tiny_mce_config.php.

WP Super Edit Administration

The administration panel for WP Super Edit is located under the Settings area of the WordPress Administration panels and is only accessible by an administrator.

WP Super Edit has three option tabs:

WP Super Edit - Menu

WP Super Edit - Menu

  • Arrange Editor Buttons
    • Drag and drop interface to arrange the rows of buttons used in the TinyMCE editor.
    • This interface changes for different management modes. For individual user settings, the Arrange Editor Buttons interface will also appear under the user’s Profile area.
  • Configure Editor Plugins
    • Enable and disable TinyMCE plugins that are packaged with WP Super Edit.
    • Some TinyMCE Plugins may change the behavior of your website.
  • WP Super Edit Options
    • Change management mode.
    • Reset default user
    • Reset all users
    • Rescan tinymce_plugins folder to add new plugins
    • Uninstall

WP Super Edit Options

The WP Super Edit Options tab contains options for the overall function of the plugin.

  • Change management mode:You can change how button settings are used.
    • One editor setting for all users
    • Role based editor settings
    • Individual user editor settings
  • Reset default user settings will set the Default Editor Settings to the original scan of your TinyMCE editor settings.
  • Reset all user and role settings will set all users and roles to the current settings from the Default Editor Settings.
  • Rescan tinymce_plugins folder will rescan plugins in the tinymce_plugin folder to add new plugins. This will not unregister plugins that have been removed.
  • Uninstall will delete the WP Super Edit tables from your database so you can deactivate and remove this plugin completely. Once pressed you will have to reinstall WP Super Edit for it to function.

Arrange Editor Buttons

WP Super Edit - Arrange Editor Buttons

WP Super Edit - Arrange Editor Buttons

The drag drop interface makes arranging the visual editor buttons fairly easy. You can activate buttons by dragging the button to one of the Editor Button rows. Buttons placed in the Disabled Buttons area will be removed from your editor.

When you first activate the WP Super Edit plugin, some buttons will already be active. These are the default buttons activated by WordPress and scanned by WP Super edit during installation.

This interface will change depending on the management mode set under WP Super Edit Options. For the one editor setting for all users the Default Editor Settings will affect all registered users. If you are using role based editor settings then an administrator will have options to load and change editor settings for specific roles. If the Management Mode is set to individual user editor settings then an administrator can set the Default Editor Settings, but each user can set editor settings using a similar interface listed as Visual Editor Options under their user Profile. All new role and user settings will automatically inherit the currently set Default Editor Settings.

WordPress 2.7 User Button Settings

WordPress 2.7 has some dramatic interface changes, so the button settings for the individual user editor settings option may be located in a different area. Currently the user button settings are located on the left menu titled Visual Editor Options located below the main Users menu item.

This may change in the future when WordPress 2.7 is officially released. In the current development versions the administrative options for WP Super Edit are still located under Settings.

Button Options

Each button has two icons for information and controlling the separator between each button.

This icon will open a small dialog that will give you some brief information about that button.

This icon will activate and deactivate the separator for that button. You can identify buttons with separators because they have a thick dotted line. These separators can help make your editor look a little more organized. This option has no affect on the button functions.

The drag drop interface is not perfect, so it can be a little complicated to move buttons around.

Configure Editor Plugins

Some very useful TinyMCE plugins are included with WP Super Edit. Plugin options and other information is available under the Configure Editor Plugins tab. You can activate and deactivate a plugin by using the checkboxes.

Some plugins may provide buttons that can be arranged in your editor. Most of these buttons should appear in the Disabled Buttons area once you activate the plugin. When you deactivate the plugin the buttons will be automatically deactivated from your editor.

These TInyMCE plugins reside in the tinymce_plugins folder where you will find configuration files, program files, and language files.

Many of these plugins were modified from the original plugins released with TinyMCE. Some have been modified to use various options related to WordPress. You should not modify these files unless you know what your are doing.

Below you will find detailed information about the included TinyMCE plugins:

Layers (DIV) Plugin

This TinyMCE plugin allows the use of the DIV HTML tag in your posts and pages. This plugin will provide buttons to Insert Layers, Move Layer Forward, Move Layer Backward, and Toggle Layer Positioning (relative or absolute). Always be careful with layers since they can be troublesome in some WordPress themes.

Advanced CSS / styles Plugin

This plugin gives access to the Style Properties button. Style properties can make changes to the style attribute of HTML tags used in the editor. You should note that some people frown on use of the style attribute in XHTML.

Custom CSS Classes Plugin

This TinyMCE plugin allows you to place a special editor.css file in your active theme directory. You can then add CSS classes to the editor.css file that will be displayed in a drop down list provided by the Custom CSS Classes button. You will want to duplicate and classes from your theme’s style.css or other CSS files that you want to use in the visual editor. This is redundant, but this seems to perform better than adding the whole style.css file so you can selectively copy the classes you want to use for your editor.

This plugin uses a callback to add the <active theme>/editor.css file to your editor.

Tables Plugin

This plugin allows the use of the Table and Table Controls buttons. This will give your editor the ability to create and manipulate tables, rows, and cells using various buttons and dialogs.

XHTML Extras Plugin

This TinyMCE plugin shows interfaces for some XHTML tags like CITE, ABBR, ACRONYM, DEL and INS. It can also give access to advanced XHTML properties such as javascript events. This plugin provides the Citation, Abbreviation, Acronym, Deletion, Insertion, and XHTML Attributes Buttons.

Advanced Horizontal Rule Lines

This uses the advanced horizontal rule plugin that ships with TinyMCE. It allows you to insert and modify HR tags.

Advanced Image Link

This TinyMCE plugin will replace the standard image link button dialog with a dialog having more advanced options.

Advanced Link

The Advanced Link TinyMCE plugin will replace the standard link button dialog with a more advanced dialog having more options.

TinyMCE 2.x Compatiblity

This TinyMCE plugin attempts to offer compatibility with old TinyMCE 2.x plugins. This may cause some issues with your editor. This may be helpful if you are using another WordPress plugin providing older TinyMCE options, but please suggest to the original author to upgrade development to TinyMCE 3.x

Context Menu

The TinyMCE context menu is used by some plugins and may offer additional functionality. The context menu is activated by right mouse click (crtl-click on Mac) in the editor area.

Insert Date / Time Plugin

This TinyMCE plugin provides the insert date and insert time buttons that can be used to insert the current date and time.

Nonbreaking Spaces

This TinyMCE plugin adds a button to insert the nonbreaking space entity.

Print Button Plugin

A TinyMCE plugin that will add a print button to the editor that should print only the edit area contents.

Search and Replace Plugin

This TinyMCE plugin adds search and replace buttons and options to the editor.

Super Emoticon / Icon Plugin

This is a customized TinyMCE plugin based on the emotions plugin. This plugin uses the emoticons or icons that ship with WordPress. This will give you access to the Emoticon / Icon button that gives a visual interface to the WordPress icon set. This plugin uses the WordPress shortcodes API instead of adding HTML and can serve as an example for creating customized TinyMCE plugins for WP Super Edit.

Custom Languages

You should note that by default the TinyMCE visual editor will use the language defined by your WordPress installation. In many cases this can cause problems since the TinyMCE plugins may not have language files for your language installed by default.

This is a very rough guide to show how to install or create language files that will work with WP Super Edit. For information about having WordPress use your language, you should consult the WordPress Web site at: http://www.wordpress.org .

  1. WordPress uses WPLANG as defined in your wp-config.php file to set your default language.
  2. TinyMCE uses language files that are placed in the langs folder of each TinyMCE plugin. In the WP Super Edit tinymce_plugins folder you will find each TinyMCE plugin has it’s own folder. In each TinyMCE plugin folder you will find the langs folder. Currently you will see an en_dlg.js file that contains the default English language translations for the TinyMCE plugin and it’s buttons.
  3. Moxicode AB has a collection of translated files and information available at: http://tinymce.moxiecode.com/. From there you can read the documentation for languages, and you can also find a very large language pack available for download in your language.
  4. You should note that the Visual Editor will use an appropriately named language file from the langs folder. For instance the German translated files should be named “de_dlg.js” to match the WPLANG option set in wp-config.php.
  5. You can use the appropriate language file from the TinyMCE language pack. You should note that some of these plugins shipping with WP Super Edit are customized and may use different phrases than similar Moxicode TinyMCE plugins. Please check the TinyMCE plugin list earlier in this documentation for information about customized TinyMCE plugins. I have noticed that some of these language files may not be perfect, so you may need to edit them to have a fully translated version of the tinyMCE plugin.
  6. You can create your own translations. This is useful for the customized TinyMCE plugins. You can copy the current en_dlg.js file to a “<language>_dlg.js” file that matches the WPLANG option. Then you can edit that file with translations that match your preferred language.

Hopefully this is enough to help you get started with making WP Super Edit work in your language. Unfortunately, I am an American English speaking developer who can barely handle my own language, so I may not be able to offer a great deal of assistance for translations. I have set up WP Super Edit for localization, and a default wp-super-edit-en_US.po file is stored in the languages sub folder. If you have a translation, or if I did this completely wrong, please let me know!

Getting Help!

You can always contact me about issues. I can’t afford to do full-time support for WP Super Edit, so please be patient (In other words it could take a couple of days or weeks to return your e-mail.) And as always provide information about your WordPress installation and include WordPress version, MySQL version, and PHP version in your e-mail. You will find some known issues, feature requests and to do lists on:

http://funroe.net/projects/projects/wp-super-edit/bugs-and-feature-requests/

Giving Help!

If this plugin is helpful to you, please consider making a donation or other contribution.

I am not opposed to receiving help with the design and programming for this project, so drop me a line if you have improvements or additions.

The WP Super Edit WordPress Plugin is hosted at the WordPress Extend Plugins site:

http://wordpress.org/extend/plugins/wp-super-edit/

There you can also download older versions of the plugin and current development verison.