The text plugin

The text plugin provides a standard WYSIWYG (“What You See is What You Get”) editor in the administration panel, to add HTML contents to the page.


It features:

  • Fully replaceable/customizable WYSIWYG editor.
  • Text pre- and post-processing hooks.
  • HTML sanitation/cleanup features.

The plugin is built on top of django-wysiwyg, making it possible to switch to any WYSIWYG editor of your choice. The default editor is the YUI editor, because it works out of the box. Other editors, like the CKEditor, Redactor and TinyMCE are supported with some additional configuration. See the django-wysiwyg documentation for details.


There is no reason to feel constrained to a specific editor. Firstly, the editor can be configured by configuring django-wysiwyg. Secondly, it’s possible to create a different text plugin yourself, and let this plugin serve as canonical example.


Install the dependencies via pip:

pip install django-fluent-contents[text]

This installs the django-wysiwyg package.

Add the following settings to



The following settings are available:

DJANGO_WYSIWYG_FLAVOR = "yui_advanced"

Also check the following settings in the global section:

Those settings allow post-processing of the HTML, sanitation and making the HTML well-formed. It can be used for example to fix typography, such as replacing regular quotes with curly quotes.


The DJANGO_WYSIWYG_FLAVOR setting defines which WYSIWYG editor will be used. As of django-wysiwyg 0.5.1, the following editors are available:

  • ckeditor - The CKEditor, formally known as FCKEditor.
  • redactor - The Redactor editor (requires a license).
  • tinymce - The TinyMCE editor, in simple mode.
  • tinymce_advanced - The TinyMCE editor with many more toolbar buttons.
  • yui - The YAHOO editor (the default)
  • yui_advanced - The YAHOO editor with more toolbar buttons.

Additional editors can be easily added, as the setting refers to a set of templates names:

  • django_wysiwyg/flavor/includes.html
  • django_wysiwyg/flavor/editor_instance.html

For more information, see the documentation of django-wysiwyg about extending django-wysiwyg.

TinyMCE integration example

The WYSIWYG editor can be configured to allow end-users to make minimal styling choices. The following configuration has proven to work nicely for most web sites, save it as django_wysiwyg/tinymce_advanced/includes.html in a Django template folder. This code has the following features:

  • django-filebrowser integration.
  • Unnecessary styling is removed.
  • Styling choices are limited to a single “format” box.
  • It reads /static/frontend/css/tinymce.css, allowing visual consistency between the editor and frontend web site.
  • It defines body_class so any .text CSS selectors that style this plugin output work as expected.
{% extends "django_wysiwyg/tinymce/includes.html" %}

<script>{# <- dummy element for editor formatting #}
{% block django_wysiwyg_editor_config %}
    var django_wysiwyg_editor_config = {
        plugins: 'paste,autoresize,inlinepopups',
        strict_loading_mode: true,  // for pre 3.4 releases

        // Behavioral settings
        document_base_url: '/',
        relative_urls: false,
        custom_undo_redo_levels: 10,
        width: '610px',

        // Toolbars and layout
        theme: "advanced",
        theme_advanced_toolbar_location: 'top',
        theme_advanced_toolbar_align: 'left',
        theme_advanced_buttons1: 'styleselect,removeformat,cleanup,|,link,unlink,|,bullist,numlist,|,undo,redo,|,outdent,indent,|,sub,sup,|,image,charmap,anchor,hr,|,code',
        theme_advanced_buttons2: '',
        theme_advanced_buttons3: '',
        theme_advanced_blockformats: 'h3,h4,p',
        theme_advanced_resizing : true,

        // Integrate custom styling
        content_css: "{{ STATIC_URL }}frontend/css/tinymce.css",
        body_class: 'text',

        // Define user configurable styles
        style_formats: [
            {title: "Header 2", block: "h2"},
            {title: "Header 3", block: "h3"},
            {title: "Header 4", block: "h4"},
            {title: "Paragraph", block: "p"},
            {title: "Quote", block: "blockquote"},
            {title: "Bold", inline: "strong"},
            {title: "Emphasis", inline: "em"},
            {title: "Strikethrough", inline: "s"},
            {title: "Highlight word", inline: "span", classes: "highlight"},
            {title: "Small footnote", inline: "small"}
            //{title: "Code example", block: "pre"},
            //{title: "Code keyword", inline: "code"}

        // Define how TinyMCE formats things
        formats: {
          underline: {inline: 'u', exact: true}
          //strikethrough: {inline: 'del'},
        //inline_styles: false,
        fix_list_elements: true,
        keep_styles: false,

        // Integrate filebrowser
        file_browser_callback: 'djangoFileBrowser'

    function djangoFileBrowser(field_name, url, type, win) {
        var url = "{% url 'filebrowser:fb_browse' %}?pop=2&type=" + type;
            'file': url,
            'width': 880,
            'height': 500,
            'resizable': "yes",
            'scrollbars': "yes",
            'inline': "no",
            'close_previous': "no"
            'window': win,
            'input': field_name,
            'editor_id': tinyMCE.selectedInstance.editorId
        return false;

{% endblock %}