Changeset 3369

Timestamp:

04/03/09 17:28:17 (3 years ago)

Author:

CrawfordCurrie

Message:

Item1383: Optimised the preferences Item8094: fixed the pickaxe

Location:

trunk/TinyMCEPlugin

Files:

• data/System/TinyMCEPlugin.txt (modified) (4 diffs)
• lib/Foswiki/Plugins/TinyMCEPlugin.pm (modified) (4 diffs)
• pub/System/TinyMCEPlugin/foswiki_tiny_src.js (modified) (8 diffs)

trunk/TinyMCEPlugin/data/System/TinyMCEPlugin.txt

@@ -35 +35 @@
    * *Click* on edit of any topic.
 
----++ Settings
-You can override this setting by defining TINYMCEPLUGIN_DEBUG to enable some simple debug features.
-   * Set DEBUG = 0
+---++ Preferences
+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.
 
-This setting contains all the options passed to the TinyMCE editor on startup. 
-For a full explanation of the available options, and guidance on reconfiguring TinyMCE, see the [[http://wiki.moxiecode.com/index.php/TinyMCE:Configuration][Moxicode TinyMCE Wiki]]. Note the inclusion of the Pattern Skin standard CSS files in the =content_css= setting.
-<verbatim>
-   * Set INIT = mode:"textareas",
+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
+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
+=content_css= setting.
+<verbatim>   * Set TINYMCEPLUGIN_INIT = mode:"textareas",
    editor_selector : "foswikiWysiwygEdit",
    save_on_tinymce_forms: true,
@@ -50 +49 @@
    relative_urls : false,
    remove_script_host : false,
+   dialog_type: "modal",
    setupcontent_callback : FoswikiTiny.setUpContent,
    urlconverter_callback : "FoswikiTiny.convertLink",
-   hide_instance_callback : FoswikiTiny.switchToRaw,
-   show_instance_callback : FoswikiTiny.switchToWYSIWYG,
    foswikipuburl_callback : "FoswikiTiny.convertPubURL",
    save_callback : "FoswikiTiny.saveCallback",
@@ -89 +87 @@
    theme_advanced_path: false,
    theme_advanced_statusbar_location : "bottom",
+   keep_styles : false,
+   gecko_spellcheck : true,
    content_css : "%PUBURLPATH%/%SYSTEMWEB%/TinyMCEPlugin/wysiwyg%IF{"$TINYMCEPLUGIN_DEBUG" then="_src"}%.css,%PUBURLPATH%/%SYSTEMWEB%/SkinTemplates/base.css,%FOSWIKI_STYLE_URL%,%FOSWIKI_COLORS_URL%"
 </verbatim>
-   * Additional settings for specific browsers.
-      * Warning: if you enable =paste_auto_cleanup_on_paste then it automatically implies =past_use_dialog= on all non-MSIE browsers.
-      * Set INIT_MSIE = paste_auto_cleanup_on_paste : true
-      * Set INIT_OPERA = 
-      * Set INIT_GECKO = 
-      * Set INIT_SAFARI = 
+You can set additional options for specific browsers. You can define extra options for MSIE, OPERA, GECKO and SAFARI. For example,
+<verbatim>   * Set TINYMCEPLUGIN_INIT_MSIE = paste_auto_cleanup_on_paste : true
+</verbatim>
+   * Warning: if you enable =paste_auto_cleanup_on_paste then it automatically implies =paste_use_dialog= on all non-MSIE browsers.
 
-You can override these settings in the same way as any other [[%SYSTEMWEB%.PreferenceSettings][preference settings]], by setting e.g. =TINYMCEPLUGIN_INIT= in the site, web or topic preferences. You are *not* recommended to edit the setting here.
+You can *disable* the plugin in any web or topic, or for any specific user, by setting =TINYMCEPLUGIN_DISABLE= to 1. e.g.
+<verbatim>   * Set TINYMCEPLUGIN_DISABLE = 1
+</verbatim>
 
-   * You can *disable* the plugin in any web or topic, or for any specific user, by setting the =TINYMCEPLUGIN_DISABLE= preference to 1.
-   * Some browsers don't support !TinyMCE. You can prevent the editor from
-     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|Opera)=.   
+Some browsers don't support Tiny MCE. You can prevent the editor from
+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|Opera)=. For a full list of supported browsers see http://wiki.moxiecode.com/index.php/TinyMCE:Compatibility
 
 %INCLUDE{"%SYSTEMWEB%.WysiwygPluginSettings"}%
