NAME

Krang::ElementClass::XinhaEditor - WYSIWYG HTML editor

SYNOPSIS

   $class = Krang::ElementClass::XinhaEditor->new(
                                       name => "body",
                                       rows => 20,
                                       cols => 30,
                                       toolbar_config => 'standard'
                                      );

DESCRIPTION

This element provides a WYSIWYG text editor for HTML by integrating with the Xinha JavaScript text editor.

INTERFACE

All the normal Krang::ElementClass attributes are available, plus:

• rows
  
The number of rows in the editor box. Defaults to 4.
• cols
  
The number of columns in the editor box. Defaults to 40.
• toolbar_config
  
This is a string corresponding to one of the preset configurations for the editor toolbar. The current options are 'standard', for a typical configuration with the Krang-unfriendly buttons removed, 'minimal', for a sparse toolbar with just the basics, and 'all' for a toolbar with the works. For the exact details about which buttons are included in each, see the source code for this module.

The default is 'minimal'.

• toolbar_config_string
  
Alternate configuration mechanism for the toolbar. This allows a string to be passed in with a configuration which will be passed directly to the JavaScript configuration. You must read and understand the htmlArea documentation in order to use this. A sample config string would look like this:

     [
       "fontsize", "space",
       "bold", "italic", "underline", "separator",
       "copy", "cut", "paste", "space", "undo", "redo", 
       "linebreak",
       "insertorderedlist", "outdent", "indent", "separator",
       "textindicator", "separator",
       "createlink",
     ]

Note that this a string, *not* a perl data structure!

SEE ALSO

Xinha is available from http://xinha.python-hosting.com/. The source code and license for the editor are included in the htdocs/xinha/ directory of this Krang distribution.