TinyMCE Plugin ~ readme / help file

TinyMCE provides a javascript-driven "WYSIWYG" editor similar to what you might find in a word processing program. With this plugin you won't see the html tags anymore - you will see your post the way it will probably appear in your template.

Implementation of this editor is not easy. If you have troubles with it PLEASE let us know so that we can improve your experience with your software.

Settings, Settings, & Settings

Plugin Settings:
  • Use TinyMCE (default): Sets the default condition for whether or not to use this plugin, which users can override in their profile. Default value is OFF (unchecked).
  • Directionality support: This allows for better handling of "right to left" languages by providing buttons to switch between LTR and RTL. Default value is OFF (unchecked).
  • Custom TinyMCE init: I have no idea what this one does. All I know is the plugin has a setting for it and you get to type stuff in a box, so here it is in the readme file :) This field defaults to something...
Insert Image Settings:
Settings in blue are plain text only, settings in green allow html inputs
overall html block settings:
  • insert tag: The tag for the overall "inserted image" block. For core it is a simple 'span', for TinyMCE the default is a bit more complicated: table align="center" width="WIDTHONLY"
  • insert class (floats) / (centered): 2 settings, this is the class applied to the tag above. One for floating an image, the other for centering an image. If blank then class is not used. Default is FLOATDIRECTION
  • insert style (floats) / (centered): 2 settings, this is the style applied to the tag above. One for floating an image, the other for centering an image. If blank then style is not used. Default is image_block center
title section settings:
  • title tag: If you are using a title with your image, this is the tag for that section of the inserted code. Default is caption
  • title class: This is the class applied to the title tag. If blank then class is not used. Default is image_title
  • title style: This is the style applied to the title tag. If blank then style is not used. Default is (blank).
  • post-title: If a title section is used, this allows for some html bits after the title section. Core uses it, TinyMCE does not. Default is (blank)
image section settings:
  • pre-image: This allows some html bits before the actual image tag. Default is <tbody><tr><td>
  • image class: This is the class applied to the image tag. Default is center
  • image style: This is the style applied to the image tag. Default is (blank)
  • post-image: This allows some html bits before the actual image tag. Default is (blank)
caption section settings:
  • pre-caption: If a caption is present, this allows some html bits before the caption section. Default is </td></tr><tr>
  • caption tag: The tag for the actual caption section. Default is td
  • caption class: This is the class applied to the caption tag. Default is image_legend
  • caption style: This is the style applied to the caption tag. Default is (blank)
  • post-caption: If a caption is present, this allows some html bits after the caption section. Default is (blank)
  • NO caption: If there is no caption present, this allows some html bits to fill that space sort of. TinyMCE needs it to close a TD. Default is </td>
  • post caption separator: This allows some html bits before closing the entire "insert image" block. Default is </tr></tbody>
User Settings:
  • Use TinyMCE: This allows each user to use (or not use) the TinyMCE plugin. Default value is set by the installation owner on the plugin's settings page.
  • Directionality support: This allows for better handling of "right to left" languages by providing buttons to switch between LTR and RTL. Default value is set by the installation owner on the plugin's settings page.
Blog Settings:
  • This plugin has no blog settings.
Widget Settings:
  • This plugin has no widget settings.

More Info, Credits, & Links

More Info:
  • For all settings: if you enter "FLOATDIRECTION" (no quote marks) it will be replaced with "floatleft" or "floatright" depending on which way you want to float an image. The primary purpose is for a "class" attribute.
  • For all settings: if you enter "STYLEWIDTH" (no quote marks) it will be replaced with "width:XXXpx;", where XXX is the image's width plus 12. The primary purpose is for a "style" attribute.
  • For all settings: if you enter "WIDTHONLY" (no quote marks) it will be replaced with "XXX", where XXX is the image's width plus 12. The primary purpose is for a "width" attribute for a table.
Credits:
  • Thanks to Daniel Hahler (http://daniel.hahler.de/) for initial creation and release of this plugin for the b2evolution (http://b2evolution.net) project.
  • Thanks to Kimberly (http://secretcorners.net/) for hammering on how inserting an image sucks when someone uses TinyMCE, else Quam Plures never would have taken it where we did.
Links:

Release History:

1.0
Uses new hook and settings to allow inserting in tables instead of spans
0.1
initial release