Dashboard > Hippo CMS > ... > 03. Developing templates > Rich text editor
Rich text editor
Added by Jeroen Reijn, last edited by Dennis Dam on Jun 22, 2007  (view change)
Labels: 


Since version 6.03.00 Hippo CMS is using Xinha as the default rich-text editor. We migrated to Xinha because the development of HTMLArea stopped some time ago.

Xinha brings us a more stable editor with nice features and plugins. For more details about Xinha see the project homepage.

CAUTION for users migrating from version 6.03 to 6.04:
In your HTMLArea's initialization function, instead of generating the htmlarea like

editor.generate();

Simply return the editor object as the initialization function's result:

return editor;

Custom Hippo CMS plugins

For some Hippo CMS related features we implemented some custom plugins.

Name Description Load Register
AdvancedTableOperations This plugin allows you to create tableheaders within your tables. Yes Yes
AdvancedContextMenu This plugin is allmost the same as the ContextMenu, but it's using the AdvancedTableOperations instead of the TableOperations plugin. Yes Yes
Expander This plugin will expand the editable area while typing. Then you won't have to scroll withing the editable page. Yes Yes
InsertDoclink With this plugin you are able to create links to binaries that are located inside Hippo CMS. Yes Yes
InsertImage This function overrides the default image functionality in Xinha. It adds a browse button for selecting images that are stored inside Hippo CMS.It also adds the with and height attribute to an image. Yes No
InsertLink This function overrides the default link functionality in Xinha. It adds a browse button to browse for other documents inside the HIppo CMS. Yes No
SpellChecker This plugin trigger a serverside spellchecking program.It's modified to use a java component. Yes Yes

You can read more information about the other plugins provided by Xinha on their website.

Loading plugins

In your htmlarea.js, add two commands to load the plugin. Check the above table for the "Load" and "Register" columns. When "Load" is needed, add the following statement in the top:

HTMLArea.loadPlugin("PluginName");

When "Register" is needed, add the following statement in the bottom:

editor.registerPlugin("PluginName");

Where PluginName is the name in the table above.

Where to find htmlarea.js

You can find a default / example version of htmlarea.js in the CMS at /editor/src/site/editing/cf2/resources/js/htmlarea.js. You can use this file as a basis to create your custom htmlarea configurations. See the documentation on how to use the htmlfield element.

Spellchecker plugin

Hippo CMS is using a modified version of the Spellchecker plugin so you wont have to install PHP for the spellchecker to work.

For the spellchecker plugin to work you will need to specifiy the cms.aspell.location property in the project.properties file while building. Hippo CMS requires you to have aspell version 0.50.5 or higher.

If the spellchecker plugin does not work you can read more information about it on the Xinha Wiki.

Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.5.7 Build:#813 Aug 28, 2007) - Bug/feature request - Contact Administrators