I created very clear - and most importantly working with no problem - installation instructions after struggling a bit like so many other people complained here.

The two problems/questions most people stumbled upon install are:

1) Neither the text on the modules main page at Drupal.org, nor the instructions in the module gz-file clearly state that you have to install both the Drupal package and the platform-independent one from moxiecode.com

2) It is completely unclear that your have to install first the Drupal package and after that install the platform-independent one in the second tinymce directory

The instructions - on my consultancy site:
http://www.incredium.com/tinymce-drupal-install

Enjoy!

Comments

kreynen’s picture

kreynen commented
Status: Active » Closed (fixed)

From http://drupal.org/project/tinymce...

"Installing the TinyMCE module is a TWO STEP PROCESS. Users must download and copy the TinyMCE folder into the module directory as part of the installation process."

From the INSTALL.txt included with the module...

"Place the entire 'tinymce' engine folder inside your modules/tinymce directory. So the TinyMCE engine will live in modules/tinymce/tinymce"

I'm not sure how we could make this any more clear. Failing to read the instructions doesn't mean the instructions aren't there.

kvguser’s picture

kvguser commented

All with good intent, but you are still very unclear. Let me show you step by step how you do create the confusion:

How about instead of this very confusing text

INSTALLATION: Installing the TinyMCE module is a TWO STEP PROCESS. Users must download and copy the TinyMCE folder into the module directory as part of the installation process. This module only enables the TinyMCE editor to be used with Drupal. The TinyMCE editor itself is maintained by Moxiecode Systems AB and is used by many content management systems. A browser compatibility chart is available at the TinyMCE website.

you put his one:

INSTALLATION: Installing the TinyMCE module editor for Drupal is a TWO STEP PROCESS. After installing the TinyMCE Drupal module, users must download the actual TinyMCE editor as well and copy its TinyMCE folder into the already existing modules/tinymce directory as part of the installation process.
NOTE: This module only enables the TinyMCE editor to be used with Drupal. The TinyMCE editor itself is maintained by Moxiecode Systems AB and is used by many content management systems. A browser compatibility chart is available at the TinyMCE website.

The critical thing is to have jscripts directory (part of the actual TinyMCE editor) to reside in modules/tinymce/tinymce. Otherwise the TinyMCE doesn't show up and you get JavaScript error - because the module cannot find the javascripts, part of the editor.

Did you actually notice as well that you do not need to have tinymce-engine (file tinymce.module) to reside in ../modules/tinymce/tinymce - in the second tinymce directory???

I have it working with engine here: ../modules/tinymce/tinymce.module

As I show in the article on my site (link in my original first posting), my directory structure is as follows:

../public_html/sites/all/modules/tinymce/plugins/......

../public_html/sites/all/modules/tinymce/po/.......

../public_html/sites/all/modules/tinymce/tinymce.info

../public_html/sites/all/modules/tinymce/tinymce.install

../public_html/sites/all/modules/tinymce/tinymce.module

../public_html/sites/all/modules/tinymce/tinymce/

../public_html/sites/all/modules/tinymce/tinymce/docs/.....

../public_html/sites/all/modules/tinymce/tinymce/examples/....

../public_html/sites/all/modules/tinymce/tinymce/jscripts/.....

../public_html/sites/all/modules/tinymce/tinymce/readme 

kreynen’s picture

kreynen commented
Priority: Critical » Minor
Status: Closed (fixed) » Postponed

I am open to feedback about TinyMCE's documentation and invite anyone who'd like to have their voice heard about the development of TinyMCE to join the TinyMCE Development group. This is not just for developers, but anyone who has the time to improve the TinyMCE FAQ, test new dev versions of TinyMCE, and help clear the issue queue and forum of basic support issues.

What I'm not open to is someone making what I consider to be a minor improvement to the install instructions, describing those as "PERFECT", posting those instructions on a site advertising their consulting services, and then pointing users to that site like kvguser is doing here.

kvguser is new to Drupal (12 weeks) so I'm going to assume he/she is just trying to find a way to contribute, but this is NOT the way to go about it. Writing good documentation is important and time consuming, but write the documentation as a patch if it's intended to change the INSTALL.txt or as a handbook.

IMHO, posts that do little more than offer redirects to sites offering consulting services are dangerously close to spam. Content should be posted to drupal.org as issues, handbooks, or wiki pages on groups.drupal.org whenever possible. Otherwise we end up with situations like www.drupalecommerce.com with hundreds of links to a site that has been replaced by parked domain spam.

kvguser’s picture

kvguser commented

I don't consider my suggestions to the installation instructions "minor" at all.

There is a cler *fact* supporting this: so many support requests talking about not being able to see TinyMCE appear after installing it. Anyone who decides to go over them - count them, read them - will find the same. I can go term by term to explain where is the logic broken in expressing the instructions just to show how another one perceives them - if someone is interested in such exercise.

By saying this I don't at all try to undermine the effort and the goodwill of the Drupal's TinyMCE module author(s). On the contrary - they have done the most difficult part, programming the module.

The problem with the instructions is minor to that effort, but not minor for the phase of using the module. It is very well known and wide spread pitfall that even very talented software developers - because they are so familiar with their thing - cannot express themselves very clear for the ones less knowing.

So I am just trying to help here by writing instructions that would be understood by way wider crowd - let's not forget, not only developers use Drupal.

I have no problem removing (if I could) the word "perfect" from my title.

But please don't tell me how to contribute to the open source community - I have done it a lot, not necessarily for Drupal. As every one can see, I haven't offered my TinyMCE instructions improvements for pay - I have offered them for free. Contributing to open source doesn't mean one cannot advertise their professional expertise for other, custom-requested problem solving.

There is no "copyright" message on my site's page with the instructions - everyone can copy and use them.

vm’s picture

vm commented
Title: PERFECT instructions how to install - for all who suffered :-) » Improved TinyMCE installation instructions - work in progress

Issues titles can be changed. As I've just done.

kreynen’s picture

kreynen commented

I understand the "cler" fact of users who have issues with a two step install and have tried to address that a different way by distribunting a version of TinyMCE with Moxiecode's code included in the package, but Drupal's CVS maintainers don't want the additional code in Drupal's CVS regardless of getting permission from Moxiecode to include their LGPL in a Drupal package licensed as GPL.

I've invested a lot of time in trying to solve the two step install issue.

Sending me a transcript of your open source contributions is not going to change my opinion about linking to instructions on a site advertising consulting services. Maybe if you had already made substantial contribution to Drupal like Bryght, Lulabot, or Development Seed, I wouldn't care... but that's not what's happening here.

If you want to link users to those instructions, put them in a handbook page.

MisterV’s picture

MisterV commented

I think the big issue is not that you've advertised your website, but that you've made the instructions exclusively available on said website rather than posting a copy here. A much better way (imho) would have been to say post "The original copy of these instructions can be found at [link]. [instructions follow]."

Still, beats not contributing at all

sun’s picture

sun
Primary language German
Location Karlsruhe
commented
Title: Improved TinyMCE installation instructions - work in progress » TinyMCE installation instructions
Category: feature » task
Priority: Minor » Normal

I was also confused by the project description and installation instructions in the text files. Actually, the queue is full of unresolved bugs and support issues, some may or may not be related to wrong installation steps done by users of TinyMCE. If any user comes up with any improvements for documentation, those should be treated with love and care.

Compare it with the Drupal developer docs: every module maintainer is able to commit documentation improvements to them, immediately. Unfortunately, this is impossible with contrib modules. As a module maintainer, I can't believe the status of this issue is really 'postponed'.

Furthermore, I have read the improved installation instructions and all replies kvguser ever did in the issue queues (including closed issues). I can't follow your judgement, kreynen. He wrote these instructions, published them, tried to help out in the queue and all he receives is his reputation bashed? Poor kvguser...

With due respect, that doesn't give you much maintainer points.

kreynen’s picture

kreynen commented

Sun,

Sometimes life gets in the way of maintaining a module.

As today is my last day at a job I've quit, I'll have more time to work on TinyMCE issues... but it's not as easy as rewriting documentation.

It's good to know you'll be volunteering your time. I look forward to accepting your request to join the TinyMCE development group.

mupsi’s picture

mupsi
she/her
commented
Issue summary: View changes
Status: Postponed » Closed (outdated)