djangocms-stories

django CMS stories application - Tell your story in multilingual posts, using the full power of django CMS placeholders.

djangocms-stories provides a lean foundation for storytelling that can be composed with other specialized django CMS applications, such as djangocms-versioning or djangocms-moderation.

Features

• Frontend editing using django CMS frontend editor
• Placeholder or optionally simpler TextField-based content editing
• Multilingual support using django-parler
• Multisite (posts can be visible in one or more Django sites on the same project)
• Hooks into your page tree anywhere
• Configurable permalinks, user navigation, template sets, ...
• Multiple instaces per site (e.g., blog, news, stories)
• Django sitemap framework
• django CMS Wizard integration
• Supports djangocms-versioning and djangocms-moderation

Installation

To install the latest version directly from GitHub, run:

pip install djangocms-stories

Add djangocms_stories to your INSTALLED_APPS in your Django project's settings.py:

INSTALLED_APPS = [
    # ...
    'djangocms_stories',
    'parler',  # if not already included
    'sortedm2m',  # if not already included

    # For now, but probably not needed in the future
    'taggit',
    'taggit_autosuggest',
    'meta',
    # ...
]

To use taggit's autosuggest feature, add their URLS in urls.py:

urlpatterns += [path('taggit_autosuggest/', include('taggit_autosuggest.urls'))]

Migrating from djangocms-blog

Migrate from djangocms-blog by following the steps below. There is test coverage for the migration process - nevertheless be sure to backup your database before proceeding.

1. Uninstall djangocsms-blog: pip uninstall djangocms-blog
2. Install djangocms-stories pip install djangocms-stories
3. Add "djangocms_stories" to your installed apps. Do not remove djangocms-blog.
4. Run ./manage.py migrate djangocms_stories. This in migration 0002 will move existing content from djangocms-blog to djangocms-stories and delete djangocms-blogs database tables.
5. Remove "djangocms_blog" from your installed apps.
6. To be on the safe side, check that the app hooks in the advanced settings your blog pages have been updated.

Custom templates will need manual updating, since the underlying model structure has changed:

• post contains the following fields: related, main_image, author, date, categories, tags
• post_content contiains the following per-language fields: title, subtitle, slug, content, media, and post, the reference to the Post object.

Some improvements for developers are included:

• You now can use the {% placeholder %} template tag in the post_detail.html template to render any placeholder. {% render_placeholder post_content.content %} and {% render_placeholder post_content.media %} are still available, but you can now use {% placeholder "new_content" %} to, say, add additional placeholders.

Contributing

Because this is a an open-source project, we welcome everyone to get involved in the project and receive a reward for their contribution. Become part of a fantastic community and help us make django CMS the best CMS in the world.

We'll be delighted to receive your feedback in the form of issues and pull requests. Before submitting your pull request, please review our contribution guidelines.

The project makes use of git pre-commit hooks to maintain code quality. Please follow the installation steps to get pre-commit setup in your development environment.

We're grateful to all contributors who have helped create and maintain this package. Contributors are listed at the contributors section.

One of the easiest contributions you can make is helping to translate this addon on Transifex.

Credits

djangocms-stories is inspired by Nephila's excellent djangocms-blog, with the intent to bring to align it with django CMS's new philosophy since version 4: "The design philosophy of django CMS is to solve something complex with many simple things."