Ignore:
Timestamp:
10/29/09 03:25:56 (3 years ago)
Author:
PaulHarvey
Message:

Item2245: Updated documentation, removed redundant setting: paste_auto_cleanup_on_paste : true for MSIE browsers (TinyMCE now defaults to true for all browsers), corrected (?) $VERSION string in TinyMCEPlugin.pm

File:
1 edited

Legend:

Unmodified
Added
Removed

  • branches/Release01x00/TinyMCEPlugin/data/System/TinyMCEPlugin.txt

    r5351 r5385  
    77%SHORTDESCRIPTION% 
    88 
    9 <img src="%ATTACHURL%/screenshot.gif"/> 
     9<img src="%ATTACHURLPATH%/screenshot.png"/> 
    1010 
    1111%TOC% 
    12 This is an integration of the <a href="http://tinymce.moxiecode.com?id=powered_by_tinymce_mini"><img src="http://tinymce.sourceforge.net/buttons/tinymce_button.png" border="0" width="80" height="15" alt="TinyMCE" /></a> WYSIWYG editor. This is great little editor, fast and highly functional, and supporting a wide range of browsers, including Firefox, IE and Safari. At the time of writing it doesn't work with Konqueror. 
     12This is an integration of the fast and highly functional <a href="http://tinymce.moxiecode.com?id=powered_by_tinymce_mini"><img src="http://tinymce.sourceforge.net/buttons/tinymce_button.png" border="0" width="80" height="15" alt="TinyMCE" /></a> WYSIWYG editor. It supports a wide range of browsers, including Firefox, IE, Safari, Opera and Google Chrome (see [[http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility][compatibility chart]]). At the time of writing it doesn't work with Konqueror. 
    1313 
    1414The integration uses the Foswiki:Extensions.WysiwygPlugin to translate text to and from a format that !TinyMCE can edit. 
    1515 
    16 Unlike the other editor integrations in Foswiki, which install "Word in a Browser" style editors, this plugin is able to swap out the _standard_ text areas in an edit and replace them with WYSIWYG editors. This means you get WYSIWYG editors for textareas in forms, as well as for the main text of the topic. It can also co-exist alongside other WYSIWYG editors, such as Kupu. 
     16This plugin is able to swap out _standard_ text areas and replace them with WYSIWYG editors. This means you get WYSIWYG editors for textareas in forms, as well as for the main text of the topic. It can also co-exist alongside other WYSIWYG editors, such as Kupu. 
    1717 
    1818The editor automatically "switches itself off" (i.e. reverts to the old text-only window) when editing topics that contain Foswiki content it can't handle, such as complex macros. 
    1919 
    2020---++ Editor Notes 
    21 The editor uses a translator module to convert from Foswiki Topic Markup Language (TML) to HTML and back. The translator converts special macros - such as %<nop>MACROS% - to plain text, and encloses them within HTML spans using a special style called =WYSIWYG_PROTECTED=. In this way the editor can detect text that is not meant to be HTML formatted. This style is _also_ used to protect special text you enter into the editor from being interpreted when the topic is translated back into TML. If you want to add any special features that are sensitive to formatting, such as =Set= statements, then you have to format those regions using 'Protect on save' or 'Protect forever'. 
     21The editor uses a translator module to convert from Foswiki Topic Markup Language (TML) to HTML and back. The translator converts special macros - such as %<nop>MACROS% - to plain text, and encloses them within HTML spans using a special style called =WYSIWYG_PROTECTED=. In this way the editor can detect text that is not meant to be HTML formatted. This style is _also_ used to protect special text you enter into the editor from being interpreted when the topic is translated back into TML. If you want to add any special features that are sensitive to formatting, such as =Set= statements, then you should format those regions using 'Protect on save' or 'Protect forever'. 
    2222 
    2323---++ Installation Instructions 
    … …  
    2626   * This plugin comes pre-installed on Foswiki. You should only need to re-install if there is an upgrade to the plugin. 
    2727   * It requires the very latest revision of WysiwygPlugin. 
    28    * When installed, it *replaces* the old "textarea" editor. The default Foswiki skin provides access to the plain text editor by adding a Raw Edit link at the bottom of the page. 
     28   * When installed, it *replaces* the old "textarea" editor. You may still access the plaintext editor with the "Wiki Text" button provided in the toolbar, however this does not necessarily give you the original raw topic content. To bypass the TML to HTML conversion process entirely, use the Raw Edit link provided by the default Foswiki skin at the bottom of the page. 
    2929 
    3030First follow the installation instructions to install the Plugin: 
    … …  
    3737 
    3838---++ Preferences 
    39 If you want to change any of the preferences you are recommended to copy the examples below and paste them into your own [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. The settings in this topic are just examples and have no effect. 
    40  
    41 The [[%SYSTEMWEB%.PreferenceSettings][preference setting]] =TINYMCEPLUGIN_INIT= lets you redefine all the options passed to the Tiny MCE editor on startup. For a full explanation of the available options, and 
    42 guidance on reconfiguring Tiny MCE, see the [[http://wiki.moxiecode.com/index.php/TinyMCE:Configuration][Moxicode TinyMCE Wiki]]. The default options are as follows. Note the inclusion of the Pattern Skin standard CSS files in the 
    43 =content_css= setting. 
     39If you want to change any of the preferences it is recommended that you copy the examples below and paste them into your own [[%SYSTEMWEB%.PreferenceSettings][preference settings]]. The settings in this topic are just examples and have no effect. 
     40 
     41---+++ =TINYMCEPLUGIN_INIT= 
     42This variable lets you redefine all the options passed to the !TinyMCE editor on startup. For a full explanation of the available options, and 
     43guidance on reconfiguring !TinyMCE, see the [[http://wiki.moxiecode.com/index.php/TinyMCE:Configuration][Moxicode TinyMCE Wiki]].  
     44 
     45The default options are as follows (you will need to remove the newlines for your own =TINYMCEPLUGIN_INIT= string). Note the inclusion of the Pattern Skin standard CSS files in the =content_css= setting. 
     46 
    4447<verbatim> 
    4548mode:"textareas", 
    … …  
    9497content_css : "%PUBURLPATH%/%SYSTEMWEB%/TinyMCEPlugin/wysiwyg%IF{"$TINYMCEPLUGIN_DEBUG" then="_src"}%.css,%PUBURLPATH%/%SYSTEMWEB%/SkinTemplates/base.css,%FOSWIKI_STYLE_URL%,%FOSWIKI_COLORS_URL%" 
    9598</verbatim> 
    96 You can set additional options for specific browsers. You can define extra options for MSIE, OPERA, GECKO and SAFARI. For example, 
    97 <verbatim>   * Set TINYMCEPLUGIN_INIT_MSIE = paste_auto_cleanup_on_paste : true 
     99 
     100---+++ Table of available preferences 
     101| *Variable* | *Default* | *Description* | 
     102| =TINYMCEPLUGIN_INIT= | As [[%TOPIC%#Preferences][above]] | This variable holds the initialization parameters used to start !TinyMCE | 
     103| =TINYMCEPLUGIN_INIT_browser= | See [[%TOPIC%#Browser_Specific_Settings][Browser Specific Settings]] below | Add extra parameters to =TINYMCEPLUGIN_INIT= string for specific browsers | 
     104| =TINYMCEPLUGIN_DISABLE= | 0 | If set to 1, disables TinyMCEPlugin | 
     105| =NOWYSIWYG= | 0 | If this global setting is set to 1, TinyMCEPlugin (and all other WYSIWYG editors) will be disabled. | 
     106| =TINYMCEPLUGIN_BAD_BROWSERS= | =(?i-xsm:Konqueror)= | A regular expression that matches the user-agent string of any browser for which !TinyMCE should not be loaded. | 
     107| =TINYMCEPLUGIN_DEBUG= | 0 | If set to 1, the uncompressed version of !TinyMCE Javascript and CSS sources will be loaded by the browser. This is very helpful when debugging. | 
     108 
     109---+++ Browser Specific Settings 
     110Additional options may be set for specific browsers. You can define extra options for MSIE, OPERA, GECKO and SAFARI. For example, 
     111<verbatim>   * Set TINYMCEPLUGIN_INIT_MSIE = paste_auto_cleanup_on_paste : false 
    98112</verbatim> 
    99113The defaults are: 
    100114<verbatim> 
    101     MSIE => 'paste_auto_cleanup_on_paste : true', 
     115    MSIE => '', 
    102116    OPERA => '', 
    103117    GECKO => 'gecko_spellcheck : true', 
    104118    SAFARI => '', 
    105119</verbatim> 
    106    * Warning: if you enable =paste_auto_cleanup_on_paste= then it automatically implies =paste_use_dialog= on all non-MSIE browsers. 
    107  
    108 You can *disable* the plugin in any web or topic, or for any specific user, by setting =TINYMCEPLUGIN_DISABLE= to 1. e.g. 
    109 <verbatim>   * Set TINYMCEPLUGIN_DISABLE = 1 
    110 </verbatim> 
    111 The plugin also respects the global =NOWYSIWYG= setting, which affects all 
    112 WYSIWYG editors. 
    113  
    114 Some browsers don't support Tiny MCE. You can prevent the editor from 
    115 being invoked on these browsers by setting =TINYMCEPLUGIN_BAD_BROWSERS= to a regular expression that matches the user-agent string for any broken browsers. The default is =(?i-xsm:Konqueror)=. For a full list of supported browsers see http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility 
    116  
     120 
     121---+++ Additional !TinyMCE plugins  
     122Documentation for standard plugins shipped with !TinyMCE can be found at [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins]]. 
     123 
     124Some notable plugins: 
     125| *Plugin Name* | *Toolbar buttons* | *Description* | *Notes* | 
     126| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/autoresize][autoresize]] | - | Automatically resizes the editor to the content inside it | | 
     127| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/emotions][emotions]] | emotions | Insert smiley images into the !TinyMCE editable area | | 
     128| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/iespell][iespell]] | iespell | Provides spell check for Internet Explorers | | 
     129| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/insertdatetime][insertdatetime]] | insertdate, inserttime | Provides buttons to insert customised date and time strings | | 
     130| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/media][media]] | media | Handles embedded media such as !QuickTime, !Flash, !ShockWave, !RealPlayer and Windows Media Player | Requires customisation of your edit templates | 
     131| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/paste][paste]] | pastetext, pasteword, selectall | *Enabled by default in Foswiki* | Added here to show extra toolbar buttons that are available | 
     132| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/spellchecker][spellchecker]] | spellchecker | Adds spellchecker functionality to !TinyMCE by providing a new button that performs a AJAX call to a backend PHP page that uses PSpell/ASpell or Google spellchecker | | 
     133| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/style][style]] | styleprops | Adds CSS style editing support to !TinyMCE, this will enable you to edit almost any CSS style property in a visual way. | Generally it's desirable to keep wiki topics free of HTML/CSS | 
     134| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/visualchars][visualchars]] | visualchars | Adds the possibility to see invisible characters like &nbsp; | | 
     135| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/wordcount][wordcount]] | - | Display the number of words down in the right corner of the editor. | | 
     136| [[http://wiki.moxiecode.com/index.php/TinyMCE:Plugins/xhtmlxtras][xhtmlxtras]] | cite, ins, del, abbr, acronym | Adds support for some XHTML elements, including cite, ins, del, abbr, and acronym. | Generally XHTML in topics is not desirable. Foswiki plugins exist to provide more friendly TML markup | 
     137 
     138 
     139---++ Frequently Asked Questions 
     140 
     141The topic [[TinyMCEFrequentlyAskedQuestions]] contains more help with things like: "How do I configure the buttons in my skin?", "How do I disable the WYSIWYG?" etc. 
     142 
     143---- 
    117144%INCLUDE{"%SYSTEMWEB%.WysiwygPluginSettings"}% 
    118  
    119 You can use the [[%SYSTEMWEB%.PreferenceSettings][preference setting]] =TINYMCEPLUGIN_DEBUG= to make the editor load uncompressed Javascript and CSS. This is very helpful when debugging. e.g. 
    120 <verbatim>   * Set TINYMCEPLUGIN_DEBUG = 1 
    121 </verbatim> 
    122  
    123 ---++ Frequently Asked Questions 
    124  
    125 The topic TinyMCEFrequentlyAskedQuestions contains more help with things like: "How do I configure the buttons in my skin?", "How do I disable the WYSIWYG?" etc. 
     145---- 
    126146 
    127147---++ Plugin Info 
    … …  
    136156|  Release: | %$RELEASE% | 
    137157|  Change History: | <!-- versions below in reverse order -->&nbsp; | 
    138 |  21 Oct 2009 | Foswikitask:Item1558: Tiny MCE project now supports Opera, so remove it from _BAD_BROWSERS | 
     158|  29 Oct 2009 | Foswikitask:Item2245: Updated documentation, removed redundant setting: =paste_auto_cleanup_on_paste : true= for MSIE browsers (!TinyMCE now defaults to =true= for all browsers) | 
     159|  21 Oct 2009 | Foswikitask:Item1558: !TinyMCE project now supports Opera, so remove it from _BAD_BROWSERS | 
    139160|  18 Oct 2009 | Foswikitask:Item2270: Fix wordcount plugin to show correct count when user first enters edit mode | 
    140 |  17 Oct 2009 | Foswikitask:Item2245: Upgrade to Tiny MCE 3.2.7 | 
     161|  17 Oct 2009 | Foswikitask:Item2245: Upgrade to !TinyMCE 3.2.7, updated documentation, removed redundant setting: =paste_auto_cleanup_on_paste : true= for MSIE browsers (!TinyMCE now defaults to =true= for all browsers) | 
    141162|  20 Sep 2009 | Foswikitask:Item2121: Remove 2 MB of developer files that are not used | 
    142163|  19 Sep 2009 | Foswikitask:Item2037: Fix fullscreen-to-WikiText transition | 
Note: See TracChangeset for help on using the changeset viewer.