DRUPAL integration manual for the Sferyx JSyndrome HTML Editor Applet Edition


Sakai project logo

1. Can the Sferyx HTML Editor Applet Edition and the Sferyx Equation Editor be integrated into the entire DRUPAL system?

The integration package SferyxForDrupal - allows instant integration of the Sferyx JSyndrome HTMLEditor Applet with the Drupal system without requiring even a single line of code on your side. The integration is done through the Drupal's wysiwygAPI module so this module should be installed on your system. Please follow the steps described below in the integration section.

When using the special Sferyx JSyndrome HTMLEditor Applet+EquationEditor bundle which integrates seamlessly with the system and is delivered out of the box both advanced HTML and Equation editing capabilities for the entire DRUPAL system. We have also provided the new Flow toolbar layout especially to be able to accommodate the editor into all small form spaces inside the DRUPAL modules.

The installation is very simple and does not require even a single line of code on your side and consists of simply installing the Sferyx wysiwygAPI module as described here below:

2. How can I integrate the editor into the DRUPAL system?

The installation is very simple and does not require even a single line of code on your side and consists of simply installing the module. Follow the steps bellow:

1)  NOTE:  this latest package has been tested with the Drupal build 6.11 so if you want to be sure it is working out of the box you may want to use the same build. However it could be working also with previous releases, there are no specific limitations.

2) Once installed wysiwygAPI simply unzip or copy the files here in attachment to the following folder:

/drupal/modules/wysiwyg/

After done this, the sferyx file structure should be the following:

/drupal/modules/wysiwyg/editors/sferyx.inc
/drupal/modules/wysiwyg/editors/js/sferyx.js
/drupal/modules/wysiwyg/sferyx/HTMLEditorAppletPro.jar
/drupal/modules/wysiwyg/sferyx/sferyx_loader.js
/drupal/modules/wysiwyg/sferyx/sferyx_upload.php
/drupal/modules/wysiwyg/sferyx/sferyx_browse.php

That's all - now you can go to the Administration panel of the Drupal system and enable the Sferyx editor from the editor's list.

Drupal --> Administer -->  Site configuration -->  Wysiwyg --> Follow the install wizard.

This will enable the Sferyx Editor within all Drupal's modules and will be ready for use. See screenshots below for major details.

 

3. How to configure the file uploads for the Sferyx JSyndrome HTML Editor Applet Edition within the DRUPAL system?

Note on the file uploads and the file browsing:

There is only one note to observe - everything will be working as expected including the file uploads from inside the editor- the only limitation currently is that the original Drupal upload module accepts only one file at a time since this is the capability of the FCKEditor itself and the Drupal's upload form, while the Sferyx HTMLEditor Applet does not have limitations on the number of the uploaded files and can upload anything, simply currently only one file will be written down by the upload/js, although all of them are actually received by the server. This can be easily changed by simply modifying the upload module to accept multiple files and it is ready.

For this reason we have provided two simple scripts which do multiple file uploads and allow instant browsing of the uploaded files from within the editor. Those two files are

 /drupal/modules/wysiwyg/sferyx/sferyx_upload.php
/drupal/modules/wysiwyg/sferyx/sferyx_browse.php


Currently they use the standard upload folder setting "/sites/default/files" so you may need to change this path directly inside those scripts in order to make them work properly. You can also change the scripts and adapt them for your needs as you wish.
 

4. What advantages could bring the integration of the Sferyx HTMLEditor Applet, Equation Editor and PDFExport into the DRUPAL system?

In first place this way out of the box there are delivered both advanced HTML and Equation editing capabilities for the entire system combined with instant PDF generation capability. Furthermore, the Sferyx HTMLEditor is capable of publishing many files simultaneously which is very useful when for example is pasted a Word document which contains many images and other external linked files. This way only by submitting the form everything is sent to the server and the entire document is published within seconds without the need the user uploads all files separately, renaming them and linking them back to the document. All this is done automatically by Sferyx, also it is capable of generating unique image filenames in order to avoid name collisions. This saves a lot of work both for the users and the developers and gets the work done within seconds and if you add to the whole this thing also the PDFExport it can generate on-the-fly PDF files from the documents and publish them together with the HTML to the server.
 

 

Sferyx HTML Editor Applet Edition + Equation Editor running inside a DRUPAL instance:

 

Sferyx HTML Editor Applet Edition + Equation Editor running inside a DRUPAL instance:

 

DRUPAL's Administration screen when installing the Sferyx HTML Editor Applet Edition:

Our Services and assistance

All Sferyx products are assured with continuous e-mail support. With the retail products is included in the price 30 days startup support. Additionally, you can purchase annual support subscription tickets from our web store.

Sferyx offers also a wide range of customization services for its products in order to satisfy any customer requirement. We can adapt our products to fit the customer needs and any kind of integration requirements. We execute also express developments, customization under request, development of new features on demand. You can request a quote at sales@sferyx.com or support@sferyx.com indicating your requirements and the terms of delivery.