+
+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.
+<verbatim>   * Set TINYMCEPLUGIN_DEBUG = 1
+</verbatim>
 
 ---++ Frequently Asked Questions
@@ -116 +119 @@
 |  Author: | [[http://c-dot.co.uk][Crawford Currie]] |
 |  Copyright: | &copy; 2007-2008 Crawford Currie http://c-dot.co.uk |
-|             | This package also includes the complete sources for version 2.1.1.1 of the !TinyMCE editor |
 |  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
+|             | This package also includes the complete sources for version 3.2.2 of the !TinyMCE editor which is covered by [[http://tinymce.moxiecode.com/license.php][its own license]]. |
 |  Plugin Version: | %$VERSION% |
 |  Change History: | <!-- versions below in reverse order -->&nbsp; |
+|  3 Apr 2009 | Foswikitask:Item1383: Optimised the preferences Foswikitask:Item8094: fixed the pickaxe |
 |  15 Mar 2009 | Foswikitask:Item930: Crawford Currie upgraded to Tiny MCE 3.2.2 and recoded all the standard plugins that had to be recoded |
-|  21 Jan 2009 | Foswikitask:Item833: Eugen Mayer added SYSTEMWEB to foswiki_vars, simplifying the activation of the foswikilink dialog of Extensions.TinyMCEUsabilityUpgradePlugin (if installed) |
-|  06 Dec 2008 | Foswikitask:Item5859: Eugen Mayer removed XHR headers that were banjaxing NTLM |
-|  03 Dec 2008 | Re-released for the Foswiki project |
+|  21 Jan 2009 | Foswikitask:Item833: added SYSTEMWEB to foswiki_vars, simplifying the activation of the foswikilink dialog of Extensions.TinyMCEUsabilityUpgradePlugin (if installed) - Eugen Mayer |
+|  06 Dec 2008 | Foswikitask:Item5859: removed XHR headers that were banjaxing NTLM - Eugen Mayer |
+|  03 Dec 2008 | Crawford Currie re-released for the Foswiki project |
 |  03 Aug 2008 | TWiki 4.2.1 release version |
 |  04 May 2008 | TWikibug:Item5547: Change mechanism by which TMCE recognises textareas to camp on. Use class instead of element name. |

trunk/TinyMCEPlugin/lib/Foswiki/Plugins/TinyMCEPlugin.pm

@@ -1 @@
-
 # Plugin for Foswiki - The Free and Open Source Wiki, http://foswiki.org/
 #
@@ -19 +18 @@
 use Assert;
 
-our $VERSION          = '$Rev$';
-our $RELEASE          = '21 Jan 2009';
-our $SHORTDESCRIPTION = 'Integration of TinyMCE with WysiwygPlugin';
+our $VERSION           = '$Rev$';
+our $RELEASE           = '21 Jan 2009';
+our $SHORTDESCRIPTION  = 'Integration of the !TinyMCE WYSIWYG Editor';
+our $NO_PREFS_IN_TOPIC = 1;
+
+# Defaults for TINYMCEPLUGIN_INIT and INIT_browser. Defined as our vars to
+# allow other extensions to override them.
+# PLEASE ENSURE THE PLUGIN TOPIC EXAMPLES ARE KEPT IN SYNCH!
+our $defaultINIT       = <<'HERE';
+mode:"textareas",
+editor_selector : "foswikiWysiwygEdit",
+save_on_tinymce_forms: true,
+cleanup : true,
+theme : "advanced",
+convert_urls : true,
+relative_urls : false,
+remove_script_host : false,
+dialog_type: "modal",
+setupcontent_callback : FoswikiTiny.setUpContent,
+urlconverter_callback : "FoswikiTiny.convertLink",
+foswikipuburl_callback : "FoswikiTiny.convertPubURL",
+save_callback : "FoswikiTiny.saveCallback",
+%IF{"$TINYMCEPLUGIN_DEBUG" then="debug:true,"}%
+plugins : "table,searchreplace,autosave,paste,foswikibuttons,foswikiimage%IF{ "context TinyMCEUsabilityUpgradePluginEnabled" then=",foswikilink" else=""}%",
+foswiki_secret_id : "%WYSIWYG_SECRET_ID%",
+foswiki_vars : { PUBURLPATH : "%PUBURLPATH%", PUBURL : "%PUBURL%", WEB : "%WEB%", TOPIC : "%TOPIC%", ATTACHURL : "%ATTACHURL%", ATTACHURLPATH : "%ATTACHURLPATH%", VIEWSCRIPTURL : "%SCRIPTURL{view}%", SCRIPTSUFFIX: "%SCRIPTSUFFIX%", SCRIPTURL : "%SCRIPTURL%", SYSTEMWEB: "%SYSTEMWEB%" },
+theme_advanced_toolbar_align : "left",
+foswikibuttons_formats : [
+{ name: "Normal", el: "", style: null },
+{ name: "Heading 1", el: "h1", style: false },
+{ name: "Heading 2", el: "h2", style: false },
+{ name: "Heading 3", el: "h3", style: false },
+{ name: "Heading 4", el: "h4", style: false },
+{ name: "Heading 5", el: "h5", style: false },
+{ name: "Heading 6", el: "h6", style: false },
+{ name: "VERBATIM", el: "pre", style: "TMLverbatim" },
+{ name: "LITERAL", el: "span", style: "WYSIWYG_LITERAL" },
+{ name: "Protect on save", el: null, style: "WYSIWYG_PROTECTED" },
+{ name: "Protect forever", el: null, style: "WYSIWYG_STICKY" }
+],
+paste_create_paragraphs : true,
+paste_create_linebreaks : false,
+paste_convert_middot_lists : true,
+paste_convert_headers_to_strong : false,
+paste_remove_spans: true,
+paste_remove_styles: true,
+paste_strip_class_attributes: "all",
+theme_advanced_buttons1 : "foswikiformat,separator,bold,italic,tt,colour,removeformat,separator,bullist,numlist,outdent,indent,separator,link,unlink,anchor,separator,attach,image,charmap,hr,separator,undo,redo,separator,search,replace",
+theme_advanced_buttons2: "tablecontrols,separator,code,hide",
+theme_advanced_buttons3: "",
+theme_advanced_toolbar_location: "top",
+theme_advanced_resize_horizontal : false,
+theme_advanced_resizing : true,
+theme_advanced_path: false,
+theme_advanced_statusbar_location : "bottom",
+keep_styles : false,
+gecko_spellcheck : true,
+content_css : "%PUBURLPATH%/%SYSTEMWEB%/TinyMCEPlugin/wysiwyg%IF{"$TINYMCEPLUGIN_DEBUG" then="_src"}%.css,%PUBURLPATH%/%SYSTEMWEB%/SkinTemplates/base.css,%FOSWIKI_STYLE_URL%,%FOSWIKI_COLORS_URL%"
+HERE
+our %defaultINIT_BROWSER     = (
+    MSIE => 'paste_auto_cleanup_on_paste : true',
+    OPERA => '',
+    GECKO => '',
+    SAFARI => '',
+   );
 
 use Foswiki::Func;
@@ -102 +163 @@
 
     my $init = Foswiki::Func::getPreferencesValue('TINYMCEPLUGIN_INIT')
-      || <<'HERE';
-'
-HERE
+      || $defaultINIT;
     my $extras = '';
 
@@ -122 +181 @@
     }
     if ($extras) {
-        $extras =
-          Foswiki::Func::getPreferencesValue( 'TINYMCEPLUGIN_INIT_' . $extras );
+        $extras = Foswiki::Func::getPreferencesValue(
+            'TINYMCEPLUGIN_INIT_' . $extras ) || $defaultINIT_BROWSER{$extras};
         if ( defined $extras ) {
             $init = join( ',', ( split( ',', $init ), split( ',', $extras ) ) );

trunk/TinyMCEPlugin/pub/System/TinyMCEPlugin/foswiki_tiny_src.js

@@ -41 +41 @@
     },
 
-    enableSave: function(enabled) {
+    enableSaveButton: function(enabled) {
         var status = enabled ? null : "disabled";
         var elm = document.getElementById("save");
@@ -91 +91 @@
     },
 
+    onSubmitHandler : false,
+
     // Convert HTML content to textarea. Called from the WYSIWYG->raw switch
     switchToRaw : function (editor) {
-        // As shown by OliverKrueger in Item5138, trivial text may include
-        // UTF-8 chars. These need to be encoded to entities before we can
-        // pass the string back to the server. This is done in triggerSave,
-        // but note that it requires cleanup:true to work.
-        //SMELL: how? editor.triggerSave(false, true);
         var text = editor.getContent();
 
-        // Evaluate post-processors
+        // Evaluate post-processors attached from plugins
         for (var i = 0; i < FoswikiTiny.html2tml.length; i++) {
             var cb = FoswikiTiny.html2tml[i];
             text = cb.apply(editor, [ editor, text ]);
         }
-        FoswikiTiny.enableSave(false);
+        FoswikiTiny.enableSaveButton(false);
         editor.getElement().value =
             "Please wait... retrieving page from server.";
@@ -112 +109 @@
             function (text, req, o) {
                 this.getElement().value = text;
-                FoswikiTiny.enableSave(true);
+                FoswikiTiny.enableSaveButton(true);
             },
             function (type, req, o) {
@@ -119 +116 @@
                                 + o.url + ": "
                                 + type + " " + req.status + "</div>");
+                //FoswikiTiny.enableSaveButton(true); leave save disabled
             });
         // Add the button for the switch back to WYSIWYG mode
@@ -148 +146 @@
             editor.isNotDirty = false;
             return true;
-        }
+        },
+        // Ooo-err. Stomp on the default submit handler and
+        // forcibly disable the editor to prevent a call to
+        // the TMCE save. This in turn blocks the getContent
+        // that would otherwise wipe out the content of the
+        // textarea with the DOM. We'd better make damn sure we
+        // remove this handler when we switch back!
+        this.onSubmitHandler = function(ed, e) {
+            // SMELL: Editor.initialized is undocumented and liable
+            // to break when we upgrade TMCE
+            editor.initialized = false;
+        };
+        // SMELL: Event.addToTop() is undocumented and liable
+        // to break when we upgrade TMCE
+        editor.onSubmit.addToTop(this.onSubmitHandler);
     },
 
@@ -160 +172 @@
         var text = editor.getElement().value;
 
-        FoswikiTiny.enableSave(false);
+        if (this.onSubmitHandler) {
+            editor.onSubmit.remove(this.onSubmitHandler);
+            this.onSubmitHandler = null;
+        }
+        FoswikiTiny.enableSaveButton(false);
         editor.setContent("<span class='foswikiAlert'>"
                           + "Please wait... retrieving page from server."
@@ -174 +190 @@
                 this.setContent(text);
                 this.isNotDirty = true;
-                FoswikiTiny.enableSave(true);
+                FoswikiTiny.enableSaveButton(true);
             },
             function (type, req, o) {
@@ -182 +198 @@
                                 + o.url + ": "
                                 + type + " " + req.status + "</div>");
-                //FoswikiTiny.enableSave(true); leave save disabled
+                //FoswikiTiny.enableSaveButton(true); leave save disabled
             });