NAME

Krang::ElementClass::PoorText - WYSIWYG element

SYNOPSIS

   $class = pkg('ElementClass::PoorText')->new(
        name          => "paragraph",
        type          => 'textarea',
        commands      => 'all_xinha',
        bulk_edit_tag => 'p',
   );

DESCRIPTION

This element provides a WYSIWYG text editor for HTML by integrating with the PoorText WYSIWYG element. It is based on Krang::ElementClass::_PoorTextBase.

INTERFACE

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

• type
  
May be 'text' or 'textarea' to mimic the two flavors of legacy text input and textarea fields.
• width
  
The width of the edit area. Defaults to 400px.
• height
  
The height of the edit area. For type 'textarea' defaults to 120px. For type 'text' this option takes no effect.
• commands
  
This can be either a string denoting a pre-cooked set of WYSIWYG commands or an array or command names. The pre-cooked sets are:

   basic                    => [ qw(bold     italic      underline
                                    cut      copy        paste
                                    add_html delete_html add_story_link
                                    redo     undo
                                    help     toggle_selectall)
                               ],
   basic_with_special_chars => [ qw(bold         italic      underline
                                    cut          copy        paste
                                    add_html     delete_html add_story_link
                                    redo         undo
                                    specialchars help        toggle_selectall)
                               ],
   all_xinha                => [ qw(bold          italic       underline
                                    strikethrough subscript    superscript
                                    cut           copy         paste
                                    add_html      delete_html  add_story_link
                                    redo          undo
                                    specialchars  help         toggle_selectall)
                               ],
   all                      => [ qw(bold          italic       underline
                                    strikethrough subscript    superscript
                                    cut           copy         paste
                                    align_left    align_center align_right justify
                                    indent        outdent
                                    add_html      delete_html  add_story_link
                                    redo          undo
                                    specialchars  help         toggle_selectall) ],

Most of these commands should be self-evident. Some, however, are not:

Note the difference between all_xinha and all. The former includes all commands supported when integrating PoorText with Xinha-based bulk editing, excluding the align and indent/outdent commands which are part of all.

• add_html
  
This command opens a popup allowing to wrap the selected text with a A, ABBR or ACRONYM tag.
• delete_html
  
Deletes an A, ABBR or ACRONYM around the current selection.
• add_story_link
  
This command hooks Krang's StoryLink selection into PoorText fields. The hard find feature known from Krang::ElementClass::StoryLink is also supported.
• specialchars
  
This command displays a second toolbar allowing to insert double and single curly quotes as well as the ndash.
• toggle_selectall
  
This command is only accessible via the keyboard using the default shortcut Ctrl-a. PoorText implements this command as a toggle. When deselecting, the original position of the cursor or the original selection is restituted.

• command_button_bar
  
This boolean determines whether a button bar with the configured commands will be displayed when the edit area receives focus. (You might want to just use the shortcuts. Which ones? Press Ctrl-h). The default is true.
• special_char_bar
  
If true, the specialchar button bar will be displayed when the edit area receives focus. In this case, even if the command button bar is configured to contain the specialchars command (the omega sign), this command will not be present. Defaults to false.
• shortcut_for
  
This hashref maps commands and specialchars to shortcuts. The default is:

    bold              => 'ctrl_b',
    italic            => 'ctrl_i',
    underline         => 'ctrl_u',
    subscript         => 'ctrl_d',
    superscript       => 'ctrl_s',
    strikethrough     => 'ctrl_t',
    toggle_selectall  => 'ctrl_a',
    add_html          => 'ctrl_l',
    delete_html       => 'ctrl_shift_l',
    add_story_link    => 'ctrl_shift_s',
    redo              => 'ctrl_y',
    undo              => 'ctrl_z',
    help              => 'ctrl_h',
    cut               => 'ctrl_x',
    copy              => 'ctrl_c',
    paste             => 'ctrl_v',
    specialchars      => 'ctrl_6',
    align_left        => 'ctrl_q',
    align_center      => 'ctrl_e',
    align_right       => 'ctrl_r',
    justify           => 'ctrl_w',
    indent            => 'tab',
    outdent           => 'shift_tab',
    lsquo             => 'ctrl_4',
    rsquo             => 'ctrl_5',
    ldquo             => 'ctrl_2',
    rdquo             => 'ctrl_3',
    ndash             => 'ctrl_0',

(See htdocs/poortext/src/poortext_core.js for more information)

• indent_size
  
If the commands 'indent' and 'outdent' are configured, this option specifies the number of pixels to indent and outdent. Defaults to 20.
• find
  
The find parameter works the way known from Krang::ElementClass::StoryLink.

Integrating PoorText with Xinha-based bulk editing

As a PoorText field may contain HTML inline-level tags only, the set of values allowed for the option bulk_edit_tag is limited to:

  p, h1, h2, h3, h4, h5, h6, address, pre

(Un)ordered lists and tables are not allowed. For (un)ordered lists see Krang::ElementClass::PoorTextList.

SEE ALSO

The base class Krang::ElementClass::_PoorTextBase and the PoorText source in htdocs/poortext/src/.