Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

django3-flatpages-tinymce

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

django3-flatpages-tinymce

HTML editor on django.contrib.flatpages

  • 0.2.2
  • PyPI
  • Socket score

Maintainers
1

About

django3-flatpages-tinymce provides on-site editing of "Flat Pages" with minimal impact on the rest of code. This is a fork of the original, dropping support for python 2 and django < 3.0.

django3-flatpages-tinymce is available under the MIT license.

Usage

First of all, you need to have django3-flatpages-tinymce and django-tinymce installed; for your convenience, recent versions should be available from PyPI.

pip install django-tinymce django3-flatpages-tinymce

To use, just add these applications to your INSTALLED_APPS after django.contrib.flatpages app:

INSTALLED_APPS = (
    ...
        'django.contrib.staticfiles',
        'django.contrib.flatpages',
        ...
        'tinymce',
        'flatpages_tinymce',
)

As instructed by the flatpages guide, add this to your MIDDLEWARE_CLASSES:

MIDDLEWARE_CLASSES = (
    ...
    'django.contrib.flatpages.middleware.FlatpageFallbackMiddleware',
)

Remember that this little addition to your urls.py is required by django-tinymce:

urlpatterns = patterns('',
    ...
    path('tinymce/', include('tinymce.urls')),
    ...
)

Finally create the tables for flatpages and install the JS/CSS files using

./manage.py nugrate
./manage.py collectstatic

If you want on-site editing of templates, you must edit flatpages templates: change {{flatpage.content} to {% flatpage_admin flatpage %} from flatpage_admin template library. So

{% extends "base.html" %}
{% block body %}
{% endblock %}
{% block body %}
<h1>{{flatpage.title}}</h1>
{{flatpage.content}}
{% endblock %}

will become

{% extends "base.html" %}
{% load flatpage_admin %}
{% block body %}
<h1>{{flatpage.title}}</h1>
{% flatpage_admin flatpage %]
{% endblock %}

If you are bothered with <script>/<link> tags, being inserted in <body> tag and your template has something like {% block extrahead %}, you can move all plugin media in head, using {% flatpage_media %} tag.

{% extends "base.html" %}
{% block extrahead %}
{% flatpage_media %}
{% endblock %}
{% block body %}
<h1>{{flatpage.title}}</h1>
{% flatpage_admin flatpage %}
{% endblock %}

Settings

Default settings are in flatpages_tinymce.settings.py file. Also, you can override them in site-wide settings.py file. The main of them are:

  • FLATPAGES_TINYMCE_ADMIN (default True) - use TinyMCE widget in admin area
  • FLATPAGES_TINYMCE_FRONTEND (default True) - use TinyMCE widget in frontend
  • FLATPAGES_TEMPLATE_DIR (default: TEMPLATE_DIRS[0] + 'flatpages') - directory where flatpages templates are placed
  • FLATPAGES USE_MINIFIED (defalut: not settings.DEBUG) - use minified versions of JS/CSS

Further, you will want to change default settings of TinyMCE Editor.

TINYMCE_DEFAULT_CONFIG = {
   # custom plugins
       'plugins': "table,spellchecker,paste,searchreplace",
   # editor theme
   'theme': "advanced",
   # custom CSS file for styling editor area
       'content_css': MEDIA_URL + "css/custom_tinymce.css",
       # use absolute urls when inserting links/images
       'relative_urls': False,
   }

Changes

Changes in version 0.2

  • Ported to support Django > 3 and Python 3
  • drop support for Russian

Changes in version 0.1

  • First public release.

Keywords

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc