Community news | December 13, 2024

Deprecation Announcement: djangocms-text-ckeditor to be Replaced by djangocms-text in Q1 2025

The Django CMS team is announcing the deprecation of the widely used djangocms-text-ckeditor package. After Q1 2025, this package will no longer receive updates, and its support will officially end. In its place, we are introducing djangocms-text, a modern, more powerful, next-generation successor designed to enhance your content editing experience while ensuring long-term sustainability.

5 minutes read

Why the Change?

djangocms-text-ckeditor has been a reliable rich text editing solution for many years. However, as web standards and user expectations evolve, so too must our tools. djangocms-text addresses several limitations of its predecessor while introducing significant improvements that align with modern development practices and content workflows.

Key reasons for the transition include:

  1. End of Life for CKEditor 4: CKEditor 4, the backbone of djangocms-text-ckeditor, has reached its end of life, necessitating a shift to newer technologies.
  2. New Default Editor (Tiptap): djangocms-text introduces Tiptap as the new default editor, offering the ability to manage rich text as both HTML and structured JSON objects for improved flexibility.
  3. Rich Text Editor Options: djangocms-text supports multiple rich text editors, including CKEditor 4 (from djangocms-text-ckeditor) and CKEditor 5 (currently with limited functionality), providing developers with more choices.
  4. Dynamic HTML: djangocms-text allows adding dynamic links without using a separate plugin and inside rich text fields. It integrates seamlessly with djangocms-link 5.
  5. Improved inline-editing capabilities: djangocms-text supports inline editing for text and rich text fields for all frontend-editable models.
  6. Modern HTML validation: djangocms-text uses nh3/ammonia for faster and more secure HTML sanitation.

Transition Plan

We understand that many projects rely on djangocms-text-ckeditor, and we aim to make the transition as smooth as possible. Here is an outline of the deprecation timeline:

  • Now: The next-gen editor djangocms-text is already available for testing and integration. Developers are encouraged to explore its features and provide feedback.
  • Jan. 2025: A migration guide will be published, detailing steps to transition from djangocms-text-ckeditor to djangocms-text. A migration without changing the editor frontend using CKEditor 4 will be supported.
  • End of Q1 2025: Official deprecation of djangocms-text-ckeditor. No further updates or support will be provided.

How to Prepare

To ensure a smooth transition, we recommend:

  1. Evaluate djangocms-text Early: Test djangocms-text in a staging environment to familiarize yourself with its new features and identify any potential migration challenges.
  2. Stay Updated: Follow our official communication channels for updates, including the release of the migration guide and related resources.
  3. Plan Ahead: Incorporate the transition into your project timelines to avoid last-minute disruptions.

Join the Conversation

Your feedback is invaluable to us. Join the discussion on GitHub to share your thoughts, report issues, or ask questions about the transition. Your input will help us refine djangocms-text and ensure it meets the needs of the community.

Conclusion

The deprecation of djangocms-text-ckeditor marks a significant step forward for Django CMS. While it requires a change, we believe that djangocms-text is the next generation: it comes with awesome new features and will provide a more robust and enjoyable content editing experience. Thank you for your continued support and collaboration as we embark on this exciting new chapter.

Stay tuned for more updates and resources to guide you through the transition. Let’s build the future of Django CMS together!

Release

django CMS 5.1 is here: easier setup, flexible deployments, and a fresh editing experience

This release reduces friction across the whole project lifecycle: creating a new project, adding django CMS to an existing Django application, configuring larger deployments, controlling which plugins editors can use, and working with the CMS every day.

Release

django CMS 5.0.9 released: security, accessibility, and stability improvements

This release addresses three medium-severity security vulnerabilities and includes improvements to accessibility, Django compatibility, permissions, Content Security Policy support, and general editor stability.

Case Studies

How we built our professional services digital platform using django CMS

Compound Partners is a UK digital consultancy specialising in audience-centric user experience and content architecture for professional services firms. Fifteen years ago, a developer's recommendation pointed us at django CMS. Today, our entire business is built on it.