TinyMCE:Compressor/PHP

From Moxiecode Documentation Wiki

Contents 1 TinyMCE Compressor PHP 1.1 About 1.2 Requirements 1.3 Installation 1.4 Example of initialization 1.5 Troubleshooting

TinyMCE Compressor PHP

About

TinyMCE Compressor gzips all javascript files in TinyMCE to a single streamable file. This makes the overall download size 75% smaller and the number of requests will also be reduced. The overall initialization time for TinyMCE will be reduced dramaticly if you use this script.

Requirements

1. The PHP version must be version 4 or above
2. The PHP gzip compressor cannot and will not work if zlib compression is already enabled on the server.

Installation

Here is a step by step list on how to install the GZip compressor.

1. Ensure that your server does not have zlib compression enabled in the file php.ini
2. Copy the tiny_mce_gzip.js and tiny_mce_gzip.php to the tiny_mce directory. The same directory that contains the tiny_mce.js file.
3. Remove the current script tag. <script type="text/javascript" src="tinymce/jscripts/tiny_mce/tiny_mce.js"></script>
4. Add the new new GZip script <script type="text/javascript" src="tinymce/jscripts/tiny_mce/tiny_mce_gzip.js"></script>.
5. Add the new GZip initialization call that will tell the compressor what to include in the output. This should be the sum of all and themes, plugins contained on page.

Example of initialization

The example below will pack both themes and all plugins into one file/steam. Remove the things you don't need or add your custom plugins to the settings below. Remember that the tinyMCE_GZ.init call must be placed in its own script tag.

<script type="text/javascript" src="tinymce/jscripts/tiny_mce/tiny_mce_gzip.js"></script>
<script type="text/javascript">
tinyMCE_GZ.init({
	plugins : 'style,layer,table,save,advhr,advimage,advlink,emotions,iespell,insertdatetime,preview,media,'+ 
        'searchreplace,print,contextmenu,paste,directionality,fullscreen,noneditable,visualchars,nonbreaking,xhtmlxtras',
	themes : 'simple,advanced',
	languages : 'en',
	disk_cache : true,
	debug : false
});
</script>
<!-- Needs to be seperate script tags! -->
<script type="text/javascript">
tinyMCE.init({
	.. your normal init ..
});
</script>

Troubleshooting

• The GZip compressor can fail to load if the server has odd settings or is missing the required support for it to function. To see compilation errors or other problems we suggest that you use HTTP debugging tools like Fiddler or Firebug you can also point you browser directly to the GZip file.
• Consult the changelog of this script and make sure that you use the latest version of TinyMCE. These two parts are pretty much tied together so there is no guarantee that it will work with older versions of TinyMCE.
• Visit the TinyMCE forum for help with the TinyMCE Gzip Compressor.
• To remove a plugin, remember to remove it both from tinyMCE_GZ.init and TinyMCE.init.
• To add a plugin, remember to add it both to the tinyMCE_GZ.init and the tinyMCE.init calls.
• If you are using prototype.js and scriptaculous.js framework include them below/after this two tags:

<script type="text/javascript">tinyMCE_GZ.init({.....});</script>
<script type="text/javascript">tinyMCE.init({.....});</script>