Installation

Last modified: June 20, 2009 - 23:50

Before reading on, you should ensure you have downloaded the proper versions of modules.

Installing Wysiwyg module

  • Download, extract, and place Wysiwyg module in the modules folder like any other Drupal module.

Installing client-side editors

Wysiwyg module does not do anything useful until there is at least one editor library, such as TinyMCE, FCKeditor, or NicEdit. These need to be downloaded from third-party web sites and put into the Wysiwyg module folder. admin/settings/wysiwyg/profile provides a list of compatible third-party editor libraries along with links to their respective websites and download pages, as well as detailed on-screen installation instructions.

  1. Follow the download link for an editor.
  2. Extract the package.
  3. The settings page tells you where to place the extracted files. Some editors come wrapped in an additional folder, some others do not.

    In general, editor library folders are all lowercase, and use the editor's short-name without any version number or additions.

    • If the editor comes in a wrapper folder that equals its short-name, then you can put the entire wrapper folder straight into Wysiwyg's folder:

      /sites/all/libraries/[editorname]

      Make sure that the resulting structure is NOT like /sites/all/libraries/[editorname]/[editorname].

    • If the editor comes in a wrapper folder with additional characters (e.g. version number), then you can put the entire wrapper folder into the sites/all/libraries folder, but need to rename it to its short-name:

      /sites/all/libraries/[editorname]

      Make sure that the resulting structure is NOT like /sites/all/libraries/[editorname]/[editorname-version].

    • If the editor comes without a wrapper folder, then you need to create the editor's short-name folder yourself and copy the editor library files into that folder:

      /sites/all/libraries/[editorname]

  4. Go to admin/settings/wysiwyg/profile and reload the page. The newly installed editor should be marked as "installed" in the installation instructions now.
  5. As a starting point and preliminary test whether the editor itself works, you can now associate the installed editor with an input format. Go to admin/settings/filters and determine your default input format. Then go back to admin/settings/wysiwyg/profile and associate the editor with that format. Then go to node/add/page, where the editor should appear. If it doesn't check under the body text area to see if you have a different input format selected.
  6. If you prefer, you can now create a new input format and associate the editor with that or just leave it using the default.
  7. Now head back to admin/settings/wysiwyg/profile one more time and click on the edit link beside your format/editor combination and fine tune the editor.

Sometime path is not totaly obvious

philippejadin - April 1, 2009 - 11:31

Sometime it's not totally clear where to put the editor. For example tinymce, should I unpack the content of jscript/tiny_mce inside /sites/all/modules/wysiwyg/tinymce or yould I unpack the archive root in this folder, or something in between?

Maybe the easiest way would be to provide in the module at least one path that must exist, like for example :

"The module will check if /sites/all/modules/wysiwyg/tinymce/jscripts/tiny_mce/tiny_mce.js is present"

To answer myself, for tinymce, you have to unpack the archive directly inside a tinymce folder you create in /sites/all/modules/wysiwyg, so you have this structure : /sites/all/modules/wysiwyg/tinymce/jscripts/tiny_mce/tiny_mce.js

I totally agree with

entragian - April 20, 2009 - 10:45

I totally agree with philippejadin, I took me about half an hour to find this out...

I agree with your observation

cbroberts26 - April 22, 2009 - 19:39

And thanks for posting the solution to the tinymce puzzle. I was about to pull my hair out too.

looks like this has been added

cabeasley - June 10, 2009 - 13:14

I just installed WYSIWYG and found the following in my Admin->Site Config->WYSIWYG

Extract the archive and copy its contents into a new folder in the following location:
sites/all/libraries/tinymce

So the actual library can be found at:
sites/all/libraries/tinymce/jscripts/tiny_mce/tiny_mce.js

doesn't work for me

Heleen - June 20, 2009 - 17:54

I've just tried to install Tiny MCE and couldn't get it to work. I've installed it in sites/all/libraries/(tinymce/jscripts/tiny_mce/tiny_mce.js) and tried various other places as well, but it just won't work. I've installed the jQuery module and the others that are listed to be necessary for the WYSIWYG module, but that didn't help. I've installed the wysiwyg module in sites/default/modules (and the module itself works) and Tiny MCE to sites/all/libraries/tinymce ... (although the libraries folder didn't exist. But the Libraries API should be installed by default I think, because you can't download it from its page).
I've also tried to install YUI and that worked fine. But I really don't like that editor and prefer Tiny MCE. Does anyone know why it doesn't work?
@cabeasley: did you get it to work?
I really hope someone can help me.

Edit (20-jun-2009 18:53GMT+1): I figured out what was wrong. After setting the permissions to the Tiny MCE folder to chmod 777 it worked. It is now properly installed and working! (so it really should go in sites/all/libraries after all).

Would you mind to add this

sun - August 6, 2009 - 02:19

Would you mind to add this bit to the FAQ?

Daniel F. Kudwien
unleashed mind

sites directory under the root

cbearhoney - June 25, 2009 - 06:24

Because repetition is the mother of retention...extract tinymce files to directory

{drupal_root}/sites/all/libraries/tinymce

not in the modules directory!

www.arvoreblue.com
Clean Design. Smart Development.

jQuery update?

brad bulger - April 22, 2009 - 23:06

since it seems the module requires jQuery Update 2.x (at least, the 5.x-1.1 version does), shouldn't that be mentioned somewhere on the project page and, particularly, on a page about how to install it?

YUI Editor

AndrejT - May 16, 2009 - 18:11

And how to install YUI Editor?

exactly what I did

lucytosh - May 25, 2009 - 12:46

took me hours (wasted) to find a solution for tinyMCE+WYSIWYG, then I quit it and went with YUI... better, easier, faster, much more formatting options... I'm a total newbie, so maybe if you're expert go on with that.. but for drupal new users I suggest switch to YUI, and save energy and nerves!!!!!!!!

Problem with Yahoo is the image stuff doesn't work.

rmiddle - June 9, 2009 - 00:26

I have tried several ways it just doesn't work.

Cant get YUIeditor to work

chalu - September 23, 2009 - 22:08

I downloaded the yui_2.8.0r4.zip straight from the link provided withing the wysiwyg configuration page, extracted it into sites/all/libraries/yui as directed and thus I have sites/all/libraries/yui/build/yahoo-dom-event/yahoo-dom-event.js intact but refreshing the configuration page I get this error message : The version of YUI editor could not be detected.

How do I fix this please.

Kind Regards
Odili Charles Opute (http://ajaxpoet.wordpress.com/)
Proudly Nigerian

Check you have the closure tag in your theme

johnmcgeechan - June 23, 2009 - 11:38

I have spent nearly a day on this (grrr....). I really want to blame somebody, but not sure who. The wisywig module could do worse than to mention that if you don't have the closure tag in your theme, then the editors like tinymce simply won't load. It's probably the reason why some of the problems above have occured.

In a nutshell, the wisywig module assumes that your theme uses the closure variable, if you don't then wysiwyg.js won't load , so you are simply stuffed !

To make it work, insert the following in your theme's page.tpl.php, just before the closing body tag......

<?php
print $closure
?>

This will result in a script tag added to the bottom of your page that refers to the wisywig source in my case it was "/xxx/sites/all/modules/downloaded/wysiwyg/wysiwyg.js?q"

Hope this helps.

On a strictly personal note, I seem to come across too many of these gotcha's with Drupal. The TinyMCE used to work fine, they now tell you to use the wysiwyg module instead. All well and good, no doubt this level of generic logic for multiple editor's is fine. However, nobody seems to do enough spade work to work out whether this new "solution" raises more issues than it solves.

I am willing to admit that it is probably me, that I should have spotted this some time ago, problem is there seen to be a lot of these issues I find with Drupal and just recently have started to eye up Joomla (which I used to use) and see if it is time to go back..(whinge over)

thank you

rayvaughn - July 4, 2009 - 11:33

for providing this gem of a comment without which I definitely would have spent a day growling at the wysiwyg module code.

Wysiwyg needs $closure in the theme or it will not appear!

Marcus Clements
www.brightonart.org

It's the very first entry in

sun - August 6, 2009 - 02:21

It's the very first entry in the FAQ, which is also linked from the project page. Of course, the documentation still needs a fair amount of love, but sometimes, it doesn't hurt to read what's there. We've tried to keep it as small and concise as possible.

Daniel F. Kudwien
unleashed mind

I wish this information had

Divisive Cottonwood - August 6, 2009 - 15:23

I wish this information had been in the readme file

i completely agree with

tsfftf - August 30, 2009 - 12:26

i completely agree with johnmcgeechan, this is a poor replacement for the TinyMCE if you have to start fannying around with the files. Either loose the module or sort it out. I'm sure you will appreciate this negative feedback in a constructive way, but if the problems aren't ironed out then this is more of a headache than using the old TinyMCE module.

I personally saw the red text on the module page and my immeadiate thoughts were 'great, the TinyMCE module with g2image was annoying enough to have to setup, now its changed'. but i went ahead with it nonetheless to try it out. i've since removed it and put tinymce back on.

Thanks for sharing..solved my

DrupalNovice - October 6, 2009 - 21:38

Thanks for sharing..solved my Wysiwyg/TinyMCE issue.

Thank you

blago - November 10, 2009 - 18:04

@johnmcgeechan You saved me hours of frustration
@sun An essential requirement does NOT belong to the FAQ. It needs to be in the page that claims to provide installation instructions.

Simpler

groberts100 - July 8, 2009 - 17:13

I have just come to get a new version of TinyMCE and I find all this.

Its not simpler. Its more complicated.

Sigh.

Uploading Images with TinyMCE

fang27 - July 23, 2009 - 22:11

How / Where do I enable the option to upload images using TinyMCE and this module.....I certainly have it configured for the site in general, but can't find an option or button for TinyMCE to be able to do it through this module....

Also, the tag for the textarea is coming up as "Body" (under name="body" in the code) I don't know if this is a module issue or a TinyMCE issue, but it makes it pretty annoying if I have special attributes to the HTML body tag in CSS (such as a background color) - because then the BG color comes up in the textarea as the color for the textarea! :p

Try integrating IMCE

basanta86 - August 25, 2009 - 17:04

Try integrating IMCE

Good instructions - FCKeditor success

ShannonK - July 27, 2009 - 01:43

Kudos to who wrote the installation instructions. I was able to install and integrate FCKeditor without a problem. For others using FCKeditor, just remember the instructions say not to install it in fckeditor/fckeditor (it will want to do this). The correct path should be:
/sites/all/libraries/fckeditor.

Extremely annoying problem, 2+ days lost and no WYSIWYG editor

jeliasen - September 2, 2009 - 13:17

I am struggling with installing ANY editor. I've tried FCKEditor the old-fashioned way. I've tried TinyMCE. I've tried WYSIWYG+FCKEditor and +YUI and +TinyMCE, all with no luck. PLEASE help if you can. In a nutshell, no WYSIWYG editor ever appears in the create X or edit X pages, for any content type.

At this point I think what I want is WYSIWYG+FCKEditor... but, really, any working WYSIWYG solution would be acceptible.

Notes about my attempts:

First, don't waste time asking any question that is already covered in the steps of this tutorial or the questions following it. Yes, I've tried Garland with no modules enabled outside of core. Yes, I've ensured the paths are correct, Yes, WYSIWYG shows as correctly installed under the "Installation Instructions" tab of admin/settings/wysiwyg. Yes, I've set up filters, assigned users to roles and roles to filters. Yes, I've tried with the non-superuser. Yes, I've performed each of these items in order, carefully following and then verifying each step, each time, to specifically see whether I was missing something in the minutiae... I'm not. If it's discussed on this page, I've tried it already with no luck. Yes, I've tried on multiple OS and browser configurations (mostly Windows+IE8 and Linux+Firefox 3.0.13).

My site is set up as a Drupal multisite installation, using Drupal 6.13, Wysiwyg 6.x-2.0, and FCKEditor 2.6.4.1. I've tried it both on a site that's been around a while (including upgrades from previous versions of Drupal) and, when that didn't work, on a brand-new site that has never been through an upgrade. Yes, ALL the steps above have been tried in both cases.

I've looked at the resultant HTML from loading an add-content page and see references to wysiwyg- everywhere, but I don't know what I'm looking for with this module. In the FCKEditor troubleshooting page (which also didn't help in my case when I was trying to install FCKEditor the old way) there were things to look for in the HTML output and I was able to verify these items were present, but the editor never showed up on my computers.

This has now cost me over 10 hours of work and I am still hand-coding HTML on a new site I'm trying to implement for a client. I need a WYSIWYG editor, any one is fine. If you can offer advice, help, a link to a tutorial, or anything else, please step forward.

Maybe...

jide - September 2, 2009 - 14:09

Obviously, if you have done everything fine, it should work... So either there is something wrong with the installation process, or the only other thing I can think of is maybe you use Firefox with a problematic plugin. In this case, try with a different browser. Otherwise, you may use Firebug plugin for Firefox to investigate and see if there is a javascript error. Emptying cache could also help (it does not hurst anyway).

Unfortunately...

jeliasen - September 2, 2009 - 14:24

I've tried all those things, as well. Using IE8 with no plugins/extensions didn't fix it.

Thanks for the quick reply, by the way.

The installation process I used was to simply unpack and move the Drupal directory... I haven't altered any files manually, all modifications have been done by the install and upgrade processes. I've added modues and themes but not tweaked any.

I had TinyMCE (standalone) working at one point, but removed it (I didn't like how tiny the text was at the time)... since then, no joy.

FWIW, I am also seeing a very different, but possibly related problem: I can't display any images hosted in my site, only images from other domains. Even my site logo won't display (the default will, but not my custom logo). I get alt text instead. What I'm thinking is something is messed up in a path somewhere, and when pages are being rendered certain data just never makes it though. It is possible these problems all occurred around the time I upgraded to 6.13, but I wasn't actively doing anything with any of my Drupal sites at the time and don't know if the breaks were simultaneous with the upgrade.

Any other thoughts? Any experienced dev want to take a look under the hood?

Other thoughts

jide - September 2, 2009 - 14:45

If images do not work, it is a sign something else is going wrong. Do clean urls work ? Are you sure .htaccess is present in the root directory ? In this case, try adding the base directory to .htaccess. Is the image path correct ? You may try help forums for this since this seems unrelated to Wysiwyg and may be a deeper problem.

...

jeliasen - September 3, 2009 - 06:03

Clean URLs do work, as does the Path module and Pathauto. One problem I'm dealing with is never having a site of any significance up using Drupal and therefore not really knowing how to tell what's not working right. That, combined with a lack of a good, single starting point for troubleshooting is making this an enormous headache for me.

If you are after a simple

joecanti - September 5, 2009 - 20:12

If you are after a simple solution try searching for the drupal module openWYSIWYG - it needs no external editors installing and is fairly comprehensive and above all i have found it easy to install - no messing round with code. Im going for tinyMCE because i need some extra options.good luck and have a nice day

multisite wysiwyg wnod

whatdoesitwant - September 16, 2009 - 20:19

You mention that you are running in a multisite environment.
I've set up a multisite environment as well. I know that it should not make a difference but can it be that the wysiwyg module & libraries should be put in the modules and libraries directories of each individual site instead of being shared in all/modules & all/libraries?

Have you tried a single installation? I don't want to but will if you haven't.

I've had limited success with implementing wysiwyg, with some successes (on second load) in firefox but WNOD (white node of death) in most other browsers, especially when implementing on a translated platform.

I think the theory of wysiwyg api is ingenious but the current implementation is lacking. I especially hate the white node of death that keeps happening when anything breaks within, because it doesn't give me any clue at all of what is dying at what point. This makes me completely dependent on sun and the other maintainers and they're all busy with 6.3 i hope. So that leaves me well in the woods.

I also have the feeling that my wysiwyg WNOD's are occurring because of lag, not necessarily just because of improper configuration or missing translation files. Is this at all possible? Maybe a routing conflict? I'm suggesting this because I noticed the drag handlers for my input format configuration sometimes reverting to numbered boxes. Did you notice that as well? (You may need the better_formats module installed: it's necessary for your input forward to be the top format, as well as having it be the default. Otherwise wnod is the only output I get.)

What about settings for caching? Can this be a factor?

...of je stopt de stekker erin.

Working now...

jeliasen - October 12, 2009 - 13:50

I've somehow gotten it working. I'm not sure what I did along the way, but at some point it got picked up and is functioning as expected. Thanks for all the suggestions!

Fckeditor - file browser don't appear

cpo - September 10, 2009 - 11:11

I've installed Wysiwyg and Fckeditor . I wish to download image from my PC to my host (use fonction : send to Fckeditor).
I click on img button, a window appears but I don't have the button to open the file browser (near field text URL).

Edit fckeditor.inc

nohup - October 16, 2009 - 08:00

1) Go to your modules directory and then go to wysiwyg/editors
2) Edit fckeditor.inc
3) Change
'ImageBrowser'=>FALSE,
'ImageUpload'=>FALSE

to

'ImageBrowser'=>TRUE,
'ImageUpload'=>TRUE

optional) You can also change the FlashBrowser and FlashUpload to TRUE to enable flash upload.

4) go to the /sites/all/libraries libraries/fckeditor/editor/filemanager/connectors/php
edit config.php

set $Config['Enabled'] to true ($Config['Enabled'] = true; )
set $Config['UserFilesPath'] to the path where you want the uploaded files to be stored ( $Config['UserFilesPath'] = '/sites/all/files/';)

In case it still does not come, set the cookie_domain in your settings.php

Thanks,
Rahul

If you own it, tone it.

No SUBMIT button on admin/settings/wysiwyg

jfinkel - September 23, 2009 - 04:16

I have followed the instructions and installed the Wysiwyg module and two editors (FCKeditor & WYMeditor). I want to use WYMEditor for Full HTML, so I go to admin/settings/wysiwyg and set it from the drop-down-list.

Sadly, there is no way to submit this request: there is no Submit button. The setting is never saved. Thanks in advance for all suggestions.

Note 1: I changed the Admin theme from Admin to Bluemarine, and the Save button now appears.

Note 2: After changing the administration theme back to (which uses the Admin module), the Save button now appears. So everything is now hunky-dory.

Integrating with TinyMCE with IMCE

maxelrod - October 4, 2009 - 20:10

When setting up WYSIWYG configured with TinyMCE, and you also want IMCE to work, then you also have to add the WYSYWIG IMCE Bridge module http://drupal.org/project/imce_wysiwyg

Even though this is hinted at on the WYSIWYG page and mentioned explicitly on the IMCE main page I thought I'd mention it again here. Why? because I completely missed this the first time I tried to set this all up and spent an hour wandering through misleading (older ) threads on the topic wondering why it wasn't all working.

Also the lesson is to carefully RTFM before jumping the gun and heading straight for Google :-p So after admitting it's my own fault for missing this detail I might say it also might be nice to clarify this tidbit of configuration knowledge just a bit more in the WYSYWIG documentation for the benefit of other bone headed developers like me.

By the way once you get it all working it works great! Thanks for some great modules.

Why ?

elgwiedo - October 13, 2009 - 08:35

Can't get an editor at work.

I have installed WYSIWYG. Found out I had to install a separate editor. Choose TinyMCE and installed inside the libraries folder.

However, when checking the report, Drupal is still telling me to install TinyMCE inside "modules", not libraries; ?

Could not find the TinyMCE engine installed at sites/all/modules/wysiwyg/tinymce/tinymce/. Please download TinyMCE, uncompress it and copy the folder into sites/all/modules/wysiwyg/tinymce.

 
 

Drupal is a registered trademark of Dries Buytaert.