13_Wysiwyg_Editor.md

Wysiwyg Editor Configuration

The Toolbox Bundle allows you to override and specify the wysiwyg configuration. There are several reasons for that:

• Keep the editor simple, remove unwanted dangerous elements from the wysiwyg
• Define custom styles via configuration
• Use the same editor layout in every wysiwyg element (Document, Emails, Objects)

Currently, only TinyMce Editor is supported!

TinyMce Toolbar

The Toolbox Bundle already removes some (mostly dangerous) elements. Feel free to modify them according to your needs. Checkout the available toolbar buttons to do that.

Info: This is the global configuration for the TinyMCE-Editor Toolbar. If you need to provide a different configuration in objects or areas, use the object/area configuration (see below)

Overriding Configuration

Example

toolbox:
    wysiwyg_editor:
        config:
            block_formats: 'Paragraph=p; Header 1=h1; Header 2=h2; Header 3=h3'
            style_formats:
                -
                    title : 'Example'
                    inline : 'span'
                    classes : 'example'
                    selector: 'a'
            toolbar2: 'blocks | styles'

Important

If your extending style formats, you also have to extend the html sanitize otherwise you're applied data will be removed after persisting!

Area Editor Configuration

If you only need to modify the toolbar configuration for document areas, add this to your configuration:

Example

toolbox:
    wysiwyg_editor:
        area_editor:
            config:
                # his will change the toolbar2 only for document editables editors
                toolbar2: 'blocks'

Object Editor Configuration

If you only need to modify the toolbar configuration for objects, add this to your configuration:

Note

The object configuration does not respect different toolbox context environments at the moment. Objects are not restricted to any sites by nature which makes any context-binding quite impossible.

Example

toolbox:
    wysiwyg_editor:
        object_editor:
            config:
                # this will change the toolbar2 only for object editors
                toolbar2: 'blocks'

TinyMce Editor Plugins

Toolbox provides some additional Editor Plugins:

Google Opt Out

Add a link to allow user to disable google analytics tracking. There is also a frontend Javascript Plugin.

Enable Button

toolbox:
    wysiwyg_editor:
        config:
            toolbar2: 'tb_goo_link_button